Skip to main content

Retrieving Account Transactions

Lists the transactions (statement) of a fund account. It is also the way to confirm a transfer between fund accounts.

Available on
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiView accounts

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/cash_account/fund_class/FUND_CLASS_KEY/account/ACCOUNT_KEY/transactions
METHOD
GET
Manager and consultant

The endpoint above applies to both agents: the account must be linked to the fund given in FUND_CLASS_KEY. The consultant must have, in that fund, permission to query the accounts, granted by the manager.

The manager can also query without the fund, at /cash_account/account/ACCOUNT_KEY/transactions. This form is not available to the consultant.

Path Params​

ParameterDescription
FUND_CLASS_KEYKey of the fund class to which the account is linked
ACCOUNT_KEYAccount key, as returned in Retrieving Account Information

Response​

STATUS
200
Response 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": "11.222.333/0001-81"
                },
                "owner_document_number": "11.222.333/0001-81",
                "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": "11.222.333/0001-81"
                  },
                  "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": "11.222.333/0001-81"
                },
                "owner_document_number": "11.222.333/0001-81",
                "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​

FieldTypeDescription
statusstringTransaction status
start_datestringQuery start date
end_datestringQuery end date
counter_part_document_numberstringCounterparty document
limitintItems per page. Default: 10. Maximum: 50.
pageintNumber of the retrieved page (starting at zero)

Response Fields​

FieldTypeDescription
dataarrayList of Transaction objects
limitintLimit of objects retrieved per page
pageintNumber of the retrieved page
is_last_pagebooleanIndicates whether the retrieved page is the last one

Transaction​

FieldTypeDescriptionCharacters
transaction_keystringUnique identifier key of the transaction36
transaction_typestringTransaction typeUp to 50
transaction_statusstringTransaction statusUp to 50
transaction_descriptionstringTransaction description provided by the bankUp to 255
amountbigintTransaction amount times 100 (e.g.: R$1.00 == 100)-
transaction_datetimestringTransaction date and timeISO 8601
account_balancebigintAccount balance after the transaction-
transaction_dataJSONObject with additional transaction information-
accountJSONObject of the account containing the transaction-

Account​

FieldTypeDescriptionCharacters
account_keystringUnique identifier key of the account36
account_typestringAccount typeUp to 50
financial_institutionJSONFinancial institution object-
account_statusstringAccount statusUp to 50
account_numberstringAccount numberUp to 50
account_digitstringAccount digit1
account_branchstringAccount branchUp to 50
accounting_identificationintAccount ordinal identifier-
balanceintCurrent account balance-
ownerJSONOwner object-
owner_document_numberstringOwner's document14 or 18
Attention

The balance is provided in cents, e.g.: 1234 = R$ 12.34.

Financial institution​

FieldTypeDescriptionCharacters
ispbstringBrazilian Payment System Identifier8
codestringFinancial institution code3
namestringFinancial institution nameUp to 255

Owner​

FieldTypeDescriptionCharacters
namestringOwner's nameup to 255
document_numberstringOwner's document14 or 18

Conciliation Group​

FieldTypeDescriptionCharacters
descriptionstringDescription of the transaction reconciliationUp to 255
conciliation_group_keystringUnique identifier key of the reconciliation36
conciliation_group_datetimestringReconciliation date and timeISO 8601

Errors​

CodeHTTPCauseHow to fix
CIT000018401The consultant has no active link with the given fund, or has no permission to query its accounts.Ask the manager for the permission on the fund.
CSH000048403The account is not linked to the given fund, or the fund does not belong to the agent.Use the FUND_CLASS_KEY of the fund that owns the account, as shown in the fund's account listing.
CSH000006404Account not found for the given ACCOUNT_KEY.Check that the ACCOUNT_KEY is correct.

Authentication, permission and host errors: see API Errors.