Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Payment Links

Get Payment Link

Retrieves the current state of a payment link, including its status, usage count, and configuration.

get/payment-links/v1/{payment_link_id}

Path parameters

payment_link_idstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Unique identifier of the payment link

Response

OK

idstring uuid required

The unique ID of this payment link. Use this to retrieve, update, or reference the link in other API calls.

linkstring uri required

The URL to share with your customer. Directing a customer to this URL begins the payment flow. Anyone with this URL can initiate a payment.

status'ACTIVE' | 'EXPIRED' | 'USED' | 'DISABLED' required

The lifecycle state of a payment link.

  • ACTIVE: The link is live and will accept payments. This is the initial state after creation.
  • EXPIRED: The link's expires_at time has passed. It can no longer accept payments and cannot be reactivated.
  • USED: The link has reached its max_usages limit. All permitted payments have been collected. Cannot be reactivated.
  • DISABLED: The link was manually disabled via the update endpoint. It can be re-enabled by setting status to ACTIVE.
current_usagesinteger required

The number of successful payments completed through this link. Increments each time a payer completes a payment. Compare with max_usages to understand remaining capacity.

namestring nullable

The label you provided when creating the link, if any. For display purposes only.

max_usagesinteger nullable

The maximum number of payments this link will accept before transitioning to USED status. Null indicates no limit.

expires_atstring date-time nullable

The expiry date and time for this link in ISO 8601 format. After this time the link cannot be used. Null means the link does not expire automatically.

redirect_urlstring uri required

The URL your customer is redirected to after completing or cancelling a payment.

customer_idstring uuid nullable

The ID of the customer associated with this link, if any. Payments through this link will be attributed to this customer.

Example response

{
  "payment_details": {
    "currency": "AED"
  }
}