Buy eSIM
Bearer ds_live_ / ds_test_POST
/api/v1/merchant/esim/purchaseBuys a travel data eSIM. Activation details (ICCID, QR code / LPA string, APN) are returned in delivery once successful.
Language
curl -X POST "https://finaldatasub.com/api/v1/merchant/esim/purchase" \
-H "Authorization: Bearer ds_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"reference": "ORDER-10032",
"biller": "airalo",
"product_id": 1305,
"quantity": 1,
"email": "traveller@example.com"
}'Authentication
Send your secret API key in the header. Authorization: Token … and X-API-Key: … are also accepted.
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer ds_live_YOUR_KEY | Yes |
| Content-Type | application/json | Yes |
| Accept | application/json | Recommended |
Authentication failures (401 UNAUTHORIZED, 403 IP_NOT_ALLOWED / ACCOUNT_SUSPENDED / API_ACCESS_NOT_APPROVED, 429 RATE_LIMITED) are listed in Authentication.
Parameters
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
| reference | string | Yes | Your unique order reference and idempotency key (max 128 chars). Re-sending it returns the original transaction and never charges twice. |
| product_id | integer | string | Yes | Plan id from List billers / Biller products. You may send the product code instead, but only together with biller. |
| biller | string | No | eSIM provider slug (List billers, category esim). |
| quantity | integer | No | Number of eSIMs, 1–5 (default 1). |
| string | No | Email for the installation instructions (max 160). | |
| narration | string | No | Note stored on the transaction (max 255 chars). |
| save_beneficiary | boolean | No | Save the customer to your beneficiaries after a successful purchase (default true). |
| beneficiary_label | string | No | Label for the saved beneficiary (max 60 chars). |
Responses
201 Created — Successful · 202 Accepted — Pending · 422 Unprocessable Entity — Failed (refunded)
{
"status": "successful",
"reference": "ORDER-10032",
"channel": "api",
"transaction_id": "DS261005104920Q1R2S3T4",
"category": "esim",
"message": "Transaction successful.",
"biller": "Airalo",
"biller_slug": "airalo",
"product_id": 1305,
"product": "United Kingdom 3GB · 30 days",
"customer_ref": "traveller@example.com",
"quantity": 1,
"unit_amount": "9800.00",
"amount": "9800.00",
"face_amount": "9800.00",
"fee": "0.00",
"discount": "0.00",
"total_deducted": "9800.00",
"balance_before": "18300.00",
"balance_after": "8500.00",
"provider_reference": "PRV-88215902",
"purchased_at": "2026-10-05T10:49:20+01:00",
"delivery": [
{
"iccid": "8944465400000000000",
"lpa": "lpa.example.com",
"qr_code": "LPA:1$lpa.example.com$ABC123",
"qr_code_url": "https://cdn.example.com/esim/qr.png",
"apn": "internet"
}
]
}Errors
Errors specific to this endpoint, in addition to the authentication and validation errors common to every request.
| Code | HTTP | When |
|---|---|---|
| INVALID_QUANTITY | 400 | Quantity must be between 1 and 5. |
| INVALID_EMAIL | 400 | email is not a valid email. |
| BILLER_NOT_FOUND | 404 | Unknown or inactive biller / network. |
| PRODUCT_NOT_FOUND | 404 | Plan id / code not found, inactive or not part of this biller. |
| SERVICE_UNAVAILABLE | 503 | The service or biller is disabled or temporarily unavailable. |
| INVALID_AMOUNT | 400 | Amount is zero or outside the biller's minimum / maximum. |
| DAILY_LIMIT_EXCEEDED | 429 | Your daily spend limit for this service is reached. |
| TIER_MAX_BALANCE / TIER_DAILY_LIMIT / TIER_MONTHLY_LIMIT | 429 | An account tier limit is reached. Upgrade KYC to raise it. |
| INSUFFICIENT_BALANCE | 402 | Wallet balance is too low for this purchase. |
| WALLET_INACTIVE | 403 | Your wallet is frozen or not active. |
| WALLET_BUSY | 409 | Another request is updating your wallet. Retry with the same reference. |
| TRANSACTION_FAILED | 422 | The provider could not deliver. Your wallet was refunded. |
| DUPLICATE | 200 / 202 / 409 | The reference was already used. The original transaction is returned. |