Consultar transações da conta.

GET

/accounts/transactions

Contas

Lista as movimentações da conta no período informado: Pix, TED, boletos, transferências internas e demais débitos e créditos.

Informe event_date_start e event_date_end (obrigatórios). Use page_offset e page_limit para paginar, sort_by / sort_order para ordenar e filter para buscar pelo documento do pagador ou do recebedor.

Para o detalhe de uma movimentação, use GET /accounts/transactions/{transactionId}/details.

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:

transactions.read-Permite consultar transações da conta

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Sucesso

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠429

🔴500

🔴503

🔴504

Request Example

Shell

JavaScript

Java

Swift

curl --location '/accounts/transactions?event_date_start=undefined&event_date_end=undefined&page_offset=undefined&page_limit=undefined&sort_by=undefined&sort_order=undefined&filter=undefined' \
--header 'x-account-id;'

Response Example

200 - Exemplo 1

{
    "meta": {
        "total": 100,
        "limit": 10,
        "offset": 1
    },
    "data": [
        {
            "eventDate": "2019-08-24T14:15:22.123Z",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "status": "CANCELED",
            "endToEndId": "string",
            "txId": "string",
            "creditDebitType": "CREDIT",
            "transactionType": "PIX",
            "transactionAmount": {
                "currency": "BRL",
                "available": 0
            }
        }
    ]
}

Página anterior

Consultar detalhes de uma transação.

Próxima página

Obter saldo da conta do cliente.