API Reference

This describes how clients can look up the most recently purchased products by the buyer/user from their historic transactions.

Returns user transactions

The User Transaction Lookup API’s primary function is to identify if the new transaction is similar to a recent transaction. The response details can then be used to pre-emptively complete the current transaction details, that the user would be required to provide to complete the new purchase and can be narrowed down using optional parameters.

Returns user transactions

get

The User Transaction Lookup API’s primary function is to identify if the new transaction similar to a recent transactions. The response details can then be used to pre-emptively complete the current transaction details, that the user would be required to provide to complete the new purchaseand can be narrowed down using a number of optional parameters

Authorizations
Query parameters
userIdentifierstring · 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: 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
productIdinteger · min: 1 · max: 9999Optional

Unique reference to the product that was purchased

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

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

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

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

Example: 9
Responses
200

successful operation

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

[
  {
    "channelId": 7,
    "clientId": 101,
    "raasTxnRef": "6e5doyu7pykhva7zcdtl7bfx",
    "transactionDate": "2018-09-05T08:39:20.258Z",
    "productId": 570,
    "description": "DSTV Premium",
    "purchaseAmount": 159800,
    "targetIdentifier": "2341234567891"
  }
]

PreviousUser Transaction Lookup APINextSMS HTTP/S API

Last updated