eSIMTrade Docs

Public API

api.esimtrade.com

cURL

JavaScript

HTTP

JSON

Back to site

Getting Started

Introduction

Authentication

GET

Wallet Balance

GET

List Plans

Errors and Status Codes

Orders

POST

Create Order

GET

Query Order Status

GET

List Orders

Inventory

GET

List eSIMs

GET

List Topup Options

POST

Create Topup

Account

GET

Metrics

GET

Get Profile

PATCH

Update Profile

PATCH

Webhook Settings

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.

Fast scan

Live route coverage

Copyable examples

Account

Portal session only

PATCH

Webhook Settings

Read or update the configured reseller webhook URL. These routes are intended for authenticated portal sessions.

Endpoint

PATCH /reseller/webhook

Endpoint behavior

Webhook settings are currently managed through portal-session authentication rather than API-key authentication. The configured URL is stored in the reseller profile and updates are written to the audit log.

When a webhook URL is configured, eSIMTrade now sends best-effort POST deliveries for completed wallet top-ups, new orders, order status changes, and completed refunds.

Deliveries include event metadata headers and can be signed with an HMAC SHA-256 signature when the server is configured with a webhook signing secret.

Because these routes currently require a reseller session cookie, they are documented here for completeness but are not part of the public API-key request flow.

Example request body

JSON

{
  "webhookUrl": "https://example.com/webhooks/esimtrade"
}

Example response

JSON

{
  "ok": true,
  "webhookUrl": "https://example.com/webhooks/esimtrade"
}

Base URL

https://api.esimtrade.com/api/v1

Open on API host

On this page

Endpoint behavior