Skip to main content
GET
Get a payment link

Headers

Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Path Parameters

Response

Payment link object

org_id
string
email
string
amount
number<float> | null
currency
string | null
payer_currency
string | null
description
string | null
amount_type
string | null
status
enum<string>
Available options:
active,
expired,
completed
expires_at
string<date-time> | null
paid_at
string<date-time> | null
url
string<uri>
created_at
string<date-time>