Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
payment links

Returns details of a payment link

This API returns details of a payment link.

get/paymentlinks/{paymentLinkId}

Path parameters

paymentLinkIdstring uuid required

Unique identifier of the payment link.

Response

Returns details of a payment link.

OR

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"
}