API Reference

Clients can use the Product Lookup API to confirm their product configuration and attributes.

Product Lookup API

The Product Lookup API will only return products/SKUs configured for the specific client initiating the request. This will be a subset of all the products available on the Transact platform. Clients should contact their account manager to find out more about the other products/SKUs available on the Transact platform.

The Product Lookup API can be used by clients to confirm their product configuration and attributes

get

The Product Lookup API will only return products/SKUs configured for the specific client initiating the request. This will be a subset of all the products available on the Transact platform. A client should contact their account manager if they would like to know more about the other products/SKUs available on Transact platform

Authorizations
Query parameters
clientIdinteger · min: 1 · max: 9999Required

This is your unique client ID assigned by Clickatell during the integration process

Example: 909
productIdinteger · min: 1 · max: 9999Optional

Unique identifier for the product. A list will be provided by Clickatell

Example: 719
productTypeIdinteger · min: 1 · max: 999Optional

Unique reference ID for the product type (classification, group or line) to be purchased, e.g pre-purchased airtime or data.

Example: 17
includeInactivebooleanOptional

Include inactive products in the returned list

Example: true
channelIdinteger · min: 1 · max: 8Optional

The channel is the user interface, platform or service that the buyer used to initiate a purchase from. The following IDs are reserved 1 Point of Sale 2 Internet 3 Mobile 4 ATM 6 SMS 7 USSD 8 WhatsApp

Example: 7
vendorIdinteger · min: 1 · max: 999Optional

Clickatell's unique identifier for a vendor

Example: 100
Responses
200

successful operation

application/json
get
/productLookup/2.0
GET /apiman-gateway/PaydServices/productLookup/2.0?clientId=1 HTTP/1.1
Host: api-uat.payd.co
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "publicProduct": {
      "id": 100,
      "productTypeId": 17,
      "productTypeName": "ElecBillpayment",
      "description": "Enugu Electricity Prepaid",
      "shortDescription": "Electricity Prepaid",
      "active": true,
      "pricing": {
        "type": "range",
        "minimumAmount": 15000,
        "maximumAmount": 500000000,
        "increment": 100
      },
      "supportToken": true
    },
    "attributes": [
      {
        "attributeId": 4,
        "name": "billerName",
        "value": "Enugu Electricity Distribution Company Prepaid",
        "type": "String"
      }
    ],
    "publicVendorDetails": [
      {
        "vendorId": 20,
        "vendorName": "Clickatell Biller",
        "currencyCode": "NGN",
        "countryName": "Nigeria",
        "fees": {
          "description": "Convenience Fee",
          "amount": 100000
        }
      }
    ],
    "channelIds": "1,2"
  }
]

PreviousProduct Lookup APINextReserve & Transact API

Last updated