Criar um pagamento de Boleto
Siga nosso passo a passo para criar um pagamento de Boleto
Criar ocorrência
1 - Esse endpoint gera um pagamento de um boleto.
lembre-se de sempre enviar o token(Authorization) no header da requisição.
endpoint: {{base_url}}/partner/baas/account/billet_payments
verbo http POST
{{base_url}} será substituida pela URL da sua empresa.
2 - Para gerar um pagamento de boleto é necessário o envio dos seguintes parâmetros.
CHAVE | VALOR | DESCRIÇÂO |
---|---|---|
date | {{date}} | Data do pagamento. |
account | {{account}} | Conta para |
value | {{value}} | Valor do boleto |
total | {{total}} | Valor final do boleto (multa/ juros). |
rebate | {{rebate}} | Desconto |
discount | {{discount}} | Desconto |
interest | {{interest}} | Juros |
other_value | {{other_value}} | Outro valor |
document_number | {{document_number}} | Codigo de barras do boleto |
Corpo da requisição:
{
"date":"2022-12-30",
"value":"275.0",
"total":"275.0",
"rebate":"0",
"discount":"0",
"interest":"4.26",
"other_value":"0",
"document_number":"03399543492037956804908972901014983930054698720",
"account":"99999999"
}
2 - Se tudo ocorrer bem, você receberá uma resposta com Status 200 OK
Corpo da resposta com sucesso:
{
"data": {
"id": "1",
"type": "v3_billet_payments",
"attributes": {
"user_id": 1,
"type": "BilletPayment",
"status": "done",
"cancel_reason": null,
"reverse_reason": null,
"auth_code": null,
"date": "30/12/2022",
"value": "275.0",
"agency": "0001",
"account": "{{account}}",
"tags": [],
"ticket_code": null,
"updated_at": "2022-04-05T16:28:50.861-03:00",
"created_at": "2022-04-05T16:28:50.861-03:00",
"scheduled_at": null,
"ticketed_at": null,
"canceled_at": null,
"late_at": null,
"done_at": null,
"reversed_at": null,
"ticket_auth_code": null,
"ticket_cancel_reason": null,
"errors": null,
"display_amount": "275.0",
"financial_institution_id": null,
"approved_by": "NOME DO PAGADOR",
"created_by": "NOME DO PAGADOR",
"cancelable_by_user?": false,
"user": {
"name": "NOME DO PAGADOR",
"account": "{{account}}",
"document": "9999999900",
"holder": 1,
"phone": "996309729",
"uid": "{{account}}[email protected]",
"payment_max_value": "999999999.99",
"info_email": null,
"set_password": false,
"set_short_password": false
},
"liquidation_disponibility_id": null,
"late_reason": null,
"pix_favored": null,
"document_number": "03399543492037956804908972901014983930054698720",
"discount": "0.0",
"rebate": "0.0",
"interest": "4.26",
"other_value": "0.0",
"total": "275.0",
"bank_name": "NOME DO BANCO",
"assignor": null,
"assignor_document": null,
"fee_amount": "0.0",
"segmento": null,
"favored": null,
"transfer_reason": null,
"bank": null,
"history": null,
"phoneddd": "",
"phonenumber": "",
"carrier": "",
"provider_id": null,
"pix_transaction_id": null,
"description": null,
"pix_transaction_account_id": null,
"competence": null,
"identifier": null,
"social_security_code_description": null,
"pix_initiation_method": "pix_key",
"pix_purpose": "instant_payment",
"pix_purchase_amount": "0.0"
}
}
}
Updated 9 months ago