Criar abatimento

Criar um abatimento para o boleto significa abater parte do valor base do título, para diminuir o valor final.

Atenção!

Caso exista algum pedido de abatimento pendente de confirmação, ou algum abatimento ativo, não é permitida a criação de um novo abatimento. Se houver algum abatimento ativo e for de interesse mudá-lo, primeiro deve ser enviada uma requisição de cancelamento de abatimento. Assim que a mesma for confirmada, é possível criar outro abatimento.

Obs.: o valor de abatimento (rebate_amount) enviado no registro do boleto não conta como um pedido de abatimento em aberto, mas conta como um pedido de abatimento ativo.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/rebate

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": "d66b807a-25fa-4e21-b198-9beb221a29ce",
  "rebate_amount": 150.00
}

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
rebate_amount *	float	Valor absoluto do abatimento	-

Response

STATUS

202

Response Body

{
  "occurrence_key": "7f01165b-fdd0-4f59-b231-42170ea90131",
  "bank_slip_key": "dad779c1-5e1c-422e-9f36-c704916a87cf"
}

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	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}).
409	BKS000030	Conflict	There is already a pending rebate occurrence for this bank slip.	Já existe uma ocorrência de rebate pendente para este boleto.
400	BKS000032	Bad Request	Bank slip must be in 'registered' status.	O boleto deve possuir o status 'registered'.
409	BKS000033	Conflict	This bank slip already has an active rebate. You must send a 'cancel_rebate' occurrence before trying to create another one. one.	Este boleto já possui um rebate ativo. Você deve mandar uma ocorrência do tipo 'cancel_rebate' antes de tentar criar outro.
400	BKS000045	Bad Request	Rebate amount can not be equal or greater than the bank slip amount.	O valor do rebate não pode ser igual ou maior do que o valor do boleto.