API Reference Overview

Base URL

https://api.pcxpay.com/v1

Each PCX service owns a distinct URL namespace. The table below maps services to their path prefixes.

Service	Prefix	Description
Organizations	`/organizations`	Org lifecycle, KYB, members, rates
Payments	`/payments`	Initiate, confirm, and query payments
Transactions	`/transactions`	Transaction records and history
Beneficiaries	`/beneficiaries`	Saved payout recipients
Virtual Accounts	`/virtual-accounts`	Multi-currency account issuance
Exchange Rates	`/exchange-rates`	Rate queries and org-level rate configs
Payment Links	`/payment-links`	Shareable payment links
Notifications	`/notifications`	In-app notification management
Webhooks	`/webhooks`	Webhook endpoint management

All responses follow a consistent envelope:

{
  "status": "success" | "error",
  "message": "Human-readable message",
  "data": { }
}

Paginated responses include a last_evaluated_key for cursor-based pagination:

{
  "status": "success",
  "data": { "items": [...] },
  "last_evaluated_key": { "pk": "...", "sk": "..." }
}

Pass last_evaluated_key as a query parameter in the next request to fetch the next page.

HTTP Status	Meaning
`400`	Validation error — check request body
`401`	Missing or invalid auth token
`403`	Forbidden — insufficient permissions
`404`	Resource not found
`409`	Conflict — e.g. duplicate or already-revoked resource
`500`	Internal error — contact support if persistent