Skip to main content
The PayVessel eSIM API lets you sell eSIM data packages to your users for international travel. Browse available regions and base packages, provision eSIM profiles, and top up eligible profiles with compatible data packages.

​
Integration flow

  1. List regions to discover supported countries and areas.
  2. List base packages to find a data plan for a new eSIM profile.
  3. Create an order for a package; PayVessel debits your wallet and provisions the eSIM.
  4. Get order to retrieve the eSIM profile details (QR code, ICCID, activation instructions).
  5. List top-up packages for an issued profile, then create a top-up using its ICCID or eSIM transaction number.
  6. List orders with type=purchase or type=topup to retrieve transaction history.

​
Order statuses

​
Base path

All eSIM endpoints are under:

​
Authentication

All requests require api-key and api-secret headers. See Authentication for details.