Fine

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

Attention!

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

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/fine

MÉTODO

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",
  "fine_data": {
    "fine_type": "absolute",
    "fine_amount": 50.00,
    "days_to_fine": 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	Fine configurations	fine_data Object

fine_data Object

Option 1: absolute value fine (fine_type=absolute)

Field	Type	Description	Characters
fine_type *	string	Fine type	fine_type Enumerators
fine_amount *	float	Absolute fine amount	-
days_to_fine *	integer	Days after due date for the fine to be charged	-

Option 2: percentage value fine (fine_type=percentage)

Field	Type	Description	Characters
fine_type *	string	Fine type	fine_type Enumerators
fine_percentage *	integer	Percentage fine amount, from 1 to 100	-
days_to_fine *	integer	Days after due date for the fine to be charged	-

fine_type Enumerators

Enumerator	Description
absolute	absolute value
percentage	percentage value

Response

STATUS

202

Response Body

{
  "occurrence_key": "aaf64135-6bd8-4d49-be6f-e8f884b20ee7",
  "bank_slip_key": "470cfcae-159b-4de4-ad22-2d3b2dd717f7"
}

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	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	BKS000050	Conflict	There is already a pending fine occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.	Já existe uma ocorrência de multa pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.