Xpress Flow Systems

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.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "One full domain name, for example yourbrand.com.ng."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from."
    }
  },
  "required": [
    "domain"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "location": {
      "type": "string",
      "description": "Country or region name or code, for example United Kingdom, GB, Europe or EU-42."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from."
    }
  },
  "required": [
    "location"
  ],
  "additionalProperties": false
}

Search what Xpress sells: eSIM destinations by name. Returns ids to pass to fetch.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Words to search for, for example \"japan esim\"."
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "An id from search, for example esim:GB."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "description": "Optional: US, VN, AU, MN, MV, EU or GLOBAL."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from."
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The available domain to register."
    },
    "customer_name": {
      "type": "string",
      "description": "Full name of the person who will own the domain."
    },
    "customer_email": {
      "type": "string",
      "description": "Their email address."
    },
    "customer_phone": {
      "type": "string",
      "description": "A phone number we can reach, for example 08012345678."
    },
    "address": {
      "type": "string",
      "description": "Street address of the registrant."
    },
    "city": {
      "type": "string",
      "description": "City."
    },
    "state": {
      "type": "string",
      "description": "State or region."
    },
    "country": {
      "type": "string",
      "description": "Country, for example Nigeria."
    },
    "organisation": {
      "type": "string",
      "description": "Optional organisation name."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN, the currency the person pays in. By default US dollars outside Nigeria and naira in Nigeria, from where the request comes from."
    },
    "accept_terms": {
      "type": "boolean",
      "description": "Set true only if your user has agreed to the Terms of Use and Privacy Policy on this website."
    },
    "email_verification_token": {
      "type": "string",
      "description": "verification_token from verify_email_code for this email (required while email checks are on)."
    }
  },
  "required": [
    "domain",
    "customer_name",
    "customer_email",
    "customer_phone",
    "address",
    "city",
    "state",
    "country",
    "accept_terms"
  ],
  "additionalProperties": false
}

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_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.

{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "description": "Order reference such as XF-7K3Q9DFA."
    },
    "token": {
      "type": "string",
      "description": "The access token: the last part of status_url."
    }
  },
  "required": [
    "reference",
    "token"
  ],
  "additionalProperties": false
}

Start an eSIM purchase for a person. Phone-number plans need name and accept_aup: true, a real (not temporary) email and a home connection, and are limited to 3 numbers per person; more needs ID checked on the website. 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.

{
  "type": "object",
  "properties": {
    "location": {
      "type": "string",
      "description": "Destination code from search_esim_plans, for example US. Not needed with phone_plan_code."
    },
    "plan_code": {
      "type": "string",
      "description": "plan_code from search_esim_plans."
    },
    "phone_plan_code": {
      "type": "string",
      "description": "plan_code from search_phone_plans, for an eSIM with a phone number."
    },
    "email": {
      "type": "string",
      "description": "Required: the person's email, for their receipt and order details (the eSIM)."
    },
    "country": {
      "type": "string",
      "description": "Optional: the payer's two-letter country. Outside Nigeria (NG) they pay in US dollars. Defaults to where the request comes from."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from."
    },
    "accept_terms": {
      "type": "boolean",
      "description": "Set true only if your user agreed to the Terms of Use and Privacy Policy on this website."
    },
    "accept_aup": {
      "type": "boolean",
      "description": "Required true with phone_plan_code: your user agreed to the Acceptable Use Policy (/acceptable-use): no spam, scams, impersonation, bulk SMS or robocalls; a violation cancels the number with no refund."
    },
    "name": {
      "type": "string",
      "description": "With phone_plan_code: the person's full name (first and last)."
    },
    "email_verification_token": {
      "type": "string",
      "description": "verification_token from verify_email_code for this email (required while email checks are on)."
    }
  },
  "required": [
    "email",
    "accept_terms"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from."
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string",
      "description": "Product id from list_proxy_products."
    },
    "gb": {
      "type": "number",
      "description": "Pack size (GB, or Mbps for a speed tier)."
    },
    "offer_id": {
      "type": "string",
      "description": "offer_id of the pack from list_proxy_products."
    },
    "target_country": {
      "type": "string",
      "description": "Optional: two-letter country the proxy lines should exit from."
    },
    "email": {
      "type": "string",
      "description": "Required: the person's email, for their receipt and order details (the lines)."
    },
    "country": {
      "type": "string",
      "description": "Optional: the payer's two-letter country. Outside Nigeria (NG) they pay in US dollars. Defaults to where the request comes from."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "NGN"
      ],
      "description": "Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from."
    },
    "accept_terms": {
      "type": "boolean",
      "description": "Set true only if your user agreed to the Terms of Use and Privacy Policy on this website."
    },
    "email_verification_token": {
      "type": "string",
      "description": "verification_token from verify_email_code for this email (required while email checks are on)."
    }
  },
  "required": [
    "product",
    "gb",
    "offer_id",
    "email",
    "accept_terms"
  ],
  "additionalProperties": false
}

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).

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The buyer's email address."
    }
  },
  "required": [
    "email"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The same email the code was sent to."
    },
    "code": {
      "type": "string",
      "description": "The 6-digit code."
    }
  },
  "required": [
    "email",
    "code"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "accept_terms": {
      "type": "boolean",
      "description": "Set true only if your user agreed to the Terms of Use and Privacy Policy on this website."
    }
  },
  "required": [
    "accept_terms"
  ],
  "additionalProperties": false
}