invoice > bnpl

Get BNPL Offer

Get a BNPL offer for an invoice

post/invoice/{invoiceId}/bnpl/offer

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/invoice/{invoiceId}/bnpl/offer
  • Auth: HTTP bearer

Path parameters

invoiceIdstring required

Invoice ID or Invoice ForeignID

Request body

cadence'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' required
installmentsStartDatestring required

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

numberOfInstallmentsinteger required

The number of installments

paymentDayOfWeek'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' required
downPaymentDueDatestring required

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

Response

Response with status 200

invoiceAmountinteger required

The total amount of the invoice in cents.

totalRepaymentAmountinteger required

Total amount to be repaid, including fees. In cents.

currencystring required

The currency code for the amount

downPaymentAmountinteger required

The down payment amount in cents

numberOfPaymentsinteger required

The number of payments/installments

firstPaymentDatestring required

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

finalPaymentDatestring required

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

termsLinkstring

A link to the terms and conditions for the offer

paymentDayOfWeek'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' required
installmentAmountinteger required

The amount for each regular installment. The last installment may have a different amount. In cents.

financeFeeRatestring required

e.g. "1.5% per 28 days"

Changes

No recorded changes to this operation across all 1 revision of this API.