Efetuar Pagamento de Boleto

post https://{apiHost}/v1/bank_billet_payments

Efetuar Pagamento de Boleto.

Body Params

Dados do pagamento do boleto

bank_billet_id

integer | null

required

ID do Boleto.

bank_billet_account_id

integer | null

required

ID da Carteira.

discharge_id

integer | null

ID do Retorno.

amount

float

Valor do Boleto

paid_amount

float

required

Valor Pago

paid_bank

string | null

Banco de Recebimento.

paid_agency

string | null

Agência de Recebimento.

bank_rate

float | null

Taxa bancária

kind

integer

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)

our_number

string | null

Nosso Número.

created_via_api

boolean | null

Enviado pela API

customer_person_name

string | null

Nome do cliente

financial_provider_external_id

string | null

ID do recebimento na instituição financeira

line_parsed

json | null

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

Show Deprecated

Headers

User-Agent

string

Informar um e-mail válido para contatos.

X-Idempotency-Key

string

Chave de idempotência para evitar replay de processamento.

Responses

Response body

object

integer

ID do Recebimento de Boleto

bank_billet_id

integer | null

required

ID do Boleto.

bank_billet_account_id

integer | null

required

ID da Carteira.

discharge_id

integer | null

ID do Retorno.

amount

float

Valor do Boleto

paid_amount

float

required

Valor Pago

paid_at

date | null

required

Data do Recebimento.

paid_bank

string | null

Banco de Recebimento.

paid_agency

string | null

Agência de Recebimento.

bank_rate

float | null

Taxa bancária

credit_at

date | null

Data de crédito.

direct

boolean | null

deprecated

Recebimento direto ao beneficíario

expire_at

date | null

Data de vencimento.

kind

integer

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)

1 2

document_number

string | null

Número do Documento.

our_number

string | null

Nosso Número.

created_via_api

boolean | null

Enviado pela API

created_at

date-time | null

Data e hora de criação.

updated_at

date-time | null

Data e hora da última atualização.

customer_person_name

string | null

Nome do cliente

paid_by_pix

boolean | null

deprecated

Recebimento via PIX

financial_provider_external_id

string | null

ID do recebimento na instituição financeira

line_parsed

json | null

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

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.kobana.com.br/v1/bank_billet_payments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"kind":0}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Pagamento efetuado com sucesso

401Falha de autenticação. Token inválido

403Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

422Dados inválidos