Skip to main content

Protest Removal

If the dispute between the payer and drawer guarantor is resolved after the bank slip has already been protested, it is possible to send an instruction of type protest_remove_request, which removes the public record of default and any record, linked to this bank slip, that has tainted the payer's name.

Attention!

If the occurrence is confirmed (accepted by the notary office), the protest is removed and no further instructions are created for this bank slip, since it is already settled in CIP/Nuclea.

Request

ENDPOINT
/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/protest_remove_request
METHOD
POST

Path parameters

FieldTypeDescriptionCharacters
account_keyuuidv4Unique account identification key, in uuid v4 format36
requester_profile_keyuuidv4Unique wallet identification key, in uuid v4 format36
bank_slip_keyuuidv4Unique bank slip identification key, in uuid v4 format36
Request Body
{
"request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}

Request Body Params

FieldTypeDescriptionCharacters
request_control_key *uuidv4Unique request identification key used by the client in uuid v4 format36

Response

STATUS
202
Response Body
{
"occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
"bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}

Response Body Params

FieldTypeDescriptionCharacters
occurrence_key *uuidv4Unique occurrence (instruction) identification key in uuid v4 format36
bank_slip_key *uuidv4Unique bank slip identification key in uuid v4 format36

Error Response

STATUS
4xx
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
HTTP Code
status
QI Code
code
Title
title
Description (eng)
description
Description (pt-br)
translation
400QIT000001Bad RequestSchema ErrorSchema Inválido
404BKS000006Not FoundThe source account key was not found.A chave da conta de origem não foi encontrada.
400BKS000007Bad RequestIt was not possible to consult the source account at this time. Please try again in a few minutes.Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400BKS000008Bad RequestThe source account is closed.A conta de origem está fechada.
400BKS000009Bad RequestThe source account is blocked.A conta de origem está bloqueada.
404BKS000013Not FoundRequester profile not foundCarteira não encontrada
409BKS000014ConflictRequest control key already sent or duplicated sent: <request_control_key>Chave de controle da requisição já utilizada ou enviada duplicada: <request_control_key>
400BKS000019Bad RequestPayer address is required for protest.Endereço do pagador é obrigatório para protesto.
400BKS000022Bad RequestRequester profile is not opened.Carteira não está aberta.
404BKS000029Not FoundBank slip not found for the given key ({bank_slip_key}).Boleto não encontrado para a chave fornecida ({bank_slip_key}).
400BKS000032Bad RequestBank slip must be in 'registered' status.O boleto deve possuir o status 'registered'.
400BKS000076Bad RequestBank slip must have an ongoing protest request.O boleto deve ter um pedido de protesto em vigência.
400BKS000078Bad RequestBank slip's protest_status must be 'protested' to send a protest remove request.Status de protesto (protest_status) do boleto deve ser 'protested' para enviar um pedido de remoção de protesto.