Retrieving Account Transactions
Request
ENDPOINT
/cash_account/account/ACCOUNT_KEY/transactionsMETHOD
GETResponse
STATUS
200Response Body
{
"data": [
{
"transaction_key": "ed585534-8c05-431d-b829-0dc7883b24ba",
"transaction_type": "outgoing_wire_transfer",
"transaction_status": "pending_conciliation",
"transaction_description": "Descrição do pagamento",
"amount": -70000,
"transaction_datetime": "2025-01-01T14:00:00Z",
"account_balance": 500000,
"transaction_data": {
"counter_part_account": {
"owner": {
"name": "Nome da Contraparte",
"document_number": "***.805.49*-**"
},
"account_digit": "8",
"account_branch": "1",
"account_number": "1234567",
"financial_institution": {
"code": "329",
"ispb": "32402502"
}
},
},
"account": {
"account_key": "9c1d0c18-01ea-4c32-a878-1c6391f9aa44",
"account_type": "checking_account",
"financial_institution": {
"ispb": "32402502",
"code": "329",
"name": "QI Sociedade de Crédito Direto"
},
"account_status": "open",
"account_number": "3289018",
"account_digit": "7",
"account_branch": "0001",
"accounting_identification": 1,
"balance": 500000,
"owner": {
"name": "FUNDO TESTE",
"document_number": "93.625.214/0001-34"
},
"owner_document_number": "93.625.214/0001-34",
"account_configuration": {
"pix": true,
"wire_transfer": true
},
"billings": []
}
},
{
"transaction_key": "16c9c463-266e-4e73-b87d-efc32aa6727a",
"transaction_type": "incoming_wire_transfer",
"transaction_status": "reconciled",
"transaction_description": "Descrição",
"amount": 300000,
"transaction_datetime": "2025-06-04T13:00:00Z",
"account_balance": 570000,
"transaction_data": {
"counter_part_account": {
"owner": {
"name": "FUNDO TESTE",
"document_number": "93.625.214/0001-34"
},
"account_digit": "8",
"account_branch": "73",
"account_number": "567567",
"financial_institution": {
"code": "341",
"ispb": "60701190",
}
},
},
"account": {
"account_key": "9c1d0c18-01ea-4c32-a878-1c6391f9aa44",
"account_type": "checking_account",
"financial_institution": {
"ispb": "32402502",
"code": "329",
"name": "QI Sociedade de Crédito Direto"
},
"account_status": "open",
"account_number": "3289018",
"account_digit": "7",
"account_branch": "0001",
"accounting_identification": 1,
"balance": 500000,
"owner": {
"name": "FUNDO TESTE",
"document_number": "93.625.214/0001-34"
},
"owner_document_number": "93.625.214/0001-34",
"account_configuration": {
"pix": true,
"wire_transfer": true
},
"billings": []
},
"conciliation_group": {
"description": "TRANSFERÊNCIA: CONTA COBRANÇA -> CONTA PRINCIPAL",
"conciliation_group_key": "1ac2921c-6c81-481b-8472-6c4126bba4bf",
"conciliation_group_datetime": "2025-01-01T13:28:58Z"
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}
Query Params
| Field | Type | Description |
|---|---|---|
status | string | Transaction status |
start_date | string | Query start date |
end_date | string | Query end date |
page | string | Retrieved page number |
Response Fields
| Field | Type | Description |
|---|---|---|
data | array | List of Transaction objects |
limit | int | Limit of objects retrieved per page |
page | int | Retrieved page number |
is_last_page | boolean | Information indicating if the retrieved page is the last |
Transaction
| Field | Type | Description | Characters |
|---|---|---|---|
transaction_key | string | Unique transaction identifier key | 36 |
transaction_type | string | Transaction type | Up to 50 |
transaction_status | string | Transaction status | Up to 50 |
transaction_description | string | Transaction description provided by the bank | Up to 255 |
amount | bigint | Transaction value times 100 (e.g.: R$1.00 == 100) | - |
transaction_datetime | string | Transaction date and time | ISO 8601 |
account_balance | bigint | Account balance after the transaction | - |
transaction_data | JSON | Object with additional transaction information | - |
account | JSON | Account object containing the transaction | - |
Account
| Field | Type | Description | Characters |
|---|---|---|---|
account_key | string | Unique account identifier key | 36 |
account_type | string | Account type | Up to 50 |
financial_institution | JSON | Financial institution object | - |
account_status | string | Account status | Up to 50 |
account_number | string | Account number | Up to 50 |
account_digit | string | Account digit | 1 |
account_branch | string | Account branch | Up to 50 |
accounting_identification | int | Account ordinal identifier | - |
balance | int | Current account balance | - |
owner | JSON | Owner object | - |
owner_document_number | string | Owner's document | 14 or 18 |
Attention
The balance is provided by concatenating reais and centavos e.g.: 1234 = R$ 12.34
Finacial institution
| Field | Type | Description | Characters |
|---|---|---|---|
ispb | string | Brazilian Payment System Identifier | 8 |
code | string | Financial institution code | 3 |
name | string | Financial institution name | Up to 255 |
Owner
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Owner's name | up to 255 |
document_number | string | Owner's document | 14 or 18 |
Conciliation Group
| Field | Type | Description | Characters |
|---|---|---|---|
description | string | Transaction reconciliation description | Up to 255 |
conciliation_group_key | string | Unique reconciliation identifier key | 36 |
conciliation_group_datetime | string | Reconciliation date and time | ISO 8601 |