Headers
Header Parameters
| Parameters | Max Length | Data types | Mandatory/Optional | Parameter Description |
| requestTimestamp | 13 | String | Mandatory | Epoch timestamp in milliseconds |
| transactionid | 20 | String | Mandatory | Unique Transaction ID |
| merchantId | 15 | String | Mandatory | Merchant identifier |
| orderId | 20 | String | Mandatory | Order Reference ID |
| clientId | 64 | String | Mandatory | Client authentication key |
| hmacSecret | 64 | String | Mandatory | HMAC Signature key |
| Content-Type | - | String | Mandatory | Must be application/json |
Request Body Parameters
| Parameters | Max Length | Data types | Mandatory/Optional/conditional | Parameter Description with samples |
| apiOperation | 10 | String | Mandatory | Must be PURCHASE |
| authzTxnId | 19 | String | Mandatory | Authorization ID.E.g.-100180 |
| authentication | - | Object | Conditional | Authentication Details |
|
19 | String | Conditional | 3DS transaction ID.E.g.-1300 |
|
- | Boolean | Conditional | Bypass 3DS if true.E.g.-false |
|
- | String | Conditional | 3DS provider name.E.g.Others |
| sourceOfFunds | - | Object | Mandatory | Payment Source |
| provided | - | Object | Mandatory | Provided Data |
| card | - | Object | Mandatory | Card Details |
|
16 | String | Mandatory | Card number.E.g.3456785593568727 |
| expiry | 2 | Object | Mandatory | Expiry month(MM)& year(YY). |
|
2 | String | Mandatory | Expiry month(MM)E.g.-02 |
|
2 | String | Mandatory | Expiry year(YY)E.g.-28 |
| securityCode | 3-4 | String | Mandatory | Card CVV.E.g.-123 |
| coftConsent | - | Boolean | Conditional | Tokenization consent(false here) |
| type | - | String | Mandatory | Card |
| order | - | Object | Mandatory | Transaction Details |
|
3 | String | Mandatory | Currency code.E.g.-AED |
|
- | String | Mandatory | Transaction amount.E.g.-100 |
Sample Request Body
Response Body Parameters
| Parameters | Data Type | Parameter description |
| apiOperation | String | Confirms the operation type(purchase) |
| order | Object | Order details |
|
String | order ID |
|
String | Transaction amount |
|
String | Currency(may differ from request) |
| payment | Object | Payment Status |
|
String | Payment ID |
|
String | Payment Entity type |
|
String | Transaction Amount |
|
String | Currency(may differ from request) |
|
String | SUCCESS or FAILED |
|
String | Card |
|
String | Description Message |
|
String | YES if international card |
|
String | Status of refund if applicable |
|
String | Total Amount Refunded |
|
String | YES(immediate settlement) |
|
|
String | Customer Email |
|
String | Customer Contact |
|
String | Card ID |
|
String | Wallet |
|
String | Transaction Notes |
|
String | Date of transaction creation |
| tokenDetails | Object | Token Details |
|
String | Card token issued by the card network |
|
YYMM | Token expiry month year details. |
|
String | The last few digits(commonly last 4)of the original card number. |
|
String | Unique identifier for PAN |
|
String | Unique token reference |
|
String | Token requestor ID from merchant |
|
String | token type |
|
String | Token Authentication Verification Value |
| acquirerData | Object | Bank processing details |
|
String | Retrieval Reference Number |
|
String | 3DS auth reference(if applicable) |
|
String | Bank’s transaction ID |
|
String | System trace audit number |
|
String | Merchant ID |
|
String | Terminal ID |
|
String | Merchant Brand name |
|
String | Name of the Merchant |
| isRefunded | Boolean | Indicates if transaction was refunded |
| isVoid | Boolean | Indicates if transaction was voided |
| isMoto | Boolean | Indicates if it was a Mail Order/Telephone Order |
| success | Object | Success |
|
String | Response Message |
|
String | Response Code |
Sample Response Body