Skip to main content
POST
Create a VA payment link

Headers

Authorization
enum<string>
default:NONE
required

Reserved for PCX-managed applications. External API integrations must always send the literal string NONE — this is the only accepted value.

Available options:
NONE
Example:

"NONE"

X-Api-Key
string
default:NONE
required

Your API key. This is the only supported credential.

Example:

"pcx_abc123_xxxx"

Body

application/json
virtual_account_id
string
required
payer_email
string<email>
required
amount_type
enum<string>
required
Available options:
fixed,
flexible
payment_amount
number<float> | null

Required when amount_type is fixed.

description
string | null

Response

VA payment link created

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>