Pagamento Parcial

A instrução de pagamento parcial permite editar as configurações de pagamento parcial para um boleto, desde que o boleto já tenha sido registrado com o pagamento parcial ativo. Caso já exista uma configuração de pagamento parcial para o boleto em questão, e seja aceita uma nova instrução, a configuração existente previamente será sobrescrita.

Atenção!

Caso exista alguma instrução de pagamento parcial pendente de confirmação, não é permitido o envio de uma nova instrução.

Request

ENDPOINT

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

MÉTODO

POST

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta, no formato uuid v4	36
requester_profile_key	uuidv4	Chave única de identificação da carteira, no formato uuid v4	36
bank_slip_key	uuidv4	Chave única de identificação do boleto, no formato uuid v4	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

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4	36
partial_payment_data *	object	Configurações de pagamento parcial	Objeto partial_payment_data

Objeto partial_payment_data

Campo	Tipo	Descrição	Caracteres
partial_payment_minimum_type *	string	Tipo de valor mínimo para pagamento parcial	Enumeradores partial_payment_type
partial_payment_minimum_percentage	float	Percentual mínimo permitido para o pagamento parcial	-
partial_payment_minimum_amount	float	Valor mínimo permitido para o pagamento parcial	-
partial_payment_maximum_type	string	Tipo de valor máximo para pagamento parcial	Enumeradores partial_payment_type
partial_payment_maximum_percentage	float	Percentual máximo permitido para o pagamento parcial	-
partial_payment_maximum_amount	float	Valor máximo permitido para o pagamento parcial	-
partial_payment_quantity *	integer	Quantidade de pagamentos parciais permitidos	-

Atenção!

De acordo com o valor enviado nos campos partial_payment_minimum_type e partial_payment_maximum_type, é necessário enviar o partial_payment_minimum_amount ou partial_payment_minimum_percentage, e o partial_payment_maximum_amount ou partial_payment_maximum_percentage correspondente.

Enumeradores partial_payment_type

Enumerador	Descrição
absolute	Valor absoluto
percentage	Percentual

Response

STATUS

202

Response Body

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

Response Body Params

Campo	Tipo	Descrição	Caracteres
occurrence_key *	uuidv4	Chave única de identificação da ocorrência (instrução) no formato uuid v4	36
bank_slip_key *	uuidv4	Chave única de identificação do boleto no formato uuid v4	36

Error Response

STATUS

4xx

Response Body: Error

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

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (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.