Top up an eSIM

Designing

POST

https://api.veloesim.com:2053/api/wholesale/esims/{iccid}/top-up

eSIMs

Last modified:2026-10-13 19:41:46

Purchase a top-up plan for the eSIM. First retrieve its available top-up plans, then send the selected plan ID. This call purchases additional service and returns the updated eSIM and assigned plans.

Authentication: send Authorization: Apikey YOUR_API_KEY.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

⚪defaultSuccess

application/json

Documented response body. HTTP status codes are not specified by the source. Schema describes the example fields; field requiredness is not asserted.

Bodyapplication/json

🟠403Key not valid

🟠404No key, or nothing found

Request Example

Shell

JavaScript

Java

Swift

cURLHttpiewget

curl --location 'https://api.veloesim.com:2053/api/wholesale/esims/8937204016163448888/top-up' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "planId": 1
}'

Response Example

default - GitHub response example

{
    "iosSetup": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$address.test$K2-22XXXX-LCIUXQ",
    "iccid": "8937204016163448888",
    "matchingId": "K2-22XXXX-LCIUXQ",
    "smdpAddress": "address.test",
    "profileStatus": "RELEASED",
    "installedAt": null,
    "assignedPlans": [
        {
            "id": 89,
            "planId": 5,
            "initialQuantityInBytes": 1000000000,
            "remainingQuantityInBytes": 402593548,
            "startTime": "2024-05-18T19:24:18.000Z",
            "endTime": "2024-05-25T20:00:00.000Z",
            "isExpired": false,
            "areas": [
                {
                    "id": 49,
                    "name": "Greece",
                    "region": "Europe",
                    "iso": "GR"
                }
            ]
        },
        {
            "id": 95,
            "planId": 5,
            "initialQuantityInBytes": 1000000000,
            "remainingQuantityInBytes": 1000000000,
            "startTime": null,
            "endTime": null,
            "isExpired": false,
            "areas": [
                {
                    "id": 49,
                    "name": "Greece",
                    "region": "Europe",
                    "iso": "GR"
                }
            ]
        }
    ]
}

Modified at 2026-10-13 19:41:46

List eSIM top-up plans