1. Card service interfaces
EIOTCLUB API
  • API Interface
    • Interface Description
    • Signature algorithm
    • Error Code
    • Card service interfaces
      • Query all cards under account (Deprecated)
        POST
      • Single Card Information Query (Deprecated)
        POST
      • Query Batch Card
        POST
      • Query Card Package Order Records
        POST
      • Query available packages for a card
        POST
      • Single Card Refresh (Deprecated)
        POST
      • Query international card warning information under the account
        POST
      • Card total statistics
        POST
      • Query profit sharing information at the current level
        POST
      • Query the list of operators that the card can switch to
        POST
      • Switch the operator of the card
        POST
      • Unlock the IMEI pool of the card
        POST
      • Add IMEI to the IMEI card pool
        POST
      • Send SMS
        POST
      • Query the refundable amount
        POST
      • Query customer account balance
        POST
      • Query the status of a package subscription order
        POST
      • Query the product to which the card belongs
        POST
      • Query the orderable packages under the specified product
        POST
      • Query orderable eSIM products
        POST
      • Purchase eSIM
        POST
      • Refund an eSIM order
        POST
      • Query eSIM order details
        POST
      • Query the refundable amount of an eSIM order
        POST
      • Query the details of the package corresponding to the order
        POST
      • Card bind device
        POST
      • Card unbind device
        POST
      • Card Transfer Package
        POST
      • Refresh package usage
        POST
      • Cancel current session
        POST
      • Query the seed number list of the eUICC card
        POST
      • Deliver eSIM remotely
        POST
      • Query all profiles under eUICC
        POST
      • Query Switchable Products for the Card
        POST
      • Switch Card Product
        POST
    • Card package subscription interfaces
      • Package subscription interface
      • Package refund interface
    • Asynchronous notification
      • Traffic alert
      • Unlock notification
      • Card locking notification
      • Subscription notification
      • Subscription notification - detailed version
      • Package activation notice
      • Product switching
      • Refund notification
      • Notification of package expiration upon reaching usage limit
      • Notification of card network disconnection
      • Notification of card being removed from the IMEI pool
      • Notification of card being moved into the IMEI pool
      • Notification of agent pool deact pkg
      • Notification of agent pool pkg activate
      • Notification of agent pool pkg traffic alert
      • EIM remote operation result notification
    • Cloud eSIM
      • Query all cloud eSIM cards under account
      • Single Cloud eSIM Card Details
      • Query Available Packages for Cloud eSIM Card
      • Query cloud eSIM card subscription records
      • Refresh eSIM card under account
      • Purchase eSIM card plan under account
      • Cloud eSIM card order status under account
      • Refund for Cloud eSIM Card Orders Under the Account
      • Query Refundable Amount for Cloud eSIM Card Orders Under the Account
      • Cloud eSIM Transfer Package
      • Cloud eSIM unlock
      • Query Switchable Products for the Cloud eSIM Card
      • Switch Cloud eSIM Card Product
      • Batch Add Cloud eSIM EIDs to IMEI Pool
    • Cloud eSIM Asynchronous notification
      • Traffic alert
      • Subscription notification
      • Package activation notice
      • Refund notification
      • Notification of package expiration upon reaching usage limit
      • Notification of card network disconnection
      • Product switching
      • Card locked notification
      • Card unlocked notification
    • Pool
      • Get pool package list
      • Create pool
      • Get pool list
      • Delete empty pool
      • Subscribe pool package
      • Get pool record list
      • Unsubscribe pool package
      • Get pool's can add card
      • Add pool's card
      • Get pool's card list
      • Remove pool's card
      • Get pool by iccid
    • CDR
      • Batch Query ICCID Traffic
  1. Card service interfaces

Purchase eSIM

Developing
POST
/api/v3/esim/purchase
Error codes:
503016 - Duplicate order number. When this error is returned, you can get the result through the interface for querying eSIM order details.
45109 - eSIM product not found
45110 - Insufficient inventory of eSIM products
45112 - Insufficient account balance

Request

Body Params application/json

Example
{
    "appkey": "string",
    "timestamp": 0,
    "nonce": 0,
    "sign": "string",
    "eSIMGoodsCode": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://oapi.eiotclub.com/api/v3/esim/purchase' \
--header 'Content-Type: application/json' \
--data '{
    "appkey": "string",
    "timestamp": 0,
    "nonce": 0,
    "sign": "string",
    "eSIMGoodsCode": "string"
}'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{
    "code": 0,
    "data": {
        "orderId": "",
        "iccid": "",
        "activationCode": ""
    },
    "message": "string"
}
Modified at 2025-08-18 03:44:04
Previous
Query orderable eSIM products
Next
Refund an eSIM order
Built with