Getting started

This guide is an easy-to-read introduction on the way clients can look up the most recently purchased product(s) by a buyer/user from their historic transactions.

Why use this API?

The User Transaction Lookup API’s primary function is to identify if the new transaction is similar to one of the user’s recent transactions. The response details can then be used to pre-emptively complete the current transaction details that are required from the user to complete the new purchase. The use of this API will enhance the customer experience by reducing the number of interactions on recurring purchases.

Participating parties

• Buyer 
• Clickatell
• Client

For definitions of each, see here.

Getting started with the User Transaction Lookup 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 User Transaction Lookup API (this API)

• Add the API_key and access_token to the request header
• Use the client_id supplied during integration
• The following fields are required for the User Transaction Lookup:
  • sourceIdentifier
  • clientId

Notes

Only the last transaction the buyer made will be returned if none of the optional parameters (channelId, productId, productTypeId, limit) are specified in the request. Depending on the optional parameters specified in the API request it may return more than one record in the response. It will always only return the latest transaction per productId.

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:

• User Transaction Lookup API references
• Security Service API
• Getting started
• Overview