check_domain_availability
Check a domain name
Check whether one domain name is free to register. Answers from the public registry for that ending: available, unavailable (taken) or unknown (that ending cannot be checked here). Takes one full name such as yourbrand.com.ng. When it can be ordered online, gives the first-year price. Prices are in US dollars outside Nigeria and in naira in Nigeria; pass currency to choose.
輸入參數domain必填currency
list_esim_locations
List eSIM destinations
List every country and region we sell eSIM data plans for, with their codes. Regions (for example Europe or Global) cover many countries in one eSIM.
無需輸入參數。
search_esim_plans
Search eSIM plans
eSIM data plans for one destination, cheapest first, with prices. No sign-up: the person orders, pays, and gets an eSIM QR code. Give a country or region name or code, for example "United Kingdom", "GB" or "Europe". Each plan has an order_url: our own order page for the person. Prices are in US dollars outside Nigeria and in naira in Nigeria; pass currency to choose.
輸入參數currencylocation必填
search
Search the catalogue
Search what Xpress sells: eSIM destinations by name. Returns ids to pass to fetch.
輸入參數query必填
fetch
Fetch catalogue details
Full details for one id returned by search, for example esim:GB (every plan and price for that destination). Prices are in US dollars outside Nigeria and in naira in Nigeria; pass currency to choose.
輸入參數id必填currency
search_phone_plans
Phone-number eSIMs
eSIMs with a real carrier phone number (calls, texts and data), with prices. Optional country: US, VN, AU, MN, MV, EU (Europe) or GLOBAL. Each plan has an order_url for the person. Non-refundable once bought. Prices are in US dollars outside Nigeria and in naira in Nigeria; pass currency to choose.
輸入參數countrycurrency
create_domain_order
Start a domain order
Start an order to register an available domain for a person. This does not charge anyone. It returns an approval_url that the person must open and pay (in US dollars outside Nigeria, in naira in Nigeria); the name is held for 60 minutes. Send approval_url to your user and wait. Poll get_order_status afterwards.
輸入參數city必填state必填domain必填address必填country必填currencyaccept_terms必填organisationcustomer_name必填customer_email必填customer_phone必填email_verification_token
get_order_status
Get order status
Look up an order made with create_domain_order, create_esim_order or create_proxy_order. Domain statuses: awaiting_payment, paid (being registered), registered, needs_attention, refunded, expired, cancelled. Statuses: awaiting_approval (phone-number order held for a manual ID check; nothing charged; payment_url appears once approved), awaiting_payment, paid, processing, awaiting_fulfilment (paid and being prepared by hand, within 10 minutes), delivered, needs_attention, expired. Delivered orders carry the eSIM activation details or the proxy lines.
輸入參數token必填reference必填
create_esim_order
Start an eSIM purchase
Start an eSIM purchase for a person. Phone-number plans need name, accept_aup: true and a real (not temporary) email, and are limited to 3 numbers per person. Any number past 3 needs customer_phone and id_document and waits for a manual check (status awaiting_approval, nothing charged) before payment_url is given. This does not charge anyone: it returns payment_url (card, bank transfer or crypto) for the person to pay, in US dollars outside Nigeria and in naira in Nigeria. After a verified payment the eSIM is issued within 10 minutes. Poll get_order_status with reference and status_token. Use plan_code and location from search_esim_plans, or phone_plan_code from search_phone_plans.
輸入參數nameemail必填countrycurrencylocationplan_codeaccept_aupid_documentaccept_terms必填customer_phonephone_plan_codeemail_verification_token
list_proxy_products
Proxy products
Proxy products with packs and prices, cheapest first. Each pack has an offer_id for create_proxy_order. Prices are in US dollars outside Nigeria and in naira in Nigeria; pass currency to choose.
輸入參數currency
create_proxy_order
Start a proxy purchase
Start a proxy purchase for a person. This does not charge anyone: it returns payment_url for the person to pay, in US dollars outside Nigeria and in naira in Nigeria. After a verified payment the proxies are issued within 10 minutes. Poll get_order_status with reference and status_token.
輸入參數gb必填email必填countryproduct必填currencyoffer_id必填accept_terms必填target_countryemail_verification_token
request_email_code
Email a confirmation code
Step 1 before any create_*_order: email a 6-digit code to the buyer. Ask your user for the code from that email (it expires in 10 minutes; a new one can be sent after 60 seconds, at most 5 an hour).
輸入參數email必填
verify_email_code
Confirm the email code
Step 2: check the 6-digit code your user read from their email. Returns verification_token (valid 24 hours); pass it as email_verification_token to create_domain_order, create_esim_order or create_proxy_order with the same email. 5 tries per code.
輸入參數code必填email必填
create_wallet
Create a wallet
Create an empty Xpress wallet (no sign-up, no free credit). Returns a 32-character wallet code and an xk_live_ API key, shown once. Fund it with create_deposit on /api/mcp/wallet, then buy domains and eSIMs from the wallet balance within the caps the wallet owner sets.
輸入參數accept_terms必填