API Reference

Clients can use the Token Lookup API to look up tokens/vouchers to present back to the end-user who purchased token-related products via the Marketplace platform. This is an alternative way for the buyers to view their purchased tokens/vouchers and will mainly be used if they did not receive the original SMS containing the purchased token.

API for looking up tokens

Clients can use this API to look up tokens to present back to the end-user who purchased token-based products.

API for looking up tokens

get

Clients can use this API to look up tokens to present back to the buyer/customer who purchased token-based products

Authorizations
Query parameters
sourceIdentifierstring · min: 1 · max: 100Required

The unique identifier for the buyer, as recognized by the bank and used to look up the buyer’s bank account from where the payment must be made. This is typically the buyer’s mobile phone number (MSISDN) but can be another unique identifier recognized by both Clickatell and the bank

Example: 2341122333311
clientIdinteger · min: 1 · max: 9999Required

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

Example: 909
channelIdinteger · min: 1 · max: 8Required

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

Example: 7
productTypeIdinteger · min: 1 · max: 999Required

Unique reference Id for the product type (classification, group or line) that was purchased, for instance pre-purchased airtime or data.

Example: 3
limitinteger · min: 1 · max: 1000Required

This is a restriction that can be used to limit the number of records returned. If not specified only the latest transaction for the source Identifier will be returned.

Example: 9
Responses
200

successful operation

application/json
get
/core-tokenLookup/1.0
GET /apiman-gateway/PaydServices/core-tokenLookup/1.0?sourceIdentifier=text&clientId=1&channelId=1&productTypeId=1&limit=1 HTTP/1.1
Host: api-uat.payd.co
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "userTokens": [
    {
      "listItem": "Iflixvoucher 1 day:2018-07-20",
      "targetIdentifier": "2344200000000",
      "clientId": 3,
      "productId": 574,
      "description": "Iflix voucher 1 day",
      "attributes": {
        "redemptionUrl": "http://test.clickatell.co",
        "validFrom": "2018-07-20",
        "validTo": "2018-07-20"
      },
      "raasTxnRef": "y4zmnopzr2qcinljwbaizgdl",
      "transactionDate": "2018-07-20",
      "channelId": 7,
      "productTypeId": 20,
      "purchaseAmount": 15000,
      "token": "IFLIX-68FE5BFE-EB7F-44"
    }
  ]
}

PreviousToken Lookup APINextTransact API

Last updated