Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
BNPL

Returns list of bnpl plan

This API returns the list of bnpl plan for a merchant.

get/bnpl

Query parameters

start_datestring date
Example:2023-05-22

Query bnpl starting from this date. The date format is (YYYY-mm-dd). If omitted, 2023-09-01 is used

end_datestring date
Example:2023-05-24

Query bnpl from start_date until this date time. The date format is YYYY-mm-dd. If end_date is omitted, current date is used.

status'opened' | 'started' | 'cancelled' | 'completed'

Filter by BNPL status. The status filter is combined with start_date and end_date filters. When filtering by opened status. Status opened means the BNPL plan is created but no payment is done. started means at least a payment is done but not the entire amount.

page_offsetinteger

pagination offset, default is 0.

page_sizeinteger

Page size. default value is 20

Headers

X-Amzn-Trace-Idstring

HTTP request identifier allow to trace individual request sent from client to service.

Response

returns list of BNPL.

idstring uuid

Unique Identifier of the BNPL Response object

referencestring

Optional. BNPL reference.

amountnumber double

total order amount

currencystring required

currency associated to the amount.

depositnumber double

Optional. if a partial payment is required at the time of purchase. If deposit is required, startDate must be in the futur.

nbrInstallmentsinteger required

Required. number of installments excluded deposit.

installmentIntervalDaysinteger

Number of days between two installments. Defaults to 30 if not specified.

startDatestring date required

start date of the first installment. The startDate must be today date or in the futur.

customerIdstring uuid required

Required. Unique Id of the customer.

customerMessagestring

Message intended to customer for installment payment. The message is sent to the customer with the payment link at every occurence. Do no add customer name or grettings in the message.

notificationChannel'email' | 'sms' | 'whatsApp' | 'none'

By which means the payment link will be send to the customer

status'opened' | 'started' | 'cancelled' | 'completed'
nextInstallmentDueDatestring date

date of next installment due date. At 7h00 UTC at the date the request to pay link will be send to the customer

nbrPaidInstallmentsinteger

number of already paid installments excluded deposit.

nbrUnpaidInstallmentsinteger

number of unpaid installments since the beginning.

customerNamestring

Customer Name

currentInstallmentStatus'succeeded' | 'failed' | 'cancelled' | 'pending' | 'processing' | 'reversed' | 'authorized'

status of the transaction

createdAtstring

The merchant entity registration timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)

updatedAtstring

updated timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)

Example response

[
  {
    "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "reference": "yourOrder_CF34509",
    "amount": 100000,
    "currency": "XOF",
    "orderDetails": [
      {
        "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
        "name": "pineapple",
        "reference": "SKU56789002",
        "price": 100,
        "quantity": 2.5,
        "discount": 20,
        "taxRate": 5.5,
        "totalPrice": 125
      }
    ],
    "deposit": 15000,
    "nbrInstallments": 3,
    "installmentIntervalDays": 7,
    "startDate": "2023-05-22",
    "customerId": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "customerMessage": "Please on the link below to pay your installement from mycompany? Ref order is Order_XFG567",
    "status": "completed",
    "nextInstallmentDueDate": "2023-05-22",
    "nbrPaidInstallments": 2,
    "nbrUnpaidInstallments": 1,
    "customerName": "John Dao",
    "createdAt": "2022-03-29 10:00:00,000"
  }
]