Sign in

v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Recebimento de Boleto

Efetuar Pagamento de Boleto

Efetuar Pagamento de Boleto.

post/v1/bank_billet_payments

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Request body

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.

ValorDescrição
paid_atData de recebimento
paid_amountValor pago
bank_rateTaxa do boleto paga ao banco
credit_atData de crédito
credit_amountValor do Crédito
our_numberNosso número
processed_our_number_rawNosso número formatado
discountDesconto
billet_fineAcréscimos(Multa/Juros cobrados)
other_finesOutras cobranças adicionais
other_creditOutros valores pagos
value_rebateOutras taxas
error_codeCódigo de erro
event_typeOcorrência bancária
agency_numberAgência
account_numberConta
banco_recebedorBanco recebedor
agencia_recebedoraAgência recebedora
control_numberNúmero de Controle
document_numberNúmero do Documento

Example request

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

Response

Pagamento efetuado com sucesso

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.

ValorDescrição
paid_atData de recebimento
paid_amountValor pago
bank_rateTaxa do boleto paga ao banco
credit_atData de crédito
credit_amountValor do Crédito
our_numberNosso número
processed_our_number_rawNosso número formatado
discountDesconto
billet_fineAcréscimos(Multa/Juros cobrados)
other_finesOutras cobranças adicionais
other_creditOutros valores pagos
value_rebateOutras taxas
error_codeCódigo de erro
event_typeOcorrência bancária
agency_numberAgência
account_numberConta
banco_recebedorBanco recebedor
agencia_recebedoraAgência recebedora
control_numberNúmero de Controle
document_numberNúmero do Documento

Example response

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