API Reference

The Transact Result API pushes the transaction status to a client as soon as the final status is available in the Clickatell platform, and the Transaction Lookup API (this one) is a secondary API used to confirm the status of a transaction.

Look up a transaction

The Transaction Lookup API is used after a purchase to confirm the transaction status.

Look up a transaction

get

The Transaction Lookup API may be used after a purchase to confirm the transaction status

Authorizations

BearerAuth & X-API-Key

AuthorizationstringRequired

Client receives token by calling Clickatell's token generation service

X-API-KeystringRequired

API Key provided by Clickatell to client

Query parameters

clientIdinteger · min: 1 · max: 9999Required

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

Example: 909

raasTxnRefstring · min: 1 · max: 64Optional

Unique Clickatell reference for the transaction

Example: ffdd34-3wsf8c-seo8w3-f58l

clientTransactionReferencestring · min: 1 · max: 64Optional

Unique client reference for the transaction

Example: seo8w3-3wsf8c-ffdd34-f58l

reserveFundsTxnRefstring · min: 1 · max: 64Optional

This is the universally unique identifier that the bank must generate when it reserves funds on a buyer’s account

Example: f58l-3wsf8c-seo8w3-ffdd34

Responses

200

Success response

application/json

400

Error response

application/json

404

Error response

application/json

get

/lookup-api/2.0

HTTPcURLJavaScriptPython

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

{
  "id": "1",
  "raasTxnRef": "ffdd34-3wsf8c-seo8w3-f58l",
  "clientTxnRef": "seo8w3-3wsf8c-ffdd34-f58l",
  "reserveFundsTxnRef": "f58l-3wsf8c-seo8w3-ffdd34",
  "timestamp": "2016-06-29T16:39:42.735Z",
  "amount": 100000,
  "productId": 120,
  "clientId": 100,
  "sourceIdentifier": "2341234567899",
  "targetIdentifier": "2341234567899",
  "channelId": 7,
  "channelSessionId": "1449749732818",
  "channelName": "1449749732818",
  "reserveFundsResponseCode": "f58l-3wsf8c-seo8w3-ffdd34",
  "transactResultResponseCode": "0000",
  "transactionStatus": "SUCCESS",
  "token": "XYZ",
  "reserveAmount": 100000,
  "feeAmount": 0,
  "clientShareAmount": 600,
  "settlementAmount": 14400,
  "vendAmount": 100000,
  "purchaseAmount": 25000
}