Skip to main content
GET
/
collect
/
redemptions
/
types
List supported redemption types
curl --request GET \
  --url https://api.momentpay.net/collect/redemptions/types \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "vouchers.one_voucher",
      "category": "vouchers",
      "name": "1Voucher",
      "description": "South African cash voucher redeemed with a PIN. Captured in a single confirm step.",
      "logo": "https://cdn.momentpay.net/redemptions/one_voucher.svg",
      "website": "https://www.1voucher.co.za",
      "capabilities": {
        "reserve": true,
        "redeem": true,
        "refund": false,
        "lookup": false,
        "change_voucher": "INLINE"
      },
      "required_fields": [
        {
          "name": "pin",
          "type": "string",
          "required": true,
          "sensitive": true,
          "description": "16 digit voucher PIN.",
          "example": "1115684091419838"
        }
      ]
    },
    {
      "type": "vouchers.ott",
      "category": "vouchers",
      "name": "OTT",
      "description": "One Time Token voucher redeemed with a PIN and the subscriber phone number.",
      "logo": "https://cdn.momentpay.net/redemptions/ott.svg",
      "website": "https://www.ott.co.za",
      "capabilities": {
        "reserve": true,
        "redeem": true,
        "refund": false,
        "lookup": true,
        "change_voucher": "SMS"
      },
      "required_fields": [
        {
          "name": "pin",
          "type": "string",
          "required": true,
          "sensitive": true,
          "description": "Voucher PIN or token. Sensitive value.",
          "example": "9988776655443322"
        },
        {
          "name": "phone_number",
          "type": "string",
          "required": true,
          "sensitive": false,
          "description": "Subscriber phone number associated with the voucher.",
          "example": "+27821234567"
        }
      ]
    },
    {
      "type": "vouchers.blu",
      "category": "vouchers",
      "name": "Blu",
      "description": "Blu Voucher redeemed with a token. Stored value lookup also accepts a serial number.",
      "logo": "https://cdn.momentpay.net/redemptions/blu.svg",
      "website": "https://www.bluvoucher.co.za",
      "capabilities": {
        "reserve": true,
        "redeem": true,
        "refund": false,
        "lookup": true,
        "change_voucher": "INLINE"
      },
      "required_fields": [
        {
          "name": "token",
          "type": "string",
          "required": true,
          "sensitive": true,
          "description": "Blu voucher token or PIN. Sensitive value.",
          "example": "8276 8409 4119 1701"
        },
        {
          "name": "serial_number",
          "type": "string",
          "required": false,
          "sensitive": false,
          "description": "Blu voucher serial number. Optional. Accepted for stored value lookup only, where either token or serial number is sufficient.",
          "example": "BL016C1E46AD2768"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Authentication using Bearer tokens. Include your API key in the Authorization header.

Key Types:

  • Test Keys: sk_test_* for development and testing
  • Live Keys: sk_* for production environments
  • Public Keys: pk_test_* or pk_* for client-side operations

📩 Need access? Contact Support to request your API keys.

Usage:

Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc

Response

Supported redemption types.

List of redemption types supported by the API.

data
Redemption Type Descriptor · object[]
required

The supported redemption types.