Get Payment Link
Retrieve details about a specific payment link
GET
Get Payment Link
Get Payment Link
Retrieve information about a payment link, including its current status and payment details.Authentication
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Payment link ID (e.g., plink_abc123xyz) |
Response
All monetary amounts are integers in cents (e.g., 4995 = $49.95).
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique payment link identifier |
url | string | Checkout URL for the payment link |
amount | integer | Total amount in cents |
status | enum | active, paid, expired, or cancelled |
order | object | Associated order (present when status is paid) |
order.id | string | Order ID |
order.status | enum | Order status |
order.paid_at | timestamp | When payment was completed |
paid_at | timestamp | When link was paid (null if not paid) |
Example
Payment Link Status
| Status | Description |
|---|---|
active | Link is ready to accept payment |
paid | Payment completed, order created |
expired | Link expired without payment |
cancelled | Link was manually cancelled |
Errors
| Status Code | Error Code | Description |
|---|---|---|
| 401 | unauthorized | Invalid or missing API key |
| 404 | not_found | Payment link not found |
Related
Get Payment Link
