API Reference

The Customer Account Validation API validates a customer's bill payment account and purchase before submitting the bill payment purchase request to the vendor.

Validate Purchase Request

Validate a user's account before a purhcase.

Validate Purchase Request

post

Validate a user's account before purchase

Authorizations

BearerAuth & X-API-Key

Body

application/json

productIdinteger · int32 · max: 12Required

ID of the product requested to be purchased. A list of products will be supplied by Clickatell

Example: 100

purchaseAmountinteger · int64 · max: 12Required

The value of the SKU that the customer wishes to receive, in the lowest denomination (e.g. cents or pennies), for instance, $250.00 would equate to the value 25000. This amount excludes the fee amount charged for the product

Example: 9000

sourceIdentifierstring · min: 1 · max: 32Required

The unique identifier for the buyer as recognized by the client and can be used to look up the buyer’s account with the biller. This is typically the buyer’s mobile phone number (MSISDN) but can be another unique identifier recognized by both Clickatell and the client

Example: 2341234567891Pattern: ^[a-zA-Z0-9]+$

targetIdentifierstring · min: 1 · max: 32Required

The unique identifier for the intended recipient (or target/destination) of the product being purchased. This may be the buyer (“Self”) or someone else (a so-called “3rd party purchase”) or an account number. Please note: The product type of the product being purchased will also determine the type of identifiers required.

Example: 2341234567891Pattern: ^[a-zA-Z0-9]+$

clientIdinteger · int32 · min: 1 · max: 999999999Required

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

Example: 111

timestampstring · date-time · max: 32Required

The timestamp of when an API request or response was sent, in ISO 8601 format

Example: 2016-06-29T16:39:42.735Z

Responses

200

Request successful

application/json

202

Error validating customer account

application/json

post

/validate

HTTPcURLJavaScriptPython

POST /apiman-gateway/PaydServices/customerAccountValidation/1.0/validate HTTP/1.1
Host: api-uat.payd.co
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "productId": 100,
  "purchaseAmount": 9000,
  "sourceIdentifier": "2341234567891",
  "targetIdentifier": "2341234567891",
  "clientId": 111,
  "timestamp": "2016-06-29T16:39:42.735Z"
}

{
  "status": "online",
  "customerInfo": {
    "name": "Test Name",
    "address": "Test address",
    "phone": "2341111111111",
    "district": "District Test"
  },
  "accountInfo": {
    "minimumAmount": 90000,
    "amount": 900,
    "arrears": 0,
    "targetIdentifier": "2341111111111",
    "accountNumber": "2068147810",
    "tariff": "Residential",
    "providerName": "Biller"
  },
  "responseCode": "0000",
  "message": "Request successful"
}