Obter dados consolidados do extrato do cliente.

POST

/accounts/consolidated-statement

Accounts

Este endpoint recupera dados consolidados de extrato com base no intervalo de datas e nos critérios de agrupamento especificados.
Validações incluem:

O período máximo permitido é de 12 meses quando agrupado por MONTH.

O período máximo permitido é de 60 dias quando agrupado por DAY.

O mês final não pode ser posterior ao mês atual quando agrupado por MONTH.

A data final deve ser anterior à data atual quando agrupado por DAY.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

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

Exemplo:

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

Token URL: /oauth/token

Scopes:

account.read-Access to account infos

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Resposta bem-sucedida com dados consolidados do extrato.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠429

🔴500

🔴503

🔴504

Request Example

Shell

JavaScript

Java

Swift

cURL

Exemplo com agrupamento por DAYExemplo com agrupamento por MONTH

curl --location '/accounts/consolidated-statement' \
--header 'Content-Type: application/json' \
--data '{
    "groupBy": "DAY",
    "initialDate": "2025-05-01",
    "finalDate": "2025-05-03"
}'

Response Example

200 - Exemplo de resposta para agrupamento por MONTH

{
    "data": [
        {
            "periodDate": "2025-01",
            "movementCount": 19,
            "creditAmount": 3678.45,
            "debitAmount": -1456.78,
            "diffAmount": 2221.67,
            "initialBalance": 2089.97,
            "finalBalance": 4311.64
        },
        {
            "periodDate": "2025-02",
            "movementCount": 49,
            "creditAmount": 0,
            "debitAmount": -1058.67,
            "diffAmount": -1058.67,
            "initialBalance": 4311.64,
            "finalBalance": 3252.97
        },
        {
            "periodDate": "2025-03",
            "movementCount": 7,
            "creditAmount": 1253.45,
            "debitAmount": -1000,
            "diffAmount": 253.45,
            "initialBalance": 3252.97,
            "finalBalance": 3506.42
        }
    ]
}

Página anterior

Obter saldo da conta do cliente.

Próxima página

Iniciar um pagamento por QR Code.