topup

Identify the country and mobile operator of a phone number and list the top-up offers available for it. Free. The operator is DETECTED from the number range and is a guess: MVNOs (Tesco Mobile, Giff Gaff, Lebara, Voxi, Sky…) resolve to the host network they ride on. Read the detected brand back to the human and have them confirm it before buying, and use `other_brands` to correct it — a voucher bought for the wrong network delivers successfully and cannot be redeemed or refunded.

{
  "type": "object",
  "properties": {
    "phone": {
      "type": "string",
      "description": "E.164, e.g. +919876543210"
    }
  },
  "required": [
    "phone"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Browse purchasable offers: mobile top-ups, travel eSIMs, prepaid bills, or international payment corridors (bank / mobile money / UPI) for a country. Free. Prices shown are indicative; the quote fixes them.

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "topup",
        "esim",
        "bill",
        "payout"
      ],
      "description": "payout = international payment (bank / mobile money / UPI)"
    },
    "country": {
      "description": "ISO-3166 alpha-2, e.g. IN",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "brand": {
      "type": "string"
    },
    "limit": {
      "description": "page size, default 100; 0 means all",
      "type": "integer",
      "minimum": 0,
      "maximum": 500
    },
    "offset": {
      "description": "use next_offset from the previous page",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "type"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lock a price (10 minutes) for one purchase. Returns quoteId, exact USDC price and what will be delivered. Free. ALWAYS show the human the price and the recipient before buying.

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "topup",
        "esim",
        "bill",
        "payout"
      ]
    },
    "offerId": {
      "type": "string"
    },
    "phone": {
      "description": "recipient phone for topup/bill (E.164)",
      "type": "string"
    },
    "amount": {
      "description": "for range offers: amount in the recipient's local currency",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "iccid": {
      "description": "existing eSIM to top up (optional)",
      "type": "string"
    },
    "fields": {
      "description": "bill-pay / payout recipient fields the offer lists in requiredFields (account_number, bank_code, full_name, vpa, iban…)",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "sender": {
      "description": "payouts only: the principal (legal name + country); reference = partner KYC id, required above $100/day",
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "reference": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "country"
      ]
    },
    "payer": {
      "description": "the Algorand address you will pay from (required for payout compliance when this server holds no wallet)",
      "type": "string"
    },
    "ref": {
      "description": "referrer's Algorand address — earns a share of margin if the order is delivered (GET /v1/referrals)",
      "type": "string"
    }
  },
  "required": [
    "type",
    "offerId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Create a checkout link a HUMAN pays from their own Algorand wallet (Pera). Use this when you have no wallet, or when the person should approve and pay themselves: they open the link, see the exact price, sign in their wallet, and the result (the eSIM QR code, or the top-up confirmation) appears on the page. You never hold a key. A top-up link can be paid by anyone — send it to family as 'top up my phone'. An eSIM link delivers to whoever pays. Free. Add `ref` (your Algorand address) to earn a share of margin on each delivered order.

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "topup",
        "esim"
      ]
    },
    "offerId": {
      "type": "string"
    },
    "phone": {
      "description": "topup only: recipient phone, E.164",
      "type": "string"
    },
    "amount": {
      "description": "for range top-up offers: amount in local currency",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "note": {
      "description": "shown on the link page, e.g. 'Your Tokyo trip data'",
      "type": "string",
      "maxLength": 140
    },
    "ref": {
      "description": "your Algorand address, to earn referral share",
      "type": "string"
    },
    "max_uses": {
      "description": "0 = reusable until expiry; default 1 for topup, 0 for esim",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000
    },
    "ttl_hours": {
      "description": "default 168 (7 days)",
      "type": "integer",
      "minimum": 1,
      "maximum": 720
    }
  },
  "required": [
    "type",
    "offerId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get the x402 payment challenge for a quote. This hosted server holds no wallet, so it does NOT spend your money: it returns the exact amount, asset, payTo address and facilitator for you to pay from your own Algorand wallet, then you POST the quote again with your payment signature. Requires prior human confirmation of the quote.

{
  "type": "object",
  "properties": {
    "quoteId": {
      "type": "string"
    }
  },
  "required": [
    "quoteId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Check an order. Poll every ~3 s until `terminal` is true: delivered (confirmation + signed receipt), refunded (refund txid + signed receipt) or refund_failed.

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string"
    }
  },
  "required": [
    "orderId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Verify an ed25519-signed receipt: the signature, and — unless you pass onChain:false — both txids against an Algorand indexer. Give it an orderId to check one of this service's own orders, or a receipt object to check ANY receipt in this format, including one issued by another server.

{
  "type": "object",
  "properties": {
    "orderId": {
      "description": "an order on this service",
      "type": "string"
    },
    "receipt": {
      "description": "a receipt {payload, signature}, or an order response containing one"
    },
    "onChain": {
      "description": "confirm the txids on chain; default true",
      "type": "boolean"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Indicative USDC → local-currency rate at our sale price, with an estimate for an amount. The quote is the binding price.

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "minLength": 3,
      "maxLength": 3,
      "description": "ISO-4217, e.g. INR"
    },
    "amount": {
      "type": "number",
      "exclusiveMinimum": 0
    },
    "type": {
      "description": "what the rate is for; default payout",
      "type": "string",
      "enum": [
        "topup",
        "bill",
        "payout"
      ]
    }
  },
  "required": [
    "to"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Public delivery ledger: totals, delivered-or-refunded %, volume, countries, recent orders.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}