In-Flight Transaction Check API

Why use this API?

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

It expands on the purchase process described in the Reserve and Transact API section.

Participating parties

See here for definitions.

• Buyer

• Clickatell

• Client

• Supplier

• Recipient

Getting started with the In-Flight Transaction API

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

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)

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

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

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

A high-level view of this interface.