Top-up

Once the First Package was activated, you can add more balance to your customers using the /gigastore/activations/top-up endpoint.

The activation will use your credit balance on Gigastore and deduct the purchase value from your credit. You can check for the history of activations here: https://dent.giga.store/#/your-store/history.

To activate a top-up, you need:

  • inventoryItemId - see Offering Packages

  • metatag, e.g. an internal transaction id (will be stored and can be retrieved via API)

  • customerUid - the uid of your customer as returned during registration

  • expectedPrice - the retail price of the package (optional)

POST /gigastore/activations/top-up

Request:
{
    "inventoryItemId": "00e3e46e-faa5-465a-9321-1234567890",
    "metatag": "Comment for reseller...",
    "customerUid": "123234345-234-cbd2-9321-1234567890",
    "expectedPrice":{
            "sortIndex": 0,
            "priceValue": 4.99,
            "currencyCode": "USD"
    }
}

Response:
{
    "status": "success",
    "activatedItem": {
        "balance": {
            "activatedAt": "2024-04-30T10:41:03.14304Z",
            "expiresAt": "2025-04-30T10:41:03Z",
            "name": "eSIM Worldwide 50 MB",
            "size": {
                "sizeValue": 50,
                "sizeUnit": "MB"
            },
            "availableBalance": {
                "sizeValue": 0.05,
                "sizeUnit": "GB"
            },
            "validitySize": 365,
            "validityUnit": "days"
        },
        "uid": "4f1eec1b-61dc-47df-91a6-....",
        "metatag": "Comment for reseller...",
        ...
    },
    "customer": {
        "email": null,
        "uid": "123234345-234-cbd2-9321-1234567890",
        "profileUrl": "<url>"
    },
    "esimProfile": null
}

The request will return a newly created activatedItem.

The customer's total balance will be updated immediately. See Customers for more details.

The top-up is instantly usable by your user; no additional eSIM needs to be installed.

Last updated