API Reference

The Financial Terms Lookup API should be used by clients responsible for performing their own fund reservation before calling the Clickatell Transact API to perform the vend. The Financial Terms Lookup API will provide a client with the correct fee and settlement amounts per the contractual agreement for the purchased SKU.

Lookup API for clients to request financial terms for products they can vend

The Financial Terms Lookup API should be used by clients to lookup the financial terms associated with the products they are configured to vend.

Lookup API for clients to request financial terms for products they can vend

get

The Financial Terms Lookup API should be used by clients to lookup the financial terms associated with the products they are configured to vend

Authorizations

BearerAuth & X-API-Key

AuthorizationstringRequired

Client receives token by calling Clickatell's token generation service

X-API-KeystringRequired

API Key provided by Clickatell to client

Query parameters

clientIdinteger · min: 1 · max: 9999Required

This is your unique client ID assigned by Clickatell during the integration process

Example: 909

productIdinteger · min: 1 · max: 9999Required

Unique identifier for the product. A list will be provided by Clickatell

Example: 719

purchaseAmountinteger · min: 1 · max: 12Required

Unique reference ID for the product type (classification, group or line) to be purchased, e.g. pre-purchased airtime or data.

Example: 17

Responses

200

successful operation

application/json

400

General error

application/json

get

/financial-terms/1.0

HTTPcURLJavaScriptPython

GET /apiman-gateway/PaydServices/financial-terms/1.0?clientId=1&productId=1&purchaseAmount=1 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "clientId": 100,
    "productId": 900,
    "currencyCode": "NGN",
    "purchaseAmount": 100000,
    "feesAsOf": "2018-04-19T07:41:04.468Z",
    "lookupReference": "b3c98c3c-f97c-42db-b047-55fb2d4b3fc0",
    "breakdown": {
      "reserveAmount": 40000,
      "vendAmount": 40000,
      "feeAmount": 0,
      "settlementAmount": 38700,
      "clientShareAmount": 1300
    }
  }
]