v1

latestOpenAPI 3.0.32026-07-248257161.1 KB

PaymentLinks

Returns list of payment links

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

get/paymentlinks

Query parameters

start_datestring date

Example:2023-05-22

Query payment links 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 payment links 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' | 'paid' | 'paid_in_cash'

Filter by payment link status. The status filter is combined with start_date and end_date filters. When filtering by opened status, payment link with due date in the past are shown expired

device_idstring

Filter by payment link by device_id. The status filter is combined with start_date and end_date filters.Cannot be used with status filter

page_offsetinteger

pagination offset, default is 0.

page_sizeinteger

Page size. default value is 20

Response

returns list of payment links.

Example response

[
  {
    "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "reference": "3245GOF456",
    "description": "Kindly process to the payment of the october bill",
    "amount": 5000,
    "currency": "XOF",
    "dueDate": "2024-04-24",
    "status": "paid",
    "paymentUrl": "https://api.bictorys.com/invoice-management/pay/437bbc50a7a58e5660ad?op_token=167bbc50a7a58e5660ad",
    "redirectUrlAfterPayment": "https://merchant-online-store",
    "enableMultiplePayment": true,
    "nbrPayments": 5,
    "deviceId": "ftui-mmmst",
    "cashier": "cashier1@company.com",
    "enableCardPaymentOnly": true,
    "createdAt": "2022-06-20T17:17:11Z",
    "updatedAt": "2022-06-20T17:17:11Z",
    "customerName": "Fatou Diop",
    "customerEmail": "fatou.diop@example.com",
    "customerLocale": "fr-SN"
  }
]