Recuperando Transações de uma Conta

---

Request

ENDPOINT

/cash_account/account/ACCOUNT_KEY/transactions

MÉTODO

GET

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": "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

Campo	Tipo	Descrição
status	string	Status da transação
start_date	string	Data inicial de consulta
end_date	string	Data final de consulta
page	string	Número da página recuperada

Response Fields

Campo	Tipo	Descrição
data	array	Lista de objetos de Transaction
limit	int	Limite de objetos recuperados por página
page	int	Número da página recuperada
is_last_page	boolean	Informação que indica se a página recuperada é a última

Transaction

Campo	Tipo	Descrição	Caracteres
transaction_key	string	Chave única identificadora da transação	36
transaction_type	string	Tipo de transação	Até 50
transaction_status	string	status da transação	Até 50
transaction_description	string	Descrição da transação fornecida pelo banco	Até 255
amount	bigint	Valor da transação vezes 100 (ex: R$1,00 == 100)	-
transaction_datetime	string	Data e hora da transação	ISO 8601
account_balance	bigint	Saldo da conta após a transação	-
transaction_data	JSON	Objeto com informações adicionais da transação	-
account	JSON	Objeto da conta contendo a transação	-

Account

Campo	Tipo	Descrição	Caracteres
account_key	string	Chave única identificadora da conta	36
account_type	string	Tipo de conta	Até 50
financial_institution	JSON	Objeto de instituição financeira	-
account_status	string	Status da conta	Até 50
account_number	string	Número da conta	Até 50
account_digit	string	Digito da conta	1
account_branch	string	Agência da conta	Até 50
accounting_identification	int	Identificador ordinal da conta	-
balance	int	Saldo da conta no momento	-
owner	JSON	Objeto de proprietário	-
owner_document_number	string	Documento do proprietário	14 ou 18

Atenção

O saldo é disponibilizado concatenando reais e centavos ex.: 1234 = R$ 12,34

Finacial institution

Campo	Tipo	Descrição	Caracteres
ispb	string	Identificador de Sistema de Pagamentos Brasileiro	8
code	string	Código da instituição financeira	3
name	string	Nome da instituição financeira	Até 255

Owner

Campo	Tipo	Descrição	Caracteres
name	string	Nome do proprietário	até 255
document_number	string	Documento do proprietário	14 ou 18

Conciliation Group

Campo	Tipo	Descrição	Caracteres
description	string	Descrição da conciliação da transação	Até 255
conciliation_group_key	string	Chave única identificadora da conciliação	36
conciliation_group_datetime	string	data e horário da conciliação	ISO 8601