Skip to content

Modify eSIM wallet balance

Request

Modifies the wallet balance of an eSIM. Use positive amounts to credit, negative to debit, or set_balance=true to force a specific balance.

Security
ApiKeyAuth
Path
iccidstringrequired

eSIM ICCID

Bodyapplication/jsonrequired
amountnumberrequired

Positive value for credit, negative for debit

Example:100
set_balanceboolean

When true, forces balance to the specified amount instead of adding/subtracting

Default:false
Example:false
descriptionstring, <= 512 characters

Free-text reason for the transaction (max 512 characters)

Example:"Top up balance"
POST
/v3/wallet/{iccid}/balance
curl -i -X POST \
  'https://api.tellisim.com/v3/wallet/{iccid}/balance?key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 150,
    "set_balance": true,
    "description": "Set balance to 150.00"
  }'

Responses

Successful response containing transaction details

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred

Example:false
dataobjectrequired
Response
{
  "error": false,
  "data": {
    "transaction_id": "82bee681-7780-4b3b-9442-fe0899f19634",
    "iccid": "8948010010036795085",
    "transaction_type": "CREDIT",
    "amount": 100,
    "set_balance": false,
    "description": "Top up balance",
    "created_at": "2025-01-01T10:00:00.000Z"
  }
}