Skip to main content
GET
/
payment-links
[
  {
    "id": "pl_z1urYtVFgEebtcj8fxp4v",
    "url": "https://pay.hub2.com/pl_z1urYtVFgEebtcj8fxp4v",
    "status": "active",
    "purchaseReference": "ORDER-12345",
    "amount": 1000,
    "currency": "XOF",
    "maximumPayments": 1,
    "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"
  }
]

Headers

​
ApiKey
string
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.

​
MerchantId
string
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
enum<string>
required

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

Available options:
live,
sandbox

Query Parameters

​
fromCreatedAt
string

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

Example:

"2024-01-15T00:00:00.000Z"

​
toCreatedAt
string

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

Example:

"2024-01-15T23:59:59.999Z"

​
fromExpirationDate
string

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

Example:

"2024-01-15T00:00:00.000Z"

​
toExpirationDate
string

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

Example:

"2024-01-15T23:59:59.999Z"

​
status
enum<string>

Filter by payment link status

Available options:
active,
expired,
closed,
completed
Example:

"active"

Response

​
id
string
required

Unique identifier for the payment link

Example:

"pl_z1urYtVFgEebtcj8fxp4v"

​
url
string
required

URL for the payment link

Example:

"https://pay.hub2.com/pl_z1urYtVFgEebtcj8fxp4v"

​
status
enum<string>
required

Current status of the payment link

Available options:
active,
expired,
closed,
completed
Example:

"active"

​
purchaseReference
string
required

Merchant reference for the payment

Example:

"ORDER-12345"

​
amount
number
required

Amount intended to be charged in the smallest currency unit

Example:

1000

​
currency
string
required

Three-letter ISO 4217 currency code

Example:

"XOF"

​
maximumPayments
number
required

Maximum number of successful payments allowed

Example:

1

​
maximumAttempts
number
required

Maximum number of failed payments allowed per user

Example:

3

​
createdAt
string
required

Creation date in ISO 8601 format

Example:

"2024-01-15T12:00:00.000Z"

​
updatedAt
string
required

Last update date in ISO 8601 format

Example:

"2024-01-15T12:30:00.000Z"

​
expirationDate
string
required

Expiration date in ISO 8601 format

Example:

"2024-01-15T14:30:00.000Z"

​
customerPhoneNumber
string
required

Restricted MSISDN

Example:

"123456789"

​
type
enum<string>
required

Type of the payment link

Available options:
single_use,
multi_use
Example:

"single_use"