Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Payment Links

List Payment Links

Retrieve a list of payment links with optional filtering

get/payment-links

Query parameters

fromCreatedAtstring
Example:2024-01-15T00:00:00.000Z

Filter by creation date from (ISO 8601) - inclusive start date

toCreatedAtstring
Example:2024-01-15T23:59:59.999Z

Filter by creation date to (ISO 8601) - inclusive end date

fromExpirationDatestring
Example:2024-01-15T00:00:00.000Z

Filter by expiration date from (ISO 8601) - inclusive start date

toExpirationDatestring
Example:2024-01-15T23:59:59.999Z

Filter by expiration date to (ISO 8601) - inclusive end date

status'active' | 'expired' | 'closed' | 'completed'
Example:active

Filter by payment link status

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

Unique identifier for the payment link

urlstring required

URL for the payment link

status'active' | 'expired' | 'closed' | 'completed' required

Current status of the payment link

purchaseReferencestring required

Merchant reference for the payment

amountobject nullable required

Amount intended to be charged in the smallest currency unit. Null when openAmount is true.

openAmountboolean

When true, the payer decides the amount at payment time.

minAmountnumber

Minimum amount the payer can enter (only when openAmount is true).

maxAmountnumber

Maximum amount the payer can enter (only when openAmount is true).

currencystring required

Three-letter ISO 4217 currency code

maximumPaymentsnumber

Maximum successful payments allowed (omitted when unlimited multi_use)

currentSuccessCountnumber required

Number of successful payments recorded for this link

maximumAttemptsnumber required

Maximum number of failed payments allowed per user

createdAtstring required

Creation date in ISO 8601 format

updatedAtstring required

Last update date in ISO 8601 format

expirationDatestring required

Expiration date in ISO 8601 format

customerPhoneNumberstring required

Restricted MSISDN

type'single_use' | 'multi_use' required

Type of the payment link

customerDataobject

Collected payer data as fieldName → value pairs. Absent when no customerFields are defined.

Example response

[
  {
    "id": "pl_z1urYtVFgEebtcj8fxp4v",
    "url": "https://pay.hub2.com/pl_z1urYtVFgEebtcj8fxp4v",
    "status": "active",
    "purchaseReference": "ORDER-12345",
    "minAmount": 500,
    "maxAmount": 100000,
    "currency": "XOF",
    "maximumPayments": 50,
    "maximumAttempts": 3,
    "createdAt": "2024-01-15T12:00:00.000Z",
    "updatedAt": "2024-01-15T12:30:00.000Z",
    "expirationDate": "2024-01-15T14:30:00.000Z",
    "customerPhoneNumber": "123456789",
    "type": "single_use",
    "customerFields": [
      {
        "fieldName": "national_id",
        "fieldLabel": "National ID"
      }
    ],
    "customerData": {
      "national_id": "AB123456"
    },
    "paymentAttempts": [
      {
        "id": "pay_QW2d6JnqiatcH8KhK0mD1",
        "intentId": "pi_z1urYtVFgEebtcj8fxp4v",
        "createdAt": "2020-10-15T12:09:49.355Z",
        "updatedAt": "2020-10-15T12:16:26.128Z",
        "status": "successful",
        "amount": 100,
        "currency": "XOF",
        "method": "mobile_money",
        "country": "CI",
        "fees": [
          {
            "id": "lAe5HnFpvOjwdT9vSIgPA",
            "amount": 5,
            "currency": "XOF"
          }
        ],
        "nextAction": {
          "data": {
            "method": "post"
          }
        },
        "paymentInformation": {
          "recipient_name_hashmac": "a1b2c3d4e5f6",
          "recipient_phone_hashmac": "a1b2c3d4e5f6",
          "customer_id_hashmac": "a1b2c3d4e5f6"
        }
      }
    ]
  }
]