eSIMTrade Docs
api.esimtrade.com
Simpler, clearer reseller API docs.
Start with authentication, check wallet balance, read plans, and then move into orders and inventory. Each endpoint page includes its authentication mode, request fields, response shape, and copyable examples.
Start here
1
Authenticate
Create an access-code and secret-key pair in the reseller portal.
2
Verify reads
Use balance, plans, and profile routes before any money-moving call.
3
Place orders
Send purchases only after you have confirmed live slugs and wallet state.
Recommended
Introduction
Overview, quickstart, authentication model, and the public docs entry point for the eSIMTrade reseller API.
Open guideAll endpoints
GET
Wallet Balance
/portal/balance
Read the prepaid wallet balance used for reseller purchasing and reconciliation checks.
GET
List Plans
/portal/plans
Load the reseller catalog with reseller-aware pricing or fetch a single slug with resolved pricing detail.
POST
Create Order
/portal/order
Place a reseller purchase with server-side price resolution, wallet deduction, and idempotency support.
GET
Query Order Status
/portal/orders
Sync a provider order by order number or ICCID and update the persisted reseller order status.
GET
List Orders
/reseller/orders
Paginate reseller order history with optional status and text filters.
GET
List eSIMs
/reseller/esims
Read the reseller eSIM inventory view backed by PortalOrder records and optional status filters.
GET
List Topup Options
/portal/topups
Retrieve available topup plans for an owned ICCID before placing a topup purchase.
POST
Create Topup
/portal/topups
Place a topup against an owned ICCID using a valid topup slug returned from the availability query.
GET
Metrics
/reseller/metrics
Load reseller metrics, revenue series, top countries, and per-range API usage aggregates.
GET
Get Profile
/reseller/profile
Read reseller account and company profile information for the authenticated reseller.
PATCH
Update Profile
/reseller/profile
Update reseller company profile fields such as company name, country, and website.
PATCH
Webhook Settings
/reseller/webhook
Read or update the configured reseller webhook URL. These routes are intended for authenticated portal sessions.