Generate Bank Slip or PIX for an Installment

Allows you to generate a bank slip or PIX code for the payment of a specific installment of a credit operation.

Endpoint

Request

ENDPOINT

/debt/DEBT-KEY/installment/INSTALLMENT-KEY/PAYMENT-TYPE

METHOD

POST

Path Parameters

Parameter	Type	Description
DEBT-KEY	string	Debt identifier key
INSTALLMENT-KEY	string	Installment identifier key
PAYMENT-TYPE	string	Desired payment type: bankslip (Bank Slip) or pix (PIX QR code)

Request Body

{}

Response

Response Body

{
  "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"
}

Response Body Object

Field	Type	Description
installment_key	string	Unique identifier of the installment in UUID format
due_date	string	Installment due date in YYYY-MM-DD format
business_due_date	string	Installment due date on a business day in YYYY-MM-DD format
pre_fixed_amount	number	Interest amount
principal_amortization_amount	number	Principal amount to be amortized
total_amount	number	Total installment amount (interest + principal)
bank_slip_key	string	Bank slip identifier key
qr_code_key	string	PIX QR code identifier key
qr_code_url	string	URL for PIX QR code payment
digitable_line	string	Bank slip digitable line