Transactions
Overview
Our user transaction services also include a wide range of payment options, such as credit and debit cards, e-wallets, and bank transfers, which allows you to choose the most convenient payment method for you. Our platform also supports multiple currencies, which allows you to make international transactions with ease.
We also provide added security features, such as multi-factor authentication, to ensure that your transactions are protected from fraud. Our user transaction services are also fully compliant with all local and international regulations, such as PCI DSS, which ensures that your transactions are processed in a secure and compliant manner.
Card Transaction
Status:
Production
Version:
V2
Category:
Transactions
Card Transaction
Overview
This API is designed to record financial transactions on a card or account level. It accepts an account or card identifier as an input, along with the transaction type, amount, and currency. Once the API receives this information, it will post the transaction, which could be a debit or credit to the account balance. This feature enables businesses to charge fees, process payments, or top up prepaid accounts. The API can also be used to monitor and track transaction activity for accounting and compliance purposes.
Real-time updates
The API updates account balances in real-time, providing immediate confirmation of the transaction to the cardholder.
Support for various types of financial transactions
The API allows for various types of financial transactions, including manual fee charging, credit card payments, and prepaid top-ups.
Input validation:
The API includes input validation to ensure that all provided information is accurate and in the correct format before processing the transaction.
How It Works
The API allows for processing of financial transactions by accepting inputs such as an account or card identifier, transaction type, amount and currency. These inputs are validated to ensure their validity, including the card or account identifier, the supported transaction type, and the correct format of the amount and currency provided.
Once the input validation is successful, the API will process the transaction and update the account balance accordingly, based on whether it is a debit or credit transaction. For instance, a credit card payment will result in a debit of the specified amount from the cardholder's account balance, while a prepaid top-up will result in a credit to the cardholder's account balance.
The API will then return a response including transaction details such as a unique transaction identifier, status, and any other relevant details. It is important to note that this API is only applicable for transactions where the card issuer or financial institution holds the account balance, and is not intended for use with external wallets or store of value.
Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
Card Transaction
Status:
Production
Version:
V2
Category:
Transactions
Node | Child Node | Type | Length | Description |
---|---|---|---|---|
Authorization | Bearer xxxx | string | Authorization Header (Bearer Token) | |
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvRequest | request_card_transaction | header | msg_id | string | 12 | Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID” | ||||
msg_type | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION” | |||||||
msg_function | string | 50 | Static Value - REQ_CARD_TRANSACTION | |||||||
src_application | string | 10 | Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems | |||||||
target_application | string | 10 | The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call | |||||||
timestamp | string | 30 | Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00 | |||||||
bank_id | string | 4 | Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC” | |||||||
body | card_identifier_id | string | 32 | card identifier | ||||||
card_identifier_type | string | 20 | CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS | |||||||
transaction | transaction_code | string | 32 | Transaction code For Payment- PAYCC For Reversal- PAYACC-REV For Debit- DEBITCC For Debit Reversal- DEBITCC-REV | ||||||
amount | string | 20 | Amount | |||||||
currency | string | 3 | Currency | |||||||
description | string | 255 | Transaction description | |||||||
counter_party_number | string | 20 | Source Number | |||||||
transaction_ref_number | string | 12 | Transaction reference number | |||||||
custom_fields | key | string | 32 | Custom Tag | ||||||
value | string | 128 | Tag value |
{
"NISrvRequest": {
"request_card_transaction": {
"header": {
"msg_id": "89658",
"msg_type": "TRANSACTION",
"msg_function": "REQ_CARD_TRANSACTION",
"src_application": "BNK",
"target_application": "WAY4",
"timestamp": "2024-03-19T14:55:18.587+04:00",
"bank_id": "NIC"
},
"body": {
"card_identifier_id": "99984100111514120378",
"card_identifier_type": "EXID",
"wallet_id": "",
"transaction": {
"transaction_code": "PAYACC",
"amount": "66.00",
"currency": "AED",
"description": "Demo Manual Payment Transaction",
"counter_party_number": "999851",
"transaction_ref_number": "58986"
}
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_card_transaction | header | msg_id | string | 12 | Unique Source Message ID eg ada123456fdsf | ||||
msg_type | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION” | |||||||
msg_function | string | 50 | Default RES_CARD_TRANSACTION | |||||||
src_application | string | 10 | Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems | |||||||
target_application | string | 10 | The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call | |||||||
timestamp | string | 15 | Timestamp of the response - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00 | |||||||
bank_id | string | 4 | Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC” | |||||||
exception_details | application_name | string | 20 | Application Name | ||||||
date_time | string | 30 | Timestamp of the response Format “YYYY-MM-DD HH:MM:SS” | |||||||
status | string | 1 | Status of the request (S/F) | |||||||
error_code | string | 4 | EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) | |||||||
error_description | string | 100 | Error Description (Check error codes section for the complete list of error codes and error code descriptions) | |||||||
transaction_ref_id | string | 20 | The tracking_id sent in the request will be sent back in response in this field. | |||||||
body | card_identifier_id | string | 32 | 454545XXXXXX1234 | ||||||
card_identifier_type | string | 20 | CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS | |||||||
response_code | string | |||||||||
status | string | 1 | Status of the request |
{
"NISrvResponse": {
"response_card_transaction": {
"header": {
"msg_id": "89658",
"msg_type": "TRANSACTION",
"msg_function": "REP_CARD_TRANSACTION",
"src_application": "BNK",
"target_application": "WAY4",
"timestamp": "2024-03-19T14:56:14.784+04:00",
"bank_id": "NIC"
},
"exception_details": {
"application_name": "TCC-ADP",
"date_time": "2024-03-19T14:56:14.784+04:00",
"status": "S",
"error_code": "000",
"error_description": "Success"
},
"body": {
"card_identifier_id": "99984100111514120378",
"card_identifier_type": "EXID",
"response_code": "0",
"status": "Waiting"
}
}
}
}
Code | Description |
---|---|
200 | Sample Description |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
500 | Internal Server Error |
502 | Bad gateway |
503 | Scheduled Maintenance |
504 | Gateway Timeout |
596 | Service Not Found |
How It Works
Follow the steps below. For more details, read the Quick Start Guide.
1- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
2- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
3- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
4- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
5- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.