Consultar extrato da conta

POST

/api/ContaDigital/ExtratoContaDigital

ContaDigital

Funcionalidade principal

O endpoint ExtratoContaDigital recupera a lista cronológica de transações financeiras realizadas na conta do cliente. Ele consolida diferentes tipos de operações — como Pix, TED, pagamentos de boletos e depósitos — apresentando o impacto de cada uma no saldo final.

Casos de uso comuns

Consulta de movimentações: O usuário acessa o extrato para conferir se um pagamento foi processado ou se um depósito via boleto (endpoint /Deposito) caiu na conta.

Conciliação mensal: Exportação ou visualização de dados para controle de gastos pessoais ou contabilidade empresarial.

Verificação de tarifas: Identificação de débitos de serviços ou taxas administrativas aplicadas à conta.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/ContaDigital/ExtratoContaDigital' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "DataInicial": "2019-08-24T14:15:22.123Z",
        "DataFinal": "2019-08-24T14:15:22.123Z",
        "QuantidadeLinhasRetorno": 0,
        "OffsetRetorno": 0,
        "IdCartao": 0
    }
}'

Response Example

{
    "Data": {
        "DataInicial": "string",
        "DataFinal": "string",
        "ValorTotalDebito": 0,
        "ValorTotalCredito": 0,
        "Saldo": 0,
        "TotalAgendado": 0,
        "ListaTransacoes": [
            {
                "IdOrigem": "string",
                "DataTransacao": "string",
                "Descricao": "string",
                "TipoTransacao": "string",
                "Valor": 0,
                "OrigemTransacao": "string",
                "IdLpf": 0,
                "IdComprovante": 0,
                "InformacaoAdicional": {
                    "property1": {},
                    "property2": {}
                }
            }
        ],
        "HasMoreElements": true
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:03:49

Página anterior

Consultar saldo disponível na conta

Próxima página

Consultar comprovante detalhado de transação

Consultar extrato da conta

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns