Gerar Boleto ou PIX para uma Parcela

Permite gerar um boleto bancário ou código PIX para o pagamento de uma parcela específica de uma operação de crédito.

Endpoint

Request

ENDPOINT

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

MÉTODO

POST

Parâmetros de Caminho

Parâmetro	Tipo	Descrição
DEBT-KEY	string	Chave identificadora da dívida
INSTALLMENT-KEY	string	Chave identificadora da parcela
PAYMENT-TYPE	string	Tipo de pagamento desejado bankslip (boleto) ou pix (qrcode pix)

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

Objeto Response Body

Campo	Tipo	Descrição
installment_key	string	Identificador único da parcela no formato UUID
due_date	string	Data de vencimento da parcela no formato YYYY-MM-DD
business_due_date	string	Data de vencimento da parcela em dia útil no formato YYYY-MM-DD
pre_fixed_amount	number	Valor dos juros
principal_amortization_amount	number	Valor do principal a ser amortizado
total_amount	number	Valor total da parcela (juros + principal)
bank_slip_key	string	Chave identificadora do boleto bancário
qr_code_key	string	Chave identificadora do QR code PIX
qr_code_url	string	URL para pagamento do QR code PIX
digitable_line	string	Linha digitável do boleto bancário