Skip to main content

Send boleto instruction

Send instruction​

To request a boleto instruction, simply make the issuance request with the "occurrence_type" as below:

ValueDescription
registrationRegister a new boleto.
bank_slip_editEdit payer information of an existing boleto.
extensionExtend the due date of an existing boleto.
write_offWrite-off of a boleto without financial implications.
rebatePayment rebate.
cancel_rebateCancel payment rebate.
bank_slip_editEdit an existing boleto (Discount, Address, Fine/Interest).
protest_requestProtest boleto.
bankruptcy_protest_requestBankruptcy Protest.
protest_remove_requestCancel Protest.
protest_cancel_requestSuspend Protest without Write-off.
protest_cancel_and_write_off_requestSuspend Protest with Write-off.

Request Examples

Extension​

To request this instruction, the boleto must be registered and payable.

Request Body
{
  "occurrences": [
    {
      "occurrence_type": "extension",
      "requester_profile_code": "329-01-0001-0000001",
      "our_number": 1000000,
      "expiration": "2022-06-15"
    }
  ]
}

Write off​

To request this instruction, the boleto must be registered.

Request Body
{
  "occurrences": [
    {
      "occurrence_type": "write_off",
      "requester_profile_code": "329-01-0001-0000001",
      "our_number": 1000000
    }
  ]
}

Rebate​

To request this instruction, the boleto must not be overdue.

Request Body
{
  "occurrences": [
    {
      "occurrence_type": "rebate",
      "our_number": 1000000,
      "rebate_amount": 10,
      "requester_profile_code": "329-01-0001-0000001"
    }
  ]
}

Cancel Rebate​

To request this instruction, the boleto must have an active rebate and must not be overdue.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000008,
      "occurrence_type": "cancel_rebate",
      "requester_profile_code": "329-01-0001-0000001",
      "bank_slip_key": "ce9b6834-4c6c-423a-a337-b9815a462ae5"
    }
  ]
}

Discount​

To request this instruction, the boleto must not be overdue or written off.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000008,
      "occurrence_type": "bank_slip_edit",
      "requester_profile_code": "329-01-0001-0000001",
      "registration_institution_enumerator": "qi_scd",
      "discounts": [
        {
          "discount_number": 1,
          "discount_limit_date": "2022-06-14",
          "discount_value": 10
        }
      ]
    }
  ]
}

Add/Edit Address​

To request this instruction, the boleto must be registered and payable.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000008,
      "occurrence_type": "bank_slip_edit",
      "requester_profile_code": "329-01-0001-0000001",
      "payer_address": "Rua dos Alfeneiros, 4, Little Whinging - Surrey, City, SP",
      "payer_postal_code_root": "17057",
      "payer_postal_code_suffix": "770"
    }
  ]
}

Edit Fine/Interest​

To request this instruction, the boleto must be registered and payable.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000008,
      "occurrence_type": "bank_slip_edit",
      "requester_profile_code": "329-01-0001-0000001",
      "fine_percentage": 1,
      "interest_daily_value": 0.33
    }
  ]
}

Protest​

To request this instruction, the boleto must be overdue and must have the payer's address details.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000002,
      "occurrence_type": "protest_request",
      "requester_profile_code": "329-01-0001-0000001"
    }
  ]
}

Bankruptcy Protest​

To request this instruction, the boleto must be overdue and must have the payer's address details.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000002,
      "occurrence_type": "bankruptcy_protest_request",
      "requester_profile_code": "329-01-0001-0000001"
    }
  ]
}

Cancel Protest​

To request this instruction, the boleto must be protested.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000002,
      "occurrence_type": "protest_remove_request",
      "requester_profile_code": "329-01-0001-0000001"
    }
  ]
}

Cancel Automatic Protest​

To request this instruction, the boleto must be registered with this option active.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000002,
      "occurrence_type": "bank_slip_edit",
      "requester_profile_code": "329-01-0001-0000001",
      "automatic_bankruptcy_protest": false,
      "automatic_protest": false
    }
  ]
}

Suspend Protest without Write-off​

To request this instruction, the boleto must be protested.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000002,
      "occurrence_type": "protest_cancel_request",
      "requester_profile_code": "329-01-0001-0000001"
    }
  ]
}

Cancel Automatic Protest​

To request this instruction, the boleto must be protested.

Request Body
{
  "occurrences": [
    {
      "our_number": 1000000002,
      "occurrence_type": "protest_cancel_and_write_off_request",
      "requester_profile_code": "329-01-0001-0000001"
    }
  ]
}

Response Example​

The response varies for each type of instruction, generally resulting in changes to the fields of occurrence_stats, in the key of each instruction.

In the semantic_errors field, a list is returned with objects for each occurrence with their respective errors (example below).

Request Body
{
  "file_info": {
    "beneficiary_code": null,
    "beneficiary_name": null,
    "file_sequence_id": null,
    "file_type_identifier": null,
    "file_type_literal": null,
    "service_code": null,
    "service_literal": null,
    "wrote_at": null
  },
  "occurrence_stats": {
    "bank_slip_edit": 0,
    "bankruptcy_protest_request": 0,
    "cancel_rebate": 0,
    "extension": 0,
    "notary_office_entry": 0,
    "notary_office_exit": 0,
    "notary_office_payment": 0,
    "notification": 0,
    "payment": 0,
    "payment_notice": 0,
    "payment_write_off": 0,
    "protest_cancel_and_write_off_request": 0,
    "protest_cancel_request": 0,
    "protest_remove_request": 0,
    "protest_request": 0,
    "rebate": 0,
    "registration": 0,
    "write_off": 1
  },
  "semantic_errors": [
    {
      "0": {
        "errors": [
          {
            "created_at": "2019-03-12T12:59:32",
            "reason_code": "CEP Inválido",
            "translation_en_us": "Invalid Postal Code",
            "translation_pt_br": "CEP Inválido"
          }
        ],
        "our_number": 1000000000,
        "participant_control_number": null
      }
    }
  ]
}