Skip to main content
POST
Purchase global digital goods

Authorizations

X-Numero-Api-Key
string
header
required

Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.

X-Numero-Signature
string
header
required

Base64(HMAC-SHA256(publicApiKey, input)) over the raw request body (POST) or canonicalized query string (signed GET). Also send X-Numero-Signature-Version: v2. Required on money-movement / state-changing endpoints (marked 🔒).

The HMAC key is your Public Key as raw UTF-8 bytes — a SECRET despite the name, and a different value from the X-Numero-Api-Key authentication header. Signing with the API key will never produce a valid signature.

Headers

Idempotency-Key
string
required
Maximum string length: 128

Body

application/json
serviceCode
enum<string>
required
Available options:
GLOBALAIRTIME,
GLOBALDATA,
GIFTCARD,
UTILITY
countryCode
string
required
Pattern: ^[A-Z]{2}$
productId
string
required
Pattern: ^[0-9]+$
amount
number
required

Displayed denomination amount. Gift cards use recipient currency; airtime/data/utilities use GBP. The quote returns the total GBP debit.

recipient
string
required

International phone number, recipient email, or subscriber account number.

Maximum string length: 100
senderName
string

Required for gift cards.

invoiceId
string
productUserId
string
amountId
integer
reference
string

Required for purchase; unique Numero transaction reference.

Maximum string length: 64
expectedTotal
number

Required for purchase. Exact GBP total returned by quote.

Response

Numero response envelope

Canonical response envelope for the public surface. data on success, error on failure.

data
object
required

Endpoint payload on success (object or array); null on failure.

error
object | null
required
meta
object
required