Skip to main content
POST
Verify a checkout ref

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
ref
string
required

The ref query parameter from the checkout URL.

Response

Ref resolved

status
string
Example:

"success"

data
object

Discriminated by type: link for a payment link, or payment for a direct payment.