Skip to main content
POST
Initiate a checkout payment

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"

Path Parameters

identifier
string
required

The payment link's link_id, or a VA link's link_ref (values beginning PLV- are treated as a link_ref).

Body

application/json
payer_currency
string
required
payer_amount
number<float>
required
payment_method
string | null

Payment method chosen from the stage 1 payment_methods list (e.g. bank_transfer, card). Omit to get options.

target_amount
number<float> | null
org_rate_id
string | null
country
string | null

Payer's ISO 3166-1 alpha-2 country code.

Response

Payment options (stage 1) or initiation result (stage 2)

status
string
Example:

"success"

data
object

Stage 1: payer_currency, payer_amount, link_currency, payment_methods, payment_reference. Stage 2: the orchestrator's initiation result.