Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Add a compatible data package to an existing eSIM
curl -X POST https://api.payvessel.com/vaas/api/v1/esim/topups \
-H "api-key: YOUR_API_KEY" \
-H "api-secret: YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"reference": "esim-topup-001",
"package_code": "TOPUP_CKH002",
"iccid": "8943108170003131575"
}'
| Field | Type | Required | Description |
|---|---|---|---|
reference | string | Yes | Your unique top-up reference. Maximum 64 characters. |
package_code | string | Yes | A compatible code from List Top-Up Packages. |
iccid | string | Conditional | The target eSIM ICCID. Supply this or esim_tran_no. |
esim_tran_no | string | Conditional | The provider eSIM transaction number. Supply this or iccid. Preferred when available. |
period_num | integer | No | Number of periods for providers that support day-pass plan extensions. |
POST /orders provisions a new eSIM and only accepts a base-package code. Use POST /topups for a code returned by the top-up catalogue.success when the provider has applied the top-up. It includes the PayVessel top-up ID, package details, target profile identifiers, charged USD and NGN amounts, and the provider’s top-up transaction number when available.