Cellulant · Schema

Tingg Payout Packet

Inner `payload.packet` object submitted to the Beep payouts endpoint.

PaymentsMobile MoneyCheckoutPayoutsDisbursementAfricaPan-AfricanFintechBank TransferCardsAirtimeBill PaymentSMSOTPTingg

Properties

Name Type Description
serviceCode string
MSISDN string Customer mobile number with country code.
accountNumber string
payerTransactionID string
amount number
datePaymentReceived string
currencyCode string
countryCode string
narration string
invoiceNumber string
hubID string
paymentMode string
customerNames string
extraData object
View JSON Schema on GitHub

JSON Schema

cellulant-payout-packet-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/json-schema/cellulant-payout-packet-schema.json",
  "title": "Tingg Payout Packet",
  "description": "Inner `payload.packet` object submitted to the Beep payouts endpoint.",
  "type": "object",
  "required": [
    "serviceCode",
    "MSISDN",
    "accountNumber",
    "payerTransactionID",
    "amount",
    "datePaymentReceived",
    "currencyCode",
    "countryCode"
  ],
  "properties": {
    "serviceCode": { "type": "string" },
    "MSISDN": { "type": "string", "description": "Customer mobile number with country code." },
    "accountNumber": { "type": "string" },
    "payerTransactionID": { "type": "string" },
    "amount": { "type": "number", "minimum": 0 },
    "datePaymentReceived": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
    },
    "currencyCode": { "type": "string" },
    "countryCode": { "type": "string" },
    "narration": { "type": "string" },
    "invoiceNumber": { "type": "string" },
    "hubID": { "type": "string" },
    "paymentMode": { "type": "string", "enum": ["ATM", "Mobile", "Bank", "Card", "Cash"] },
    "customerNames": { "type": "string" },
    "extraData": {
      "type": "object",
      "properties": {
        "callbackUrl": { "type": "string", "format": "uri" },
        "pushToOriginator": { "type": "boolean" },
        "destinationBankCode": { "type": "string" },
        "destinationBankName": { "type": "string" },
        "destinationAccountName": { "type": "string" },
        "destinationAccountNo": { "type": "string" }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}