Simulação de cenários de registro e alteração de boletos
Para gerar simulações de uma notificação de registro de um boleto onde o titular da conta seja o pagador, o parceiro integrador pode utilizar os endpoints abaixo:
Informação
Para receber os webhooks de teste, a conta informada no endpoint deve ser uma conta válida do requester e ativa no DDA.
Request registro de boleto
ENDPOINT
/mock/account/ACCOUNT-KEY/dda/bank_slipMÉTODO
POSTRequest Body
{
"status": "registered",
"amount": 1050,
"partial_payment_allowed": false,
"expiration": "2024-05-30",
"max_payment_date": "2024-07-01",
"beneficiary": {
"name": "Tech Solutions Ltda.",
"bank_code": "123",
"bank_ispb": "12345678",
"person_type": "legal",
"document_number": "12345678000100"
},
"guarantor": {
"name": "Maria Junior",
"person_type": "natural",
"document_number": "03903984900"
},
"rebate_amount": 30.0,
"interest": [
{
"interest_amount_type": "workdays_daily_amount",
"interest_billing_start_date": "2024-05-21",
"interest_amount": 10.0
}
],
"fine": [
{
"fine_billing_start_date": "2024-05-29",
"fine_amount_type": "absolute",
"fine_amount": 100.0
}
],
"discounts": [
{
"discount_limit_date": "2024-05-05",
"discount_type": "absolute",
"discount_amount": 50.0
}
],
"calculations": [],
"calculation_model": "01"
}
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
status * | enum | Enumeradores de status de um boleto. | - |
amount * | float | Valor nominal do boleto. | - |
partial_payment_allowed * | boolean | Indicador de aceite de pagamento parcial. | - |
expiration * | string | Data de vencimento do boleto. | 10 |
max_payment_date * | string | Data limite de pagamento do boleto. | 10 |
beneficiary * | object | Objeto beneficiário do boleto. | - |
guarantor | object | Objeto sacador avalista do boleto | - |
rebate_amount | float | Valor de rebate. | - |
interest | list | Lista de objetos interest. | - |
fine | list | Lista de objetos fine. | - |
discounts | list | Lista de objetos discount. | - |
calculations | list | Lista do grupo cálculo de boleto. | - |
calculation_model * | string | Método de cálculo do valor atual do boleto. | 2 |
Enumeradores Status
Enumerador | Descrição |
---|---|
registered | Código de barras do boleto registrado. |
paid | Boleto pago. |
partially_paid | Boleto pago parcialmente. |
written_off | Boleto baixado. |
Objeto Beneficiary
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
name * | string | Nome do beneficiário. | - |
person_type * | string | Tipo de pessoa do beneficiário. | 7 |
document_number * | string | Documento do beneficiário. | 14 |
bank_code * | string | Código do banco do beneficiário. | 3 |
bank_ispb * | string | ISPB do banco do beneficiário. | 8 |
Objeto guarantor
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
name * | string | Nome do sacador avalista. | - |
person_type * | string | Tipo de pessoa do sacador avalista. | 7 |
document_number * | string | Documento do sacador avalista. | 14 |
Objeto interest
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
interest_billing_start_date * | string | Data de início do juros. | 10 |
interest_amount_type * | string | Tipo de juros. | - |
interest_amount * | string | Valor do juros. | - |
Objeto fine
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
fine_billing_start_date * | string | Data de início da multa. | 10 |
fine_amount_type * | string | Tipo de multa. | - |
fine_amount * | string | Valor da multa. | - |
Objeto discount
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
discount_limit_date * | string | Data limite do disconto. | 10 |
discount_type * | string | Tipo de desconto. | - |
discount_amount * | string | Valor do desconto. | - |
Response
STATUS
200{}
Request alteração de boleto
Apenas alguns campos do boleto podem ser alterados, como ilustrado na request abaixo. Alguns campos, como beneficiário, pagador e aceite de pagamento parcial, não aceitam alteração.
Informação
Os campos que são listas de objetos não devem ser passados caso não deseje alterá-los. Se uma lista vazia for passada, ou qualquer outro valor for passado dentro da lista todos os objetos serão substituídos.
ENDPOINT
/mock/account/ACCOUNT-KEY/dda/bank_slip/BARECODEMÉTODO
PATCHRequest Body
{
"status": "registered",
"amount": 1200,
"expiration": "2024-05-30",
"max_payment_date": "2024-07-01",
"guarantor": {
"name": "Maria Junior",
"person_type": "natural",
"document_number": "03903984900"
},
"rebate_amount": 30.0,
"interest": [],
"fine": [
{
"fine_billing_start_date": "2024-05-29",
"fine_amount_type": "absolute",
"fine_amount": 100.0
},
{
"fine_billing_start_date": "2024-06-29",
"fine_amount_type": "absolute",
"fine_amount": 100.0
}
],
"discounts": [
{
"discount_limit_date": "2024-05-05",
"discount_type": "absolute",
"discount_amount": 50.0
}
],
"calculations": [],
"calculation_model": "01"
}
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
status * | enum | Enumeradores de status de um boleto. | - |
amount | float | Valor nominal do boleto. | - |
expiration | string | Data de vencimento do boleto. | 10 |
max_payment_date | string | Data limite de pagamento do boleto. | 10 |
guarantor | object | Objeto sacador avalista do boleto | - |
rebate_amount | float | Valor de rebate. | - |
interest | list | Lista de objetos interest. | - |
fine | list | Lista de objetos fine. | - |
discounts | list | Lista de objetos discount. | - |
calculations | list | Lista do grupo cálculo de boleto. | - |
calculation_model | string | Método de cálculo do valor atual do boleto. | 2 |
Response
STATUS
200{}
Request baixa por pagamento de boleto
ENDPOINT
/mock/account/ACCOUNT-KEY/dda/bank_slip/BARECODEMÉTODO
PATCHRequest Body
{
"status": "paid",
"paid_amount": 1200,
}
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
status * | enum | Enumeradores de status de um boleto. | - |
paid_amount * | float | Valor pago do boleto. | - |
Response
STATUS
200{}
Request baixa por cancelamento de boleto
ENDPOINT
/mock/account/ACCOUNT-KEY/dda/bank_slip/BARECODEMÉTODO
PATCHRequest Body
{
"status": "written_off",
}
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
status * | enum | Enumeradores de status de um boleto. | - |
Response
STATUS
200{}