---
title: "Returns list of payment links"
method: GET
path: "/paymentlinks"
tags: ["PaymentLinks"]
---

# Returns list of payment links

`GET /paymentlinks`

This API returns the list of payment links for a merchant.

## Query parameters

- `start_date` string, date
- `end_date` string, date
- `status` 'opened' | 'paid' | 'paid_in_cash'
- `device_id` string
- `page_offset` integer
- `page_size` integer

## Response `200`

returns list of payment links.

- PaymentLinkObject[]
  - union
    - object
      - `id` string, uuid — unique uuid of the payment link
      - `reference` string — payment link reference
      - `description` string — short description intended to the customer
      - `amount` number, double, required — Required. Amount to collect from customer
      - `currency` string, required — The currency in which the customer will be charged. Supported values: - XOF - EUR, USD (customer pay in EUR, USD, Merchant will be settled in XOF)
      - `dueDate` string, date — paymentlink due date
      - `status` 'opened' | 'paid' | 'paid_in_cash' | 'expired' — Payment link status
      - `paymentUrl` string — payment url. This url link is sent to the customer to allow him to pay the payment link.
      - `redirectUrlAfterPayment` string — Optional. Provide an url if you want to redirect customer after successful payment is done.
      - `enableMultiplePayment` boolean — By default, only one payment is authorized on each payment link. In case you want to allow multiple payment ( recurrent payment) on this link, set the value to true
      - `nbrPayments` integer — If enableMultiplePayment is set true, the syteme will count the number of success payments performed on this link. This field is ignored if enableMultiplePayment is set to false
      - `deviceId` string — Id of the device that has created the request.
      - `cashier` string — Optional. Identifier of the cashier (e.g. email, name, or sessionId). If not provided, the cashier email will be used by default.
      - `enableCardPaymentOnly` boolean — If you want allow the customer to pay only with bank card
      - `createdAt` string — The date time that record was created in our system.
      - `updatedAt` string — The date time that record was updated in our system.
      - `customerName` string — Optional. Name of the customer. is ignored.
      - `customerPhone` string — Customer phone number. This field must be used if you are making batch and want to notify customer by sms or whatsApp.
      - `customerEmail` string — Customer email. This field must be used if you are making a batch and want to notify customer by Email.
      - `customerLocale` string — User locale, language is lower case. Country in upper case
    - object
      - `id` string, uuid — unique uuid of the payment link
      - `reference` string — payment link reference
      - `description` string — short description intended to the customer
      - `amount` number, double, required — Required. Amount to collect from customer
      - `currency` string, required — The currency in which the customer will be charged. Supported values: - XOF - EUR, USD (customer pay in EUR, USD, Merchant will be settled in XOF)
      - `dueDate` string, date — paymentlink due date
      - `status` 'opened' | 'paid' | 'paid_in_cash' | 'expired' — Payment link status
      - `paymentUrl` string — payment url. This url link is sent to the customer to allow him to pay the payment link.
      - `redirectUrlAfterPayment` string — Optional. Provide an url if you want to redirect customer after successful payment is done.
      - `enableMultiplePayment` boolean — By default, only one payment is authorized on each payment link. In case you want to allow multiple payment ( recurrent payment) on this link, set the value to true
      - `nbrPayments` integer — If enableMultiplePayment is set true, the syteme will count the number of success payments performed on this link. This field is ignored if enableMultiplePayment is set to false
      - `deviceId` string — Id of the device that has created the request.
      - `cashier` string — Optional. Identifier of the cashier (e.g. email, name, or sessionId). If not provided, the cashier email will be used by default.
      - `enableCardPaymentOnly` boolean — If you want allow the customer to pay only with bank card
      - `createdAt` string — The date time that record was created in our system.
      - `updatedAt` string — The date time that record was updated in our system.
      - `customerId` string, uuid — unique identifier of the customer, recipient of the payment link

## 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)