Get BNPL Offer
Get a BNPL offer for an invoice
Path parameters
invoiceId
Invoice ID or Invoice ForeignID
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
cadence
The payment cadence for the BNPL offer
Allowed values:
installmentsStartDate
The start date for installments in YYYY-MM-DD format
numberOfInstallments
The number of installments
paymentDayOfWeek
The day of the week for payments
downPaymentDueDate
The due date for the down payment in YYYY-MM-DD format
Response
This endpoint returns an object.
invoiceAmount
The total amount of the invoice in cents.
totalRepaymentAmount
Total amount to be repaid, including fees. In cents.
currency
The currency code for the amount
downPaymentAmount
The down payment amount in cents
numberOfPayments
The number of payments/installments
firstPaymentDate
The date of the first payment in YYYY-MM-DD format
finalPaymentDate
The date of the final payment in YYYY-MM-DD format
fees
The fees associated with the offer
installments
A list of all installments, including down payment.
paymentDayOfWeek
The day of the week for payments, e.g. "Wednesday"
installmentAmount
The amount for each regular installment. The last installment may have a different amount. In cents.
financeFeeRate
e.g. “1.5% per 28 days”
termsLink
A link to the terms and conditions for the offer