跳到主要内容

为分期付款生成 Boleto 或 PIX

允许为信贷操作的特定分期生成银行 Boleto 或 PIX 付款码。

付款方式替换

如果该分期已有有效的 Boleto/PIX 用于付款,该 Boleto/PIX 将被停用并由新的付款方式替换。

端点

请求

ENDPOINT
/debt/DEBT-KEY/installment/INSTALLMENT-KEY/PAYMENT-TYPE
MÉTODO
POST

路径参数

参数类型描述
DEBT-KEYstring债务的标识密钥
INSTALLMENT-KEYstring分期的标识密钥
PAYMENT-TYPEstring所需付款类型:bankslip(Boleto)或 pix(PIX QR Code)
请求体
{}

响应

响应体
{
"installment_key": "installment_key",
"due_date": "2022-09-08",
"business_due_date": "2022-09-09",
"pre_fixed_amount": 70.0,
"principal_amortization_amount": 1000.0,
"total_amount": 1070.0,
"bank_slip_key": "bank_slip_key",
"qr_code_key": "qr_code_key",
"qr_code_url": "qr_code_url",
"digitable_line": "digitable_line"
}

响应体对象

字段类型描述
installment_keystringUUID 格式的分期唯一标识符
due_datestring分期到期日,格式为 YYYY-MM-DD
business_due_datestring分期工作日到期日,格式为 YYYY-MM-DD
pre_fixed_amountnumber利息金额
principal_amortization_amountnumber待摊还的本金金额
total_amountnumber分期总金额(利息 + 本金)
bank_slip_keystring银行 Boleto 的标识密钥
qr_code_keystringPIX QR Code 的标识密钥
qr_code_urlstringPIX QR Code 付款 URL
digitable_linestring银行 Boleto 的可输入行