Pedido de protesto

Um pedido de protesto em cartório pode ser feito após a data de vencimento do boleto, e serve para fazer com que o pagador seja intimado a pagar o título em cartório. Caso não o faça, é feito um registro público, em seu nome, da inadimplência, além de ter seu nome incluído em órgãos de proteção ao crédito, como a Serasa.

Atenção!

Para enviar um pedido de proteso, é obrigatório que o endereço do pagador esteja presente no boleto. Caso não esteja, é possível enviar uma instrução de edição do boleto. Ademais, caso exista um boleto esteja em fluxo de protesto, não é permitido o envio de um novo pedido.

Request

ENDPOINT

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

MÉTODO

POST

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta, no formato uuid v4	36
requester_profile_key	uuidv4	Chave única de identificação da carteira, no formato uuid v4	36
bank_slip_key	uuidv4	Chave única de identificação do boleto, no formato uuid v4	36

Request Body

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

Request Body Params

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4	36
protest_type *	string	Tipo de protesto (comum ou falimentar)	Enumeradores protest_type

Enumeradores protest_type

Enumerador	Descrição
protest	Protesto comum
bankruptcy_protest	Protesto falimentar

Response

STATUS

202

Response Body

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

Response Body Params

Campo	Tipo	Descrição	Caracteres
occurrence_key *	uuidv4	Chave única de identificação da ocorrência (instrução) no formato uuid v4	36
bank_slip_key *	uuidv4	Chave única de identificação do boleto no formato uuid v4	36

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (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.