Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Logo
Sign inBook a demo
API ReferenceInvoiceBnpl

Get BNPL Offer

POST
https://api.mercoa.com/invoice/:invoiceId/bnpl/offer
POST
/invoice/:invoiceId/bnpl/offer
1curl -X POST https://api.mercoa.com/invoice/in_286a1849-2e3c-48a4-ab5a-8b7940cc3a5b/bnpl/offer \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "cadence": "WEEKLY",
6  "installmentsStartDate": "2025-06-18",
7  "numberOfInstallments": 4,
8  "paymentDayOfWeek": "WEDNESDAY",
9  "downPaymentDueDate": "2025-06-11"
10}'
Try it
200Get BNPL Offer
1{
2  "invoiceAmount": 120000,
3  "totalRepaymentAmount": 121687,
4  "currency": "USD",
5  "downPaymentAmount": 12000,
6  "numberOfPayments": 5,
7  "firstPaymentDate": "2025-06-18",
8  "finalPaymentDate": "2025-07-28",
9  "fees": {
10    "baseFeeAmount": 1687,
11    "baseFeePercentage": 1.4058
12  },
13  "installments": [
14    {
15      "number": 0,
16      "dueDate": "2025-06-18",
17      "amount": 12000,
18      "type": "DOWN_PAYMENT"
19    },
20    {
21      "number": 1,
22      "dueDate": "2025-07-02",
23      "amount": 27422,
24      "type": "REGULAR"
25    },
26    {
27      "number": 2,
28      "dueDate": "2025-07-09",
29      "amount": 27422,
30      "type": "REGULAR"
31    },
32    {
33      "number": 3,
34      "dueDate": "2025-07-16",
35      "amount": 27422,
36      "type": "REGULAR"
37    },
38    {
39      "number": 4,
40      "dueDate": "2025-07-23",
41      "amount": 27421,
42      "type": "REGULAR"
43    }
44  ],
45  "paymentDayOfWeek": "WEDNESDAY",
46  "installmentAmount": 27422,
47  "financeFeeRate": "1.4% per 28 days",
48  "termsLink": "https://dashboard-stg.oatfi.com/terms/6858b8b7e09d9a0057d82e65"
49}
Get a BNPL offer for an invoice
Was this page helpful?
Previous

Get BNPL Loan

Next
Built with
Get BNPL Loan
Get a BNPL offer for an invoice

Authentication

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

Path parameters

invoiceIdstringRequired
Invoice ID or Invoice ForeignID

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"
termsLinkstring or null
A link to the terms and conditions for the offer

Errors

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

The number of payments/installments

e.g. “1.5% per 28 days”

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

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

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

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