Enviar instrução de boleto
Enviar instrução de Boleto
Para solicitar uma instrução de boleto, basta fazer a requisição de emissão com o "occurrence_type" conforme abaixo:
| Valor | Descrição |
|---|---|
registration | Registrar um novo boleto. |
bank_slip_edit | Editar informações do pagador de um boleto existente. |
extension | Prorrogação da data de vencimento de um boleto existente. |
write_off | Baixa sem financeiro de um boleto. |
rebate | Abatimento do pagamento. |
cancel_rebate | Cancelar abatimento do pagamento. |
bank_slip_edit | Edição de um boleto existente (Desconto, Endereço, Multa/juros). |
protest_request | Protestar boleto. |
bankruptcy_protest_request | Protesto Falimentar. |
protest_remove_request | Cancelar Protesto. |
protest_cancel_request | Sustar Protesto sem Baixa. |
protest_cancel_and_write_off_request | Sustar Protesto com Baixa. |
Exemplos de request
Prorrogação
Para solicitar essa instrução, o boleto precisa estar registrado, e deve estar pagável.
Request Body
{
"occurrences": [
{
"occurrence_type": "extension",
"requester_profile_code": "329-01-0001-0000001",
"our_number": 1000000,
"expiration": "2022-06-15"
}
]
}
Baixa
Para solicitar essa instrução, o boleto precisa estar registrado.
Request Body
{
"occurrences": [
{
"occurrence_type": "write_off",
"requester_profile_code": "329-01-0001-0000001",
"our_number": 1000000
}
]
}
Abatimento
Para solicitar essa instrução, o boleto não pode estar vencido.
Request Body
{
"occurrences": [
{
"occurrence_type": "rebate",
"our_number": 1000000,
"rebate_amount": 10,
"requester_profile_code": "329-01-0001-0000001"
}
]
}
Cancelar abatimento
Para solicitar essa instrução, o boleto deve conter um abatimento ativo, e não pode estar vencido.
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"
}
]
}
Desconto
Para solicitar essa instrução, o boleto não pode estar vencido/baixado.
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
}
]
}
]
}
Adicionar/Editar Endereço
Para solicitar essa instrução, o boleto deve estar registrado, e ser pagável.
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"
}
]
}
Editar Multa/Juros
Para solicitar essa instrução, o boleto deve estar registrado, e ser pagável.
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
}
]
}
Protesto
Para solicitar essa instrução, o boleto precisa estar vencido, e precisa ter os dados de endereço do pagador.
Request Body
{
"occurrences": [
{
"our_number": 1000000002,
"occurrence_type": "protest_request",
"requester_profile_code": "329-01-0001-0000001"
}
]
}
Protesto Falimentar
Para solicitar essa instrução, o boleto precisa estar vencido, e precisa ter os dados de endereço do pagador.
Request Body
{
"occurrences": [
{
"our_number": 1000000002,
"occurrence_type": "bankruptcy_protest_request",
"requester_profile_code": "329-01-0001-0000001"
}
]
}
Cancelar protesto
Para solicitar essa instrução, o boleto precisa estar protestado.
Request Body
{
"occurrences": [
{
"our_number": 1000000002,
"occurrence_type": "protest_remove_request",
"requester_profile_code": "329-01-0001-0000001"
}
]
}
Cancelar protesto automático
Para solicitar essa instrução, o boleto precisa ser registrado com essa opção ativa.
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
}
]
}
Sustar protesto sem baixa
Para solicitar essa instrução, o boleto precisa ser estar protestado.
Request Body
{
"occurrences": [
{
"our_number": 1000000002,
"occurrence_type": "protest_cancel_request",
"requester_profile_code": "329-01-0001-0000001"
}
]
}
Cancelar protesto automático
Para solicitar essa instrução, o boleto precisa ser estar protestado.
Request Body
{
"occurrences": [
{
"our_number": 1000000002,
"occurrence_type": "protest_cancel_and_write_off_request",
"requester_profile_code": "329-01-0001-0000001"
}
]
}
Exemplo de response
A resposta varia de cada tipo de instrução, geralmente resultando na mudança dos campos de occurrence_stats, na chave de cada instrução.
Já no campo semantic_errors, é devolvido uma lista com objetos de cada ocorrência com seus respectivos erros (exemplo abaixo).
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
}
}
]
}