Place the order from your backend
After collecting or authorizing your consumer’s payment, call POST /orders with a current planId, expectedPriceCents and your unique reference. Send an Idempotency-Key and retain the complete request with your consumer order record.
Akariq creates the order, reserves credit and queues fulfillment together. If credit is insufficient, the request is rejected without leaving an accepted purchase behind.
A 202 response contains an orderId and statusUrl. Persist the ID before moving to delivery. statusUrl is an API-origin-relative path, so do not append it to the base URL a second time.
Track the outcome
Use GET /orders/{id} or webhooks. GET /orders lists your account’s orders with cursor pagination.
| Status | What your integration should do |
|---|---|
paid | Purchase accepted and funded; wait for provisioning |
provisioning | Provisioning is underway; keep the customer informed |
pending_review | Outcome needs investigation; contact Akariq and do not reorder |
fulfilled | Retrieve installation details using the returned esimId |
failed | Purchase failed; check reservation release and resolve the consumer payment |
refunded | Refund recorded; reconcile before closing the case |
Build a fallback for an unfamiliar status: keep the record and investigate rather than assuming success or creating another purchase.
Deliver the eSIM
After fulfillment, call GET /esims/{id}/installation. The response supplies the ICCID, activation code, QR code SVG and an optional installation link. Use these in your own secure customer page or delivery email, together with the plan’s installation and activation instructions.
For reseller orders, your business delivers the eSIM. Akariq does not automatically send a branded consumer delivery email. You also own the consumer payment receipt and first-line support experience.
Protect installation details like credentials. Do not put them in analytics, public logs or webhook payloads. Make them available only to the purchasing customer through your own authenticated or otherwise protected delivery flow.
Handle uncertainty safely
If the request times out, repeat it with the same body and idempotency key. If an accepted order stays pending or enters pending_review, use that order ID for support. Creating another order with a new reference could purchase another eSIM.
The current partner API does not provide usage checks, data top-ups, cancellation or self-service refund operations. Contact support for an existing purchase that needs investigation.