Skip to main content
PATCH
cURL

Path Parameters

id
string
required

Payment link ID

Example:

"pl_z1urYtVFgEebtcj8fxp4v"

Response

Payment link closed successfully

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
object | null
required

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

Example:

1000

currency
string
required

Three-letter ISO 4217 currency code

Example:

"XOF"

currentSuccessCount
number
required

Number of successful payments recorded for this link

Example:

0

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"

openAmount
boolean

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

Example:

false

minAmount
number

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

Example:

500

maxAmount
number

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

Example:

100000

maximumPayments
number

Maximum successful payments allowed (omitted when unlimited multi_use)

Example:

50

customerFields
object[]

Custom form fields defined on this payment link. Absent when the link has no customer fields.