Your first sandbox order | Akariq Partners

Need credentials first? Start with Partner onboarding. This quickstart covers the technical steps once your sandbox account is ready.

1. Prepare your backend

Request sandbox access with the reseller scopes listed in Authentication. Set these environment variables securely on your backend:

export AKARIQ_BASE_URL="https://api-dev.akariq.com/api/v1"
# Set AKARIQ_API_KEY using your secret manager or secure shell environment.

Run these examples from your server or development terminal, never from a customer’s browser.

2. Choose a current plan

curl "$AKARIQ_BASE_URL/plans?country=DE&limit=10" \
  -H "Authorization: Bearer $AKARIQ_API_KEY"

Choose an entry from data. Save its id and priceCents. Prices and IDs below are illustrative; replace them with the values returned for your account.

3. Fund your test balance

Create a USD 10 test-funding session:

curl -X POST "$AKARIQ_BASE_URL/balance/topups" \
  -H "Authorization: Bearer $AKARIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: sandbox-funding-0001" \
  -d '{"amountCents":1000}'

Open the returned checkoutUrl and complete Stripe test checkout using test payment details. Confirm the page is in test mode. Creating a checkout link does not credit the account; verified payment does.

curl "$AKARIQ_BASE_URL/balance" \
  -H "Authorization: Bearer $AKARIQ_API_KEY"

Wait for availableCents to reflect the payment before ordering.

4. Place an order

Replace the example plan and price. Use a unique reference for your consumer order and persist the request key before sending the request.

curl -X POST "$AKARIQ_BASE_URL/orders" \
  -H "Authorization: Bearer $AKARIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: sandbox-order-0001" \
  -d '{"planId":"p123-base","expectedPriceCents":103,"reference":"your-order-0001"}'

A 202 response includes orderId and statusUrl. It means the order was accepted, not that the eSIM is ready.

5. Track progress and retrieve installation details

Set ORDER_ID to the returned order ID:

curl "$AKARIQ_BASE_URL/orders/$ORDER_ID" \
  -H "Authorization: Bearer $AKARIQ_API_KEY"

Poll with a delay that respects your overall rate limit, or receive a webhook. Once status is fulfilled, set ESIM_ID to the returned esimId:

curl "$AKARIQ_BASE_URL/esims/$ESIM_ID/installation" \
  -H "Authorization: Bearer $AKARIQ_API_KEY"

The response contains iccid, activationCode, qrCodeSvg and an optional universalLink. Render and deliver these through your own customer experience. Treat them as private credentials.

Sandbox profiles are synthetic. They cannot be installed for real connectivity, and Akariq does not send sandbox customer emails.

6. Prove that retries are safe

Repeat the exact order request with the same body and idempotency key. It must return the same order without a second reservation. Review Testing & launch before using production.