Desistência de protesto e baixa do boleto

Outra forma de desistir de um pedido de protesto é enviando uma instrução de protest_cancel_and_write_off_request.

Atenção!

A instrução de protest_cancel_and_write_off_request também baixa o boleto na CIP/Nuclea. Assim que ela é confirmada, é automaticamente criada uma ocorrência de write_off e a mesma é enviada para Nuclea.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/protest_cancel_and_write_off_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"
}

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

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	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'.
400	BKS000076	Bad Request	Bank slip must have an ongoing protest request.	O boleto deve ter um pedido de protesto em vigência.
400	BKS000077	Bad Request	Invalid bank slip protest status to cancel protest request.	Status de protesto do boleto inválido para desistir do pedido de protesto.

Desistência de protesto e baixa do boleto

Request​

Path parameters​

Request Body Params​

Response​

Response Body Params​

Error Response​