Skip to main content
POST
/
payment-links
/
verify
Verify a payment link
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/payment-links/verify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "link_id": "<string>"
}
'
{
  "valid": true,
  "data": {
    "link_id": "<string>",
    "org_id": "<string>",
    "email": "<string>",
    "link_ref": "<string>",
    "amount": 123,
    "currency": "<string>",
    "payer_currency": "<string>",
    "description": "<string>",
    "amount_type": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

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"

Body

application/json

Response

200 - application/json

Verification result

valid
boolean
data
object