Rebate cancellation

Canceling a rebate means canceling the existing rebate for the bank slip. The cancellation must be performed if there is interest in removing the rebate or creating a new one.

Attention!

If there is any pending rebate cancellation request awaiting confirmation, or there is no active rebate, it is not possible to request the cancellation of a rebate.

Note: the rebate amount (rebate_amount) sent in the bank slip registration counts as an active rebate (if it is greater than R$0.00).

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/cancel_rebate

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": "86864aec-a6c8-462e-8460-b05ef5a1eb62"
}

Request Body Params

Field	Type	Description	Characters
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format	36

Response

STATUS

202

Response Body

{
  "occurrence_key": "539cefc8-382e-4fef-80e1-978a3a178a5c",
  "bank_slip_key": "d402e91a-32ac-4428-8357-d71824b113b5"
}

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	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	BKS000031	Bad Request	Bank slip must have an active rebate.	O boleto deve possuir um rebate ativo.
400	BKS000032	Bad Request	Bank slip must be in 'registered' status.	O boleto deve possuir o status 'registered'.
409	BKS000034	Bad Request	There is already a pending cancel rebate occurrence for this bank slip.	Já existe uma ocorrência de cancelamento de rebate pendente para este boleto.