API Reference

The In-Flight Transaction Lookup can be used before a purchase instruction to confirm that no similar transaction is in progress. The purchase process is described in the “Transact Getting Started" page.

In-Flight Transaction Lookup API

post

The In-Flight Transaction check is used prior to a purchase instruction to confirm that no similar transaction is in progress

Authorizations
Body
sourceIdentifierstring · max: 32Required

The unique identifier for the buyer as recognized by the client 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 client

Example: 2341234567899
targetIdentifierstring · max: 32Required

The unique identifier for the intended recipient (or target/destination) of the product being purchased. This may be the buyer (“Self”) or someone else (a so-called “3rd party purchase”)

Example: 2341234567899
clientIdinteger · int64 · max: 3Required

This is the unique Client Id assigned by Clickatell during the integration process

Example: 100
productIdinteger · int64 · max: 12Required

Product Identifier of the purchased product. A list will be provided by Clickatell

Example: 900
purchaseAmountinteger · int64 · max: 12Required

The value of the SKU that the customer wishes to receive, in the lowest denomination (e.g. cents or pennies), for instance, $250.00 would equate to the value 25000. This amount excludes the fee amount charged for the product

Example: 100000
Responses
200

Successful operation

application/json
post
/in-flight-transaction-check/1.0
POST /apiman-gateway/PaydServices/in-flight-transaction-check/1.0 HTTP/1.1
Host: api-uat.payd.co
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "sourceIdentifier": "2341234567899",
  "targetIdentifier": "2341234567899",
  "clientId": 100,
  "productId": 900,
  "purchaseAmount": 100000
}
{
  "hasPendingTransactions": true,
  "transactions": [
    {
      "raasTxnRef": "701038cf-feb3-4759-8a05-425685509120",
      "created": "2017-09-04T12:00:05.01Z"
    }
  ]
}

PreviousIn-Flight Transaction Check APINextMNO Lookup API

Last updated