Skip to content

Packages

Prepaid credit bundles you can sell on behalf of a customer, then optionally consume at confirm (use_package_credit: true).

Auth: x-api-key. idempotency_key is required on purchase.

Purchase

http
POST /api/v1/packages/{packageId}/purchase
Content-Type: application/json
x-api-key: <your-api-key>

{
  "customer_phone": "9876543210",
  "payment_method": "upi",
  "idempotency_key": "pkg-9f2a-…"
}

201: { "purchase": { "id", "package_id", "customer_phone", "credits_remaining", … } }.

Same key, same package and customer → original purchase, no extra credits. Same key, different customer or package → 409.

Sandbox package id: a0000000-0000-4000-8000-000000000003 (discover in your own catalogue the same way you will in production).

Get a purchase

http
GET /api/v1/packages/purchases/{purchaseId}
x-api-key: <your-api-key>

Active purchases

http
GET /api/v1/packages/active?customer_phone=9876543210&venue_id=<uuid>
x-api-key: <your-api-key>

Both query parameters are required.

Start in the sandbox. Production access is granted after certification.