Getting started

This guide is an easy-to-read introduction to the way a client can prevent buyers from accidentally triggering duplicate transactions.

Why use this API?

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

It expands on the purchase process as described in the Reserve and Transact API quick start guide.

Participating parties

• Buyer 
• Clickatell
• Client
• Supplier
• Recipient

For definitions of each, see here.

Getting started with the In-Flight Transaction API

To interface with Clickatell, the following needs to be set up, configured and tested:

Step 1: Integrate with Security Service API:

• Follow the instructions in the Security Service API quick-start guide to request a token with your client_secret and client_id
• Use the API_key and access_token in the following request (Step 2)

Step 2: Call In-Flight Transaction Check API (this API):

• Add the API_key and access_token to the request header
• Use the client_id supplied during integration
• Use all of the following fields for the In-Flight Transaction Check:
  • purchaseAmount
  • clientId
  • productId
  • sourceIdentifier
  • targetIdentifier

Step 3: Evaluate the In-Flight Transaction status

• The hasPendingTransactions field will indicate if there are transactions in progress
• The transactions field will contain an array of in-flight transactions if any were found

Notes

All fields in the API request needs to match a pending transaction record to be considered as an in-flight transaction.

A high-level view of this interface is illustrated below:

For a list of all roles-players/stakeholders involved in the purchasing process, see here. 

Read more:

• In-Flight Transaction Check API references
• Security Service API
• Getting started
• Overview