Purchase eSIM
curl --request POST \
--url https://api.sendpadi.com/api/v1/merchant/vas/esim \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"packageId": "129285fd-553a-455e-a1f8-8f0d79d30aad",
"customerName": "Jane Doe",
"customerPhone": "+234********34",
"customerEmail": "user@example.com",
"deviceType": "SMARTPHONE"
}
'const options = {
method: 'POST',
headers: {
'X-Timestamp': '<x-timestamp>',
'X-Signature': '<x-signature>',
'Idempotency-Key': '<idempotency-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
packageId: '129285fd-553a-455e-a1f8-8f0d79d30aad',
customerName: 'Jane Doe',
customerPhone: '+234********34',
customerEmail: 'user@example.com',
deviceType: 'SMARTPHONE'
})
};
fetch('https://api.sendpadi.com/api/v1/merchant/vas/esim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sendpadi.com/api/v1/merchant/vas/esim"
payload = {
"packageId": "129285fd-553a-455e-a1f8-8f0d79d30aad",
"customerName": "Jane Doe",
"customerPhone": "+234********34",
"customerEmail": "user@example.com",
"deviceType": "SMARTPHONE"
}
headers = {
"X-Timestamp": "<x-timestamp>",
"X-Signature": "<x-signature>",
"Idempotency-Key": "<idempotency-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"transactionId": "vas_esim_001",
"reference": "ESIM-vas_esim_001",
"status": "COMPLETED",
"message": "eSIM activated successfully. Package: Nigeria 100MB 7Days",
"details": {
"orderNo": "B**************",
"packageName": "Nigeria 100MB 7Days",
"dataSize": "100.00 MB",
"validity": "7 days",
"amount": 1082,
"profit": 426,
"currency": "NGN",
"esimProfile": null,
"activationDetails": null,
"estimatedActivationTime": "Activated"
}
}
}{
"success": false,
"data": {
"transactionId": null,
"reference": null,
"status": "FAILED",
"message": "Internal server error occurred while processing eSIM subscription"
}
}VAS (Bill payments)
Purchase eSIM
Buy a travel eSIM after listing packages on List billers. packageId must be the package UUID (id), never packageCode. Scope: vas:write. Requires Idempotency-Key.
POST
/
api
/
v1
/
merchant
/
vas
/
esim
Purchase eSIM
curl --request POST \
--url https://api.sendpadi.com/api/v1/merchant/vas/esim \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"packageId": "129285fd-553a-455e-a1f8-8f0d79d30aad",
"customerName": "Jane Doe",
"customerPhone": "+234********34",
"customerEmail": "user@example.com",
"deviceType": "SMARTPHONE"
}
'const options = {
method: 'POST',
headers: {
'X-Timestamp': '<x-timestamp>',
'X-Signature': '<x-signature>',
'Idempotency-Key': '<idempotency-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
packageId: '129285fd-553a-455e-a1f8-8f0d79d30aad',
customerName: 'Jane Doe',
customerPhone: '+234********34',
customerEmail: 'user@example.com',
deviceType: 'SMARTPHONE'
})
};
fetch('https://api.sendpadi.com/api/v1/merchant/vas/esim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sendpadi.com/api/v1/merchant/vas/esim"
payload = {
"packageId": "129285fd-553a-455e-a1f8-8f0d79d30aad",
"customerName": "Jane Doe",
"customerPhone": "+234********34",
"customerEmail": "user@example.com",
"deviceType": "SMARTPHONE"
}
headers = {
"X-Timestamp": "<x-timestamp>",
"X-Signature": "<x-signature>",
"Idempotency-Key": "<idempotency-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"transactionId": "vas_esim_001",
"reference": "ESIM-vas_esim_001",
"status": "COMPLETED",
"message": "eSIM activated successfully. Package: Nigeria 100MB 7Days",
"details": {
"orderNo": "B**************",
"packageName": "Nigeria 100MB 7Days",
"dataSize": "100.00 MB",
"validity": "7 days",
"amount": 1082,
"profit": 426,
"currency": "NGN",
"esimProfile": null,
"activationDetails": null,
"estimatedActivationTime": "Activated"
}
}
}{
"success": false,
"data": {
"transactionId": null,
"reference": null,
"status": "FAILED",
"message": "Internal server error occurred while processing eSIM subscription"
}
}Part of VAS. Discover destinations and packages with List billers first, then call this endpoint.
1
Pick a destination
GET /api/v1/merchant/vas/billers?category=esim → choose a locationCode (e.g. NG).2
Pick a package
GET /api/v1/merchant/vas/billers?category=esim&locationCode=NG → copy packages[].id (UUID).3
Purchase
POST /api/v1/merchant/vas/esim with that UUID as packageId, customer fields, deviceType, and an Idempotency-Key.packageCode values like P0Q24KI1C are not valid packageIds and will fail. Always use the UUID id from the billers response.Pricing: the package
price from List billers is in USD. Your NGN wallet is debited the equivalent at the current rate — details.amount in the response is the NGN amount charged.Sample below uses the cheapest Nigeria package from the live catalog (
Nigeria 100MB 7Days, price 0.7755 USD).Authorizations
API key id (sp_test_… / sp_live_…)
Headers
Unix time in seconds
HMAC-SHA256 signature
UUID. Required on money-moving writes.
Body
application/json
UUID from List billers → data.esim.packages[].id (e.g. after category=esim&locationCode=NG). Not packageCode.
Device that will install the eSIM profile
Available options:
SMARTPHONE, TABLET, LAPTOP, WATCH Response
OK
The response is of type object.

