---
title: "Returns list of bnpl plan"
method: GET
path: "/bnpl"
tags: ["BNPL"]
---

# Returns list of bnpl plan

`GET /bnpl`

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

## Query parameters

- `start_date` string, date
- `end_date` string, date
- `status` 'opened' | 'started' | 'cancelled' | 'completed'
- `page_offset` integer
- `page_size` integer

## Headers

- `X-Amzn-Trace-Id` string

## Response `200`

returns list of BNPL.

- BNPLResponseObject[]
  - `id` string, uuid — Unique Identifier of the BNPL Response object
  - `reference` string — Optional. BNPL reference.
  - `amount` number, double — total order amount
  - `currency` string, required — currency associated to the amount.
  - `orderDetails` ItemObject[] — Optional. List of purchased items
    - `id` string, uuid — unique uuid of the product
    - `name` string — product name. A product can be a service
    - `reference` string — product reference
    - `price` number, double — product unit price
    - `quantity` number, double — quantity of this product purchased
    - `discount` number, double — discount percentage applied to product price and tax rate
    - `taxRate` number, double — tax rate in percentage added to product price
    - `totalPrice` number, double — total price including discount and tax
  - `deposit` number, double — Optional. if a partial payment is required at the time of purchase. If deposit is required, startDate must be in the futur.
  - `nbrInstallments` integer, required — Required. number of installments excluded deposit.
  - `installmentIntervalDays` integer — Number of days between two installments. Defaults to 30 if not specified.
  - `startDate` string, date, required — start date of the first installment. The startDate must be today date or in the futur.
  - `customerId` string, uuid, required — Required. Unique Id of the customer.
  - `customerMessage` string — 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'
  - `nextInstallmentDueDate` string, date — date of next installment due date. At 7h00 UTC at the date the request to pay link will be send to the customer
  - `nbrPaidInstallments` integer — number of already paid installments excluded deposit.
  - `nbrUnpaidInstallments` integer — number of unpaid installments since the beginning.
  - `customerName` string — Customer Name
  - `currentInstallmentStatus` 'succeeded' | 'failed' | 'cancelled' | 'pending' | 'processing' | 'reversed' | 'authorized' — status of the transaction
  - `createdAt` string — The merchant entity registration timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)
  - `updatedAt` string — updated timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)

## Other responses

- `400` — Bad Request
- `401` — The caller is not authenticated
- `403` — Access rights not sufficient
- `500` — Internal Server Error.

---

[API](https://skmtc.dev/bictorys/apis/pay.md) · [All operations](https://skmtc.dev/bictorys/apis/pay/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bictorys/pay/revisions/b85cce14340b/schema)