API ReferenceInvoiceBnpl

Get BNPL Offer

Get a BNPL offer for an invoice

Path parameters

invoiceIdstringRequired
Invoice ID or Invoice ForeignID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
cadenceenumRequired
The payment cadence for the BNPL offer
Allowed values:
installmentsStartDatestringRequired

The start date for installments in YYYY-MM-DD format

numberOfInstallmentsintegerRequired
The number of installments
paymentDayOfWeekenumRequired
The day of the week for payments
downPaymentDueDatestringRequired

The due date for the down payment in YYYY-MM-DD format

Response

This endpoint returns an object.
invoiceAmountinteger
The total amount of the invoice in cents.
totalRepaymentAmountinteger
Total amount to be repaid, including fees. In cents.
currencystring
The currency code for the amount
downPaymentAmountinteger
The down payment amount in cents
numberOfPaymentsinteger

The number of payments/installments

firstPaymentDatestring

The date of the first payment in YYYY-MM-DD format

finalPaymentDatestring

The date of the final payment in YYYY-MM-DD format

feesobject
The fees associated with the offer
installmentslist of objects
A list of all installments, including down payment.
paymentDayOfWeekenum
The day of the week for payments, e.g. "Wednesday"
installmentAmountinteger
The amount for each regular installment. The last installment may have a different amount. In cents.
financeFeeRatestring

e.g. “1.5% per 28 days”

Errors