Getting started

Why use this API?

The Financial Times Lookup API will provide you with the correct fee and settlement amounts as per the contractual agreement for the SKU being purchased.

Note: This API should be used if you are responsible for performing the fund reservation yourself prior to calling the Clickatell Transact API that will perform the vend.

Participating parties 

• Clickatell
• Client

For definitions of each, see here.

Getting started with the Financial Terms Lookup API

To interface with Clickatell, the below 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 Financial Terms Lookup API (this API)

• Add the API_key and access_token to the request header
• Use the client_id supplied during integration

Step 3: Call Transact API 

• Add the API_key and access_token to the request header
• Use the client_id supplied during integration

Step 4: Implement Transact Result API

• Follow the instructions in the Transact Result API quick-start guide

Notes

The following API calls are not discussed in this document as they form part of the respective API’s documentation as indicated below:

• Security Service API quick-start guide
  • token Request
  • token Response
• Transact API quick-start guide
  • transact Request
  • transact Response
• Transact Result API quick-start guide
  • transactResult Request
  • transactResult Response

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:

• Financial Terms Lookup API references
• Security Service API
• Transact API
• Transact Result API
• Overview
• Getting started