Esse endpoint permite consultar as movimentações/transações realizadas na conta, com possibilidade de aplicar filtros e paginação para os resultados.
Parâmetros da URL para paginação:
-
date_from(date, opcional): Data de início das transações. -
date_to(date, opcional): Data final para as transações. -
page(integer, opcional): O nº da página para paginação. -
limit_per_page(integer, opcional): A quantidade de itens a serem retornados na paginação.
Parâmetros da Requisição
Não é necessário o envio de nenhum dado no corpo da requisição.
Resposta
Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:
-
total_pages(integer): Número total de páginas encontradas para movimentações. -
current_page(integer): Número da página atual, para resultados paginados. -
date_from(date): Data de início, se aplicado o filtro. -
date_to(date): Data final, se aplicado o filtro. -
account(object): Objeto contendo os dados da conta. -
movements(object): Objeto contendo os detalhes da movimentação realizada na conta.
Objeto "account":
-
name(string): Nome da conta. -
bank_account(string): Número da conta. -
cashout(object): Objeto contendo as chaves Pix cadastradas para transferências. -
cashout -> pix -> key(string): Código da chave Pix.
Objeto "movements":
-
id(string): ID de cadastro. -
movement_id(string): ID único da movimentação. -
client_code(string): Código de identificação do cliente titular da conta. -
description(string): Descrição da movimentação. -
create_date(datetime): Data do registro da movimentação. -
last_update_date(datetime): Data da última atualização da movimentação. -
amout(float): Valor total transacionado. -
status(string): Status de processamento da movimentação. -
balance_type(string): Tipo do saldo. -
movement_type(string): Tipo da movimentação. -
movement_entity(string): Tipo da entidade. -
end_to_end_id(string): Identificador de ponta a ponta associado a movimentação. -
disbursement_originator_id(string): Identificador único do originador do desembolso. -
disbursement_sequential_id(string): ID sequencial para o desembolso. -
disbursement_issuer_id(string): Identificador único do emissor. -
disbursement_funding_id(string): Identificador único do financiador. -
disbursement_application_id(string): Identificador único da aplicação. -
disbursement_product_id(string): Identificador único do produto/linha de crédito. -
disbursement_product_name(string): Nome do produto. -
disbursement_borrower_id(string): Identificador único do tomador -
disbursement_borrower_taxpayer_id(string): Número do documento de identificação do tomador. -
disbursement_borrower_name(string): Nome do tomador. -
disbursement_borrower_type(string): Tipo do tomador. -
disbursement_borrower_pix_key(string): Chave Pix do tomador. -
disbursement_borrower_bank_account(string): Número da conta do tomador. -
disbursement_borrower_bank_branch(string): Número da agência do tomador. -
disbursement_borrower_bank_account_digit(string): Número do dígito da conta do tomador. -
disbursement_borrower_bank_account_type(string): Tipo da conta do tomador. -
disbursement_borrower_bank_ispb_code(string): Código ISPB da conta do tomador. -
disbursement_beneficiary_taxpayer_id(string): Documento de identificação do beneficiário. -
disbursement_beneficiary_name(string): Nome do beneficiário. -
disbursement_beneficiary_pix_key(string): Chave PIX do beneficiário. -
disbursement_beneficiary_bank_account(string): Número da conta do beneficiário. -
disbursement_beneficiary_bank_branch(string): Número da agência da conta do beneficiário. -
disbursement_beneficiary_bank_account_digit(string): Dígito da conta do beneficiário. -
disbursement_beneficiary_bank_account_type(string): Tipo da conta do beneficiário. -
disbursement_beneficiary_bank_ispb_code(string): Código ISPB da conta do beneficiário. -
disbursement_requested_amount(string): Valor solicitado. -
disbursement_tac_amount(string): Valor da TAC. -
disbursement_finance_fee(string): Demais custos de financiamento. -
disbursement_iof_amount(string): Valor de IOF -
disbursement_date(string): Data de desembolso. -
disbursement_amount(string): Valor desembolsado. -
disbursement_financed_amount(string): Valor financiado em reais. Valor nominal (de face do empréstimo). Inclui o Valor Solicitado, Taxas de Cadastro (TAC), IOF e Demais taxas (finance_fee) -
disbursement_requested_at(string): Data da solicitação. -
disbursement_additional_premium_amount(string): -
disbursement_base_premium_amount(string): -
debit_party_account(string): Número da conta bancária da pessoa debitada. -
debit_party_branch(string): Número da agência da pessoa debitada. -
debit_party_tax_id(string): Documento de identificação da pessoa debitada. -
debit_party_name(string): Nome da pessoa debitada. -
debit_party_account_type(string): Tipo da conta da pessoa debitada. -
credit_party_account(string): Número da conta bancária da pessoa creditada. -
credit_party_branch(string): Número da agência da pessoa creditada. -
credit_party_tax_id(string): Documento de identificação da pessoa creditada. -
credit_party_name(string): Nome da pessoa creditada. -
credit_party_account_type(string): Tipo da conta da pessoa creditada. -
credit_party_key(string): Chave PIX da pessoa creditada. -
original_payment_id(string): Identificação do pagamento realizado. -
additional_information(string): Informações adicionais. -
reason(string): Motivo da movimentação. -
reversal_description(string): Descrição/motivo da reversão. -
original_end_to_end_id(string): Identificador de ponta a ponta associado a movimentação original. -
original_client_code(string): Código de identificação do cliente titular da conta da movimentação original. -
original_id(string): ID de movimento orignal -
return_identification(string): Mensagem de identificação do retorno. -
remittance_information(string): Informação referente a remissão.
Exemplo de JSON:
{
"account": {
"name": "<string>",
"account": "<string>",
"cashout": {
"pix": {
"key": "<string>"
}
}
},
"total_pages": "<integer>",
"current_page": "<integer>",
"movements": [
{
"id": "<string>",
"movement_id": "<string>",
"client_code": "<string>",
"description": "<string>",
"create_date": "<string>",
"last_update_date": "<string>",
"amount": "<string>",
"status": "<string>",
"balance_type": "<string>",
"movement_type": "<string>",
"movement_entity": "<string>",
"end_to_end_id": "<string>",
"disbursement_originator_id": "<string>",
"disbursement_sequential_id": "<string>",
"disbursement_issuer_id": "<string>",
"disbursement_funding_id": "<string>",
"disbursement_application_id": "<string>",
"disbursement_product_id": "<string>",
"disbursement_product_name": "<string>",
"disbursement_borrower_id": "<string>",
"disbursement_borrower_taxpayer_id": "<string>",
"disbursement_borrower_name": "<string>",
"disbursement_borrower_type": "<string>",
"disbursement_borrower_pix_key": "<string>",
"disbursement_borrower_bank_account": "<string>",
"disbursement_borrower_bank_branch": "<string>",
"disbursement_borrower_bank_account_digit": "<string>",
"disbursement_borrower_bank_account_type": "<string>",
"disbursement_borrower_bank_ispb_code": "<string>",
"disbursement_beneficiary_taxpayer_id": "<string>",
"disbursement_beneficiary_name": "<string>",
"disbursement_beneficiary_pix_key": "<string>",
"disbursement_beneficiary_bank_account": "<string>",
"disbursement_beneficiary_bank_branch": "<string>",
"disbursement_beneficiary_bank_account_digit": "<string>",
"disbursement_beneficiary_bank_account_type": "<string>",
"disbursement_beneficiary_bank_ispb_code": "<string>",
"disbursement_requested_amount": "<string>",
"disbursement_tac_amount": "<string>",
"disbursement_finance_fee": "<string>",
"disbursement_iof_amount": "<string>",
"disbursement_date": "<string>",
"disbursement_amount": "<string>",
"disbursement_financed_amount": "<string>",
"disbursement_requested_at": "<string>",
"disbursement_additional_premium_amount": "<string>",
"disbursement_base_premium_amount": "<string>",
"debit_party_account": "<string>",
"debit_party_branch": "<string>",
"debit_party_tax_id": "<string>",
"debit_party_name": "<string>",
"debit_party_account_type": "<string>",
"credit_party_account": "<string>",
"credit_party_branch": "<string>",
"credit_party_tax_id": "<string>",
"credit_party_name": "<string>",
"credit_party_account_type": "<string>",
"credit_party_key": "<string>",
"original_payment_id": "<string>",
"additional_information": "<string>",
"reason": "<string>",
"reversal_description": "<string>",
"original_end_to_end_id": "<string>",
"original_client_code": "<string>",
"original_id": "<string>",
"return_identification": "<string>",
"remittance_information": "<string>"
},
{
"id": "<string>",
"movement_id": "<string>",
"client_code": "<string>",
"description": "<string>",
"create_date": "<string>",
"last_update_date": "<string>",
"amount": "<string>",
"status": "<string>",
"balance_type": "<string>",
"movement_type": "<string>",
"movement_entity": "<string>",
"end_to_end_id": "<string>",
"disbursement_originator_id": "<string>",
"disbursement_sequential_id": "<string>",
"disbursement_issuer_id": "<string>",
"disbursement_funding_id": "<string>",
"disbursement_application_id": "<string>",
"disbursement_product_id": "<string>",
"disbursement_product_name": "<string>",
"disbursement_borrower_id": "<string>",
"disbursement_borrower_taxpayer_id": "<string>",
"disbursement_borrower_name": "<string>",
"disbursement_borrower_type": "<string>",
"disbursement_borrower_pix_key": "<string>",
"disbursement_borrower_bank_account": "<string>",
"disbursement_borrower_bank_branch": "<string>",
"disbursement_borrower_bank_account_digit": "<string>",
"disbursement_borrower_bank_account_type": "<string>",
"disbursement_borrower_bank_ispb_code": "<string>",
"disbursement_beneficiary_taxpayer_id": "<string>",
"disbursement_beneficiary_name": "<string>",
"disbursement_beneficiary_pix_key": "<string>",
"disbursement_beneficiary_bank_account": "<string>",
"disbursement_beneficiary_bank_branch": "<string>",
"disbursement_beneficiary_bank_account_digit": "<string>",
"disbursement_beneficiary_bank_account_type": "<string>",
"disbursement_beneficiary_bank_ispb_code": "<string>",
"disbursement_requested_amount": "<string>",
"disbursement_tac_amount": "<string>",
"disbursement_finance_fee": "<string>",
"disbursement_iof_amount": "<string>",
"disbursement_date": "<string>",
"disbursement_amount": "<string>",
"disbursement_financed_amount": "<string>",
"disbursement_requested_at": "<string>",
"disbursement_additional_premium_amount": "<string>",
"disbursement_base_premium_amount": "<string>",
"debit_party_account": "<string>",
"debit_party_branch": "<string>",
"debit_party_tax_id": "<string>",
"debit_party_name": "<string>",
"debit_party_account_type": "<string>",
"credit_party_account": "<string>",
"credit_party_branch": "<string>",
"credit_party_tax_id": "<string>",
"credit_party_name": "<string>",
"credit_party_account_type": "<string>",
"credit_party_key": "<string>",
"original_payment_id": "<string>",
"additional_information": "<string>",
"reason": "<string>",
"reversal_description": "<string>",
"original_end_to_end_id": "<string>",
"original_client_code": "<string>",
"original_id": "<string>",
"return_identification": "<string>",
"remittance_information": "<string>"
}
],
"date_from": "<string>",
"date_to": "<string>"