Pular para o conteúdo principal

Recuperando Transações de uma Conta

Lista as transações (extrato) de uma conta do fundo. Também é a forma de confirmar uma transferência entre contas do fundo.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer contas

URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/cash_account/fund_class/FUND_CLASS_KEY/account/ACCOUNT_KEY/transactions
MÉTODO
GET
Gestora e consultoria

A rota acima vale para os dois agentes: a conta precisa estar vinculada ao fundo informado em FUND_CLASS_KEY. A consultoria precisa ter, nesse fundo, permissão de consulta às contas, concedida pela gestora.

A gestora também pode consultar sem o fundo, em /cash_account/account/ACCOUNT_KEY/transactions. Essa forma não está disponível para a consultoria.

Path Params​

ParâmetroDescrição
FUND_CLASS_KEYChave da classe de fundo à qual a conta está vinculada
ACCOUNT_KEYChave da conta, como retornada em Recuperando Informações da Conta

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​

CampoTipoDescrição
statusstringStatus da transação
start_datestringData inicial de consulta
end_datestringData final de consulta
counter_part_document_numberstringDocumento da contraparte
limitintItens por página. Padrão: 10. Máximo: 50.
pageintNúmero da página recuperada (começando por zero)

Response Fields​

CampoTipoDescrição
dataarrayLista de objetos de Transaction
limitintLimite de objetos recuperados por página
pageintNúmero da página recuperada
is_last_pagebooleanInformação que indica se a página recuperada é a última

Transaction​

CampoTipoDescriçãoCaracteres
transaction_keystringChave única identificadora da transação36
transaction_typestringTipo de transaçãoAté 50
transaction_statusstringstatus da transaçãoAté 50
transaction_descriptionstringDescrição da transação fornecida pelo bancoAté 255
amountbigintValor da transação vezes 100 (ex: R$1,00 == 100)-
transaction_datetimestringData e hora da transaçãoISO 8601
account_balancebigintSaldo da conta após a transação-
transaction_dataJSONObjeto com informações adicionais da transação-
accountJSONObjeto da conta contendo a transação-

Account​

CampoTipoDescriçãoCaracteres
account_keystringChave única identificadora da conta36
account_typestringTipo de contaAté 50
financial_institutionJSONObjeto de instituição financeira-
account_statusstringStatus da contaAté 50
account_numberstringNúmero da contaAté 50
account_digitstringDigito da conta1
account_branchstringAgência da contaAté 50
accounting_identificationintIdentificador ordinal da conta-
balanceintSaldo da conta no momento-
ownerJSONObjeto de proprietário-
owner_document_numberstringDocumento do proprietário14 ou 18
Atenção

O saldo é disponibilizado em centavos, ex.: 1234 = R$ 12,34.

Financial institution​

CampoTipoDescriçãoCaracteres
ispbstringIdentificador de Sistema de Pagamentos Brasileiro8
codestringCódigo da instituição financeira3
namestringNome da instituição financeiraAté 255

Owner​

CampoTipoDescriçãoCaracteres
namestringNome do proprietárioaté 255
document_numberstringDocumento do proprietário14 ou 18

Conciliation Group​

CampoTipoDescriçãoCaracteres
descriptionstringDescrição da conciliação da transaçãoAté 255
conciliation_group_keystringChave única identificadora da conciliação36
conciliation_group_datetimestringdata e horário da conciliaçãoISO 8601

Erros​

CódigoHTTPCausaComo resolver
CIT000018401A consultoria não tem vínculo ativo com o fundo informado, ou não tem permissão de consulta às contas nele.Solicitar à gestora a permissão no fundo.
CSH000048403A conta não está vinculada ao fundo informado, ou o fundo não pertence ao agente.Usar o FUND_CLASS_KEY do fundo dono da conta, conforme a listagem de contas do fundo.
CSH000006404Conta não encontrada para o ACCOUNT_KEY informado.Verificar se o ACCOUNT_KEY está correto.

Erros de autenticação, permissão e host: veja Erros da API.