Protest request

A protest request at a notary office can be made after the due date of the bank slip, and serves to have the payer notified to pay the instrument at the notary office. If they do not do so, a public record is made in their name of the default, in addition to having their name included in credit protection agencies, such as Serasa.

Attention!

To send a protest request, it is mandatory that the payer's address is present on the bank slip. If it is not, it is possible to send an instruction to edit the bank slip. Furthermore, if a bank slip is in the protest flow, sending a new request is not permitted.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/protest_request

METHOD

POST

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key, in uuid v4 format	36
requester_profile_key	uuidv4	Unique wallet identification key, in uuid v4 format	36
bank_slip_key	uuidv4	Unique bank slip identification key, in uuid v4 format	36

Request Body

{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f",
  "protest_type": "protest"
}

Request Body Params

Field	Type	Description	Characters
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format	36
protest_type *	string	Type of protest (common or bankruptcy)	Enumerators protest_type

Enumerators protest_type

Enumerator	Description
protest	Common protest
bankruptcy_protest	Bankruptcy protest

Response

STATUS

202

Response Body

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

Response Body Params

Field	Type	Description	Characters
occurrence_key *	uuidv4	Unique occurrence (instruction) identification key in uuid v4 format	36
bank_slip_key *	uuidv4	Unique bank slip identification key in uuid v4 format	36

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
400	QIT000001	Bad Request	Schema Error	Schema Inválido
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	Bad Request	It 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.
400	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada
409	BKS000014	Conflict	Request control key already sent or duplicated sent: <request_control_key>	Chave de controle da requisição já utilizada ou enviada duplicada: <request_control_key>
400	BKS000019	Bad Request	Payer address is required for protest.	Endereço do pagador é obrigatório para protesto.
400	BKS000022	Bad Request	Requester profile is not opened.	Carteira não está aberta.
404	BKS000028	Not Found	Notary office attended region not found for postal code: <postal_code>	Região de cartório não encontrada para o CEP: <postal_code>
404	BKS000029	Not Found	Bank slip not found for the given key ({bank_slip_key}).	Boleto não encontrado para a chave fornecida ({bank_slip_key}).
400	BKS000032	Bad Request	Bank slip must be in 'registered' status.	O boleto deve possuir o status 'registered'.
409	BKS000075	Conflict	An open protest request already exists for the given 'bank_slip_key'.	Já existe um pedido de protesto em aberto para a 'bank_slip_key' fornecida.
400	BKS000080	Bad Request	A protest request can only be sent after bank slip's business expiration date.	Um pedido de protesto só pode ser enviado após o dia útil de expiração do boleto.