Skip to content
Developers

REST API, JavaScript SDK, webhooks and realtime events working as one platform. Amounts in paise. Idempotent writes. Test and live fully separated.

checkout.html
1<script src="https://cdn.payxa.example/v1/checkout.js"></script>
2<button id="pay-button">Pay with PayXa</button>
3
4<script>
5 document.getElementById("pay-button").addEventListener("click", async () => {
6 // Your backend verifies the price and creates the session
7 const res = await fetch("/api/create-checkout", { method: "POST" });
8 if (!res.ok) return alert("Checkout unavailable");
9 const { sessionToken } = await res.json();
10
11 PayXaCheckout.open({
12 sessionToken,
13 onEvent: (event) => {
14 // Display updates only. Never fulfil from the browser.
15 console.log(event.type);
16 },
17 });
18 });
19</script>
Script output
  1. $ listening for checkout events…
API reference

Proposed v1 surface. Base URL and SDK names are placeholders until launch.

POST/v1/ordersCreate an order
GET/v1/orders/{id}Fetch an order
POST/v1/checkout-sessionsStart a checkout session
GET/v1/checkout-sessions/{id}Session status
GET/v1/payments/{id}Payment with evidence timeline
GET/v1/transactionsList transactions
POST/v1/payment-linksCreate a payment link
POST/v1/webhook-endpointsRegister a webhook endpoint
GET/v1/webhook-deliveriesDelivery log
GET/v1/devicesPaired merchant devices
POST/v1/devices/pairPair a device
GET/v1/reconciliationReview queue
Webhooks

Enable product delivery, course access or account credit only after a verified webhook or an independently fetched verified state.

payment.verified · sample payload
{
  "id": "evt_example_1001",
  "type": "payment.verified",
  "created_at": "2026-11-20T14:00:00Z",
  "data": {
    "merchant_id": "merch_example_01",
    "order_id": "ORDER-1001",
    "payment_id": "pay_example_01",
    "amount": 49900,
    "currency": "INR",
    "status": "PAYMENT_VERIFIED",
    "verification_source": "BANK_PSP"
  }
}
Event types
  • checkout.startedA customer opened a new checkout session
  • checkout.expiredThe session expired without verified payment
  • payment.detectedCredit evidence arrived and matched an order
  • payment.verifyingWaiting on trusted bank/PSP confirmation
  • payment.verifiedTrusted confirmation received. Safe to fulfil
  • payment.needs_reviewConflict or ambiguity needs a human
  • payment.late_detectedPayment arrived after the session expired
  • payment.reconciliation_updatedA review case changed state
  • device.offlineA paired merchant device stopped syncing
HMAC-SHA256 signature Timestamp verification Delivery ID and event ID Replay protection Idempotent processing Retry with exponential backoff Dead-letter queue Manual replay for failed delivery Endpoint secret rotation Webhook testing dashboard
Test mode

Sandbox

Run checkouts, detections, verifications, late payments and same-amount conflicts end to end. Trigger any webhook from the dashboard webhook tester. No real money ever moves.

Keys look like pxa_test_…
Live mode

Production

Unlocked after business verification, receiving-account ownership checks, device diagnostics and the applicable partner and legal reviews.

Keys look like pxa_live_…
Integration ecosystem

What is planned for V1 and what is on the roadmap are kept clearly separate. We do not call anything ready before it is.

V1 · In development Core
REST API
Orders, sessions, payments
JavaScript SDK
Open checkout, live states
Webhooks
Signed, retried, replayable
Realtime API
SSE / WebSocket updates
Hosted Checkout
No frontend code needed
Payment Links
Share anywhere
Planned · Roadmap
WooCommerce pluginV2
Android SDKV2
Flutter SDKV2

Roadmap items are not available yet. Timelines may change.

Get started

Join the sandbox today. Build your integration while we complete partner and compliance reviews for live payments.