创建折让

为 Boleto 创建折让意味着从票据基础金额中扣除部分金额，以减少最终付款金额。

注意！

若存在待确认的折让申请或已有活跃的折让，则不允许创建新的折让。若有活跃折让且需要修改，必须先发送取消折让的请求。待确认后，方可创建另一个折让。

注意： 在 Boleto 登记时发送的折让金额（rebate_amount）不算作待处理的折让申请，但算作活跃的折让申请。

Request

ENDPOINT

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

MÉTODO

POST

路径参数

字段	类型	描述	字符数
account_key	uuidv4	账户唯一识别密钥，格式为 uuid v4	36
requester_profile_key	uuidv4	钱包唯一识别密钥，格式为 uuid v4	36
bank_slip_key	uuidv4	Boleto 唯一识别密钥，格式为 uuid v4	36

Request Body

{
  "request_control_key": "d66b807a-25fa-4e21-b198-9beb221a29ce",
  "rebate_amount": 150.00
}

Request Body Params

字段	类型	描述	字符数
request_control_key *	uuidv4	客户使用的请求唯一识别密钥，格式为 uuid v4	36
rebate_amount *	float	折让绝对金额	-

Response

STATUS

202

Response Body

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

Response Body Params

字段	类型	描述	字符数
occurrence_key *	uuidv4	事件（指令）唯一识别密钥，格式为 uuid v4	36
bank_slip_key *	uuidv4	Boleto 唯一识别密钥，格式为 uuid v4	36

错误响应

STATUS

4xx

Response Body: 错误

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

HTTP 代码 status	QI 代码 code	标题 title	英文描述 description	葡语描述 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.	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.