Bitcall APIAdd your Key ID and Secret to send test requests.
Buy a top-up
Adds a package to an existing eSIM. Returns an order to poll.
Authorization
KeyId ApiSecret x-key-id<token>
Your API key id.
In: header
x-api-secret<token>
Your API key secret.
In: header
Path Parameters
iccid*string
Header Parameters
Idempotency-Key*string
Required. Repeating this operation with the same key and the same request replays the original response for 24 hours; a different request with the same key returns 409 IDEMPOTENCY_CONFLICT.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/esim/esims/string/topup" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "packageId": "69f1fd87f32cd1cae4cb60aa" }'{
"data": {
"orderId": "string",
"status": "pending",
"actions": {
"canCancel": true,
"canRequestRefund": true
},
"quantity": 0,
"price": {
"amount": 0,
"currency": "string"
},
"packageType": "string",
"createdAt": "string",
"updatedAt": "string",
"dueDate": "string",
"esims": [
{
"iccid": "string",
"status": "string",
"activationCode": "string",
"qrCodeUrl": "string",
"appleInstallUrl": "string",
"installationAvailable": true,
"topupEligible": true,
"network": "string"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request is not valid. See `fields` for what to correct.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "AUTHENTICATION_REQUIRED",
"message": "This endpoint requires an API key.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "No such resource.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "INSUFFICIENT_BALANCE",
"message": "Your account balance is too low for this operation.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry after the interval in `Retry-After`.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Something went wrong on our side.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_RESPONSE_INVALID",
"message": "The upstream service returned an unexpected response.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is temporarily unavailable. Try again shortly.",
"requestId": "9f1c7b2e-…"
}
}