Interest

The interest instruction is used to configure the interest that will be applied if the bank slip is paid after the due date. If there is already an interest configuration for the bank slip in question, and an interest instruction is accepted, the previously existing configuration will be overwritten.

Attention!

If there is any pending interest instruction awaiting confirmation, sending a new instruction is not allowed.

Request

ENDPOINT

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

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

Request Body Params

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

interest_data Object

Option 1: interest using absolute values (interest_type=calendar_days_daily_amount or interest_type=workdays_daily_amount)

Field	Type	Description	Characters
interest_type *	string	Interest type	interest_type Enumerators
interest_amount *	float	Amount to be charged per determined time unit (working days or calendar days)	-
days_to_interest *	integer	Days after due date for interest to start being charged	-

Option 2: interest using percentage values (interest_type=calendar_days_monthly_percentage)

Field	Type	Description	Characters
interest_type *	string	Interest type	interest_type Enumerators
interest_percentage *	integer	Percentage to be charged per determined time unit (working days or calendar days)	-
days_to_interest *	integer	Days after due date for interest to start being charged	-

interest_type Enumerators

Enumerator	Description
calendar_days_daily_amount	Daily amount on calendar days
workdays_daily_amount	Daily amount on working days
calendar_days_monthly_percentage	Monthly interest percentage charged based on calendar days

Response

STATUS

202

Response Body

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

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 Status 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	BKS000018	Bad Request	The discount dates must be less than the expiration date and increasing.	A data dos descontos devem ser menores que a de expiração e crescentes.
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.