v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

Recebimento de Boleto

Listar Pagamentos de Boleto

Listar Pagamentos de Boleto.

get/v1/bank_billet_payments

Query parameters

pageinteger

Número da Página

per_pageinteger

Quantidade de registros por página

paid_fromstring date

A partir da Data de pagamento.

paid_tostring date

Até a Data de pagamento.

bank_billet_idstring

ID do Boleto.

bank_billet_account_idstring

ID da Carteira.

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Sucesso na listagem dos pagamentos de boletos

idinteger

ID do Recebimento de Boleto

bank_billet_idinteger nullable required

ID do Boleto.

bank_billet_account_idinteger nullable required

ID da Carteira.

discharge_idinteger nullable

ID do Retorno.

amountnumber float

Valor do Boleto

paid_amountnumber float required

Valor Pago

paid_atstring date nullable required

Data do Recebimento.

paid_bankstring nullable

Banco de Recebimento.

paid_agencystring nullable

Agência de Recebimento (com dígito quando disponível).

paid_agency_numberstring nullable

Número da Agência de Recebimento (sem dígito).

paid_agency_digitstring nullable

Dígito da Agência de Recebimento.

bank_ratenumber float nullable

Taxa bancária

credit_atstring date nullable

Data de crédito.

directboolean nullable

Recebimento direto ao beneficíario

expire_atstring date nullable

Data de vencimento.

kind0 | 1 | 2 required

Tipo de Recebimento:

0 Direto ao beneficíario/Em mãos
1 Boleto (Confirmado pelo banco via arquivo de retorno ou API)
2 Pix (Confirmado pelo banco via Pix)

document_numberstring nullable

Número do Documento.

our_numberstring nullable

Nosso Número.

created_via_apiboolean nullable

Enviado pela API

created_atstring date-time nullable

Data e hora de criação.

updated_atstring date-time nullable

Data e hora da última atualização.

customer_person_namestring nullable

Nome do cliente

paid_by_pixboolean nullable

Recebimento via Pix

financial_provider_external_idstring nullable

ID do recebimento na instituição financeira

line_parsedstring json nullable

Linha parseada com informações vindas do banco:

Conteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação.

Valor	Descrição
paid_at	Data de recebimento
paid_amount	Valor pago
bank_rate	Taxa do boleto paga ao banco
credit_at	Data de crédito
credit_amount	Valor do Crédito
our_number	Nosso número
processed_our_number_raw	Nosso número formatado
discount	Desconto
billet_fine	Acréscimos(Multa/Juros cobrados)
other_fines	Outras cobranças adicionais
other_credit	Outros valores pagos
value_rebate	Outras taxas
error_code	Código de erro
event_type	Ocorrência bancária
agency_number	Agência
account_number	Conta
banco_recebedor	Banco recebedor
agencia_recebedora	Agência recebedora
control_number	Número de Controle
document_number	Número do Documento

Example response

[
  {
    "amount": 10.99,
    "paid_amount": 10.99,
    "bank_rate": 10.99
  }
]