Partial Payment

The partial payment instruction allows editing partial payment configurations for a bank slip, as long as the bank slip has already been registered with partial payment active. If there is already a partial payment configuration for the bank slip in question, and a new instruction is accepted, the previously existing configuration will be overwritten.

Attention!

If there is any partial payment instruction pending confirmation, it is not allowed to send a new instruction.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/partial_payment

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": "01234567-89ab-cdef-0123-456789abcdef",
    "partial_payment_data": {
        "partial_payment_minimum_type": "absolute",
        "partial_payment_minimum_amount": 50.00,
        "partial_payment_maximum_type": "absolute",
        "partial_payment_maximum_amount": 1000.00,
        "partial_payment_quantity": 3
    }
}

Request Body Params

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

partial_payment_data Object

Field	Type	Description	Characters
partial_payment_minimum_type *	string	Minimum value type for partial payment	partial_payment_type Enumerators
partial_payment_minimum_percentage	float	Minimum percentage allowed for partial payment	-
partial_payment_minimum_amount	float	Minimum amount allowed for partial payment	-
partial_payment_maximum_type	string	Maximum value type for partial payment	partial_payment_type Enumerators
partial_payment_maximum_percentage	float	Maximum percentage allowed for partial payment	-
partial_payment_maximum_amount	float	Maximum amount allowed for partial payment	-
partial_payment_quantity *	integer	Number of partial payments allowed	-

Attention!

According to the value sent in the partial_payment_minimum_type and partial_payment_maximum_type fields, it is necessary to send the corresponding partial_payment_minimum_amount or partial_payment_minimum_percentage, and the partial_payment_maximum_amount or partial_payment_maximum_percentage.

partial_payment_type Enumerators

Enumerator	Description
absolute	Absolute value
percentage	Percentage

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 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	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	BKS000126	Conflict	There is already a pending partial payment occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.	Já existe uma ocorrência de pagamento parcial pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.
400	BKS000127	Bad Request	Partial payment data is not set for this bank slip.	Os dados de pagamento parcial não estão configurados para este boleto.