API Reference
The Reserve and Transact API initiates a purchase and fund reservation request to payd. This API should only be used when a client requires Clickatell to do the fund reservations before a purchase request. The Reserve and Transact API will initiate a reserveFunds Request as discussed in the Bank Interfaces document before dispensing the selected product.
Reserve and Transact API
The Reserve and Transact API initiates a purchase and fund reservation request to Clickatell.
The Reserve and Transact API initiates a purchase and fund reservation request to Clickatell Signature Checksum Calculation
This is an "optional" hash calculated using a shared secret between Clickatell and the client
The account that will be deducted from. Only mandatory if there is no concept of a default account for the buyer at the funding source
3745******0762The 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
10000An authentication code provided by the buyer that the bank can use to verify the buyer’s identity. Used in the reserve funds request if supplied
1234The channel is the user interface, platform or service that the buyer used to initiate a purchase from
7This is the specific name of the channel
USSDThis is a unique reference to the channel-specific engagement when a purchase was initiated (for example USSD Session ID, if the purchase was over USSD)
144974973281This is your unique client ID assigned by Clickatell during the integration process
200Unique client reference to the transaction
seo8w3-3wsf8cffdd34-f58lID of the product requested to be purchased. A list of products will be supplied by Clickatell
110The unique identifier for the source, as recognized by the bank. This is typically the mobile phone number (MSISDN) but can be another unique identifier recognized by the bank.
2341234567899The 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”)
2348012345555The timestamp of when an API request or response was sent, in ISO-8601 format
2017-06-29T16:39:42.735ZA fixed transaction fee that Clickatell charges on top of the requested purchase value of a product. Please note: a zero amount needs to be specified if there is no fee applicable. If the fee amount is not correct the request validation will fail
0International currency code (ISO 4217)
NGNPattern: [A-Z]*This is your unique funding source ID assigned by Clickatell during the integration process. This can be the same as client ID
200These are any additional parameters that might need to be passed through on the payload that has not been catered for in any of the other parameters. These fields will be determined by Clickatell and agreed upon with the client during the integration process.
{"product":101,"fundingource":200,"client":900}successful response
Error response
POST /apiman-gateway/PaydServices/core-reserveAndTransact/4.0 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: 452
{
"accountIdentifier": "3745******0762",
"purchaseAmount": "10000",
"authCode": 1234,
"channelId": 7,
"channelName": "USSD",
"channelSessionId": "144974973281",
"clientId": 200,
"clientTxnRef": "seo8w3-3wsf8cffdd34-f58l",
"productId": 110,
"sourceIdentifier": "2341234567899",
"targetIdentifier": "2348012345555",
"timestamp": "2017-06-29T16:39:42.735Z",
"feeAmount": 0,
"currencyCode": "NGN",
"fundingSourceId": 200,
"additionalData": {
"product": 101,
"fundingource": 200,
"client": 900
}
}{
"responseCode": "0000",
"responseMessage": "Processing request",
"raasTxnRef": "12a345b6-c7de-8f90-a12b34c56de78901"
}Last updated