部分付款

部分付款指令允许修改票据的部分付款配置，前提是票据已登记且启用了部分付款功能。若票据已有部分付款配置，接受新指令后，原有配置将被覆盖。

注意！

若存在待确认的部分付款指令，则不允许发送新的指令。

Request

ENDPOINT

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

MÉTODO

POST

Path parameters

字段	类型	描述	字符数
account_key	uuidv4	账户唯一标识键，uuid v4 格式	36
requester_profile_key	uuidv4	钱包唯一标识键，uuid v4 格式	36
bank_slip_key	uuidv4	票据唯一标识键，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

字段	类型	描述	字符数
request_control_key *	uuidv4	客户使用的请求唯一标识键，uuid v4 格式	36
partial_payment_data *	object	部分付款配置	Objeto partial_payment_data

Objeto partial_payment_data

字段	类型	描述	字符数
partial_payment_minimum_type *	string	部分付款最小金额类型	Enumeradores partial_payment_type
partial_payment_minimum_percentage	float	部分付款允许的最小百分比	-
partial_payment_minimum_amount	float	部分付款允许的最小金额	-
partial_payment_maximum_type	string	部分付款最大金额类型	Enumeradores partial_payment_type
partial_payment_maximum_percentage	float	部分付款允许的最大百分比	-
partial_payment_maximum_amount	float	部分付款允许的最大金额	-
partial_payment_quantity *	integer	允许的部分付款次数	-

注意！

根据 partial_payment_minimum_type 和 partial_payment_maximum_type 字段的值，需要相应发送 partial_payment_minimum_amount 或 partial_payment_minimum_percentage，以及 partial_payment_maximum_amount 或 partial_payment_maximum_percentage。

Enumeradores partial_payment_type

枚举值	描述
absolute	绝对值
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	票据唯一标识键，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": {}
}

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	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.