Zendit · JSON Structure

Zendit Api Topup Purchase Request Structure

Top-up purchase request.

Type: object Properties: 4 Required: 2
eSIMGift CardsMobile Top-UpPaymentsPrepaid

TopupPurchaseRequest is a JSON Structure definition published by Zendit, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

transactionId offerId subscriberNumber sendValue

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zendit/refs/heads/main/json-structure/zendit-api-topup-purchase-request-structure.json",
  "name": "TopupPurchaseRequest",
  "description": "Top-up purchase request.",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "Client-provided idempotency key.",
      "example": "my-txn-abc123"
    },
    "offerId": {
      "type": "string",
      "description": "Offer to purchase.",
      "example": "offer-12345"
    },
    "subscriberNumber": {
      "type": "string",
      "description": "Recipient phone number in E.164 format.",
      "example": "+15555550100"
    },
    "sendValue": {
      "$ref": "#/components/schemas/Price"
    }
  },
  "required": [
    "offerId",
    "subscriberNumber"
  ]
}