利息

利息指令用于配置在截止日期后付款时应收取的利息。若相关 Boleto 已存在利息配置，且利息指令被接受，则原有配置将被覆盖。

注意！

若存在待确认的利息指令，则不允许发送新的指令。

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/interest

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": "c4dd443a-6e2f-4261-8f28-adfa4c0d4c5b",
  "interest_data": {
    "interest_type": "calendar_days_daily_amount",
    "interest_amount": 50.00,
    "days_to_interest": 5
  }
}

Request Body Params

字段	类型	描述	字符数
`request_control_key` *	uuidv4	客户使用的请求唯一识别密钥，格式为 uuid v4	36
`interest_data`	object	利息配置	interest_data 对象

interest_data 对象

选项 1：绝对值利息（interest_type=calendar_days_daily_amount 或 interest_type=workdays_daily_amount）

字段	类型	描述	字符数
`interest_type` *	string	利息类型	interest_type 枚举值
`interest_amount` *	float	按时间单位（工作日或自然日）收取的利息值	-
`days_to_interest` *	integer	到期后开始收取利息所需天数	-

选项 2：百分比利息（interest_type=calendar_days_monthly_percentage）

字段	类型	描述	字符数
`interest_type` *	string	利息类型	interest_type 枚举值
`interest_percentage` *	integer	按时间单位（工作日或自然日）收取的利息百分比	-
`days_to_interest` *	integer	到期后开始收取利息所需天数	-

interest_type 枚举值

枚举值	描述
calendar_days_daily_amount	按自然日计的每日金额
workdays_daily_amount	按工作日计的每日金额
calendar_days_monthly_percentage	按自然日计的月利率

Response

STATUS

202

Response Body

{
  "occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
  "bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}

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}`).
400	BKS000032	Bad Request	Bank slip must be in 'registered' status.	O boleto deve possuir o status 'registered'.
409	BKS000051	Conflict	There is already a pending interest occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.	Já existe uma ocorrência de juros pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.

Request​

路径参数​

Request Body Params​

interest_data 对象​

interest_type 枚举值​

Response​

Response Body Params​

错误响应​