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.
Get Account Transactions
Status:
Production
Version:
V2
Category:
Transactions
Overview
Account Transaction Details are designed to give businesses access to granular information about individual transactions associated with specific accounts. This API enables the retrieval of comprehensive details for each transaction, including timestamps, transaction types, amounts, and involved parties. By leveraging this API, businesses can streamline financial analysis, reconcile accounts efficiently, and gain valuable insights into transactional patterns and trends.
How It Works
The Account Transaction Details API functions by sending the account ID, transaction type, and dates as parameters. With this information, the API retrieves all related transaction details for the specified account and provides them in the API response.
Overview
Account Transaction Details are designed to give businesses access to granular information about individual transactions associated with specific accounts. This API enables the retrieval of comprehensive details for each transaction, including timestamps, transaction types, amounts, and involved parties. By leveraging this API, businesses can streamline financial analysis, reconcile accounts efficiently, and gain valuable insights into transactional patterns and trends.
How It Works
The Account Transaction Details API functions by sending the account ID, transaction type, and dates as parameters. With this information, the API retrieves all related transaction details for the specified account and provides them in the API response.
Get Account Transactions
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_get_account_transactions | 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 | Message functions: Should be “REQ_GET_ACCOUNT_TRANSACTIONS” | |||||||
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 | account_identifier_id | string | 32 | Account Identifier | ||||||
account_identifier_type | string | 20 | CONTRACT_NUMBER/RBS_NUMBER | |||||||
transaction_type | string | 16 | authorized, time_based/posted, statemented | |||||||
date_from | string | 10 | Format DD/MM/YYYY. Maximum interval is 90days. Conditional for posted. | |||||||
date_to | string | 10 | Format DD/MM/YYYY. Maximum interval is 90days.Conditional for posted | |||||||
statement_period | string | 4 | Format YYMM (Maximum statement is 12 months from the current date). | |||||||
no_of_transactions_requested | string | 2 | Maximum number of transactions to be fetched in a request. Value should be between 1 and 99 default is 50 | |||||||
requested_page_no | string | 4 | Page number of the current request, could be from 1 to 99. | |||||||
return_mcc_group | string | 4 | To retrun MCC group | |||||||
condition_filter | string | 255 | Filter for aggregate transactions |
{
"NISrvRequest": {
"request_get_account_transactions": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REQ_GET_ACCOUNT_TRANSACTIONS",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"bank_id": "NIC"
},
"body": {
"account_identifier_id": "454545XXXXXX1234",
"account_identifier_type": "CONTRACT_NUMBER\/RBS_NUMBER",
"transaction_type": "posted",
"date_from": "01\/12\/2022",
"date_to": "29\/12\/2022",
"statement_period": "0123",
"no_of_transactions_requested": "55",
"requested_page_no": "55",
"return_mcc_group": "true"
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_get_account_transactions | 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 “ENQUIRY” | |||||||
msg_function | string | 50 | Message functions: Should be “REP_GET_CARD_TRANSACTIONS” | |||||||
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 response Date & time Format DD/MM/YYYY HH:MM:SS | |||||||
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 | account_identifier_id | string | 32 | Account identifier | ||||||
account_identifier_type | string | 20 | CONTRACT_NUMBER or EXID | |||||||
transaction_type | string | 16 | Type of the Account transaction the expected values are - authorized, time_based/posted, statemented | |||||||
date_from | string | 10 | Format YYYY-MM-DD Conditional for posted | |||||||
date_to | string | 10 | Format YYYY-MM-DD Conditional for posted | |||||||
statement_period | string | 4 | Format YYMM Conditional Mandatory for statemented | |||||||
no_of_transactions_returned | string | 3 | Number of transactions | |||||||
no_of_transactions_requested | string | 2 | Maximum number of transactions to be fetched in a request. Value should be between 1 and 99 default is 50 | |||||||
requested_page_no | string | 4 | Page number of the current request, could be from 1 to 99. | |||||||
total_no_of_pages | string | 2 | Total number of requests | |||||||
condition_filter | string | 255 | Condition_filter provided in request | |||||||
transaction | 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 | ||||||
card_identifier_id | string | 32 | card_identifier_id | |||||||
masked_pan | string | 16 | Pan in Masked form | |||||||
trans_date | string | 10 | Transaction date & the format is DD/MM/YYYY | |||||||
post_date | string | 10 | Posting date & the format is DD/MM/YYYY | |||||||
debit_credit_flag | string | 1 | Type of direction | |||||||
response_code | string | 3 | Return code | |||||||
description | string | 255 | Transaction description | |||||||
transaction_ref_number | string | 12 | Transaction reference number | |||||||
currency | string | 3 | Currency code Ex: AED | |||||||
amount | string | 20 | Amount | |||||||
source_currency | string | 3 | Transaction Currency | |||||||
source_amount | string | 20 | Transaction amount | |||||||
auth_code | string | 32 | Authorization code | |||||||
merchant_id | string | 32 | Merchant ID number | |||||||
merchant_category_code | string | 4 | SIC | |||||||
merchant_name | string | 64 | Merchant Name | |||||||
merchant_city | string | 64 | Merchant City | |||||||
merchant_country | string | 64 | Merchant Country | |||||||
transaction_code | string | 32 | Transaction code | |||||||
merchant_category_group | string | 20 | Category Group | |||||||
trans_id | string | 20 | Transaction Id | |||||||
balance_type | string | 20 | RETAIL | |||||||
loyalty_code | string | 32 | Loyalty Code | |||||||
loyalty_amount | string | 32 | Loyalty amount | |||||||
loyalty_currency | string | 32 | Loyalty currency | |||||||
labels | string | 32 | Labels | |||||||
transaction_category | string | 32 | Transaction Category | |||||||
original_contract | string | 32 | Original Contract |
{
"NISrvResponse": {
"response_get_account_transactions": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REP_GET_ACCOUNT_TRANSACTIONS",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"bank_id": "NIC"
},
"exception_details": {
"application_name": "TCC-ADP",
"date_time": "2023-02-01T16:39:47.314+04:00",
"status": "S",
"error_code": "000",
"error_description": "Success",
"transaction_ref_id": "236001"
},
"body": {
"account_identifier_id": "454545XXXXXX1234",
"account_identifier_type": "CONTRACT_NUMBER or EXID",
"transaction_type": "authorized",
"date_from": "2021-02-02T00:00:00.000Z",
"date_to": "2021-10-02T00:00:00.000Z",
"statement_period": "312",
"no_of_transactions_returned": "019",
"no_of_transactions_requested": "55",
"requested_page_no": "55",
"total_no_of_pages": "55",
"transaction": {
"card_identifier_type": "EXID",
"card_identifier_id": "454545XXXXXX1234",
"masked_pan": "454545XXXXXX1234",
"trans_date": "01\/12\/2022",
"post_date": "04\/12\/2022",
"debit_credit_flag": "D",
"response_code": "00",
"description": "",
"transaction_ref_number": "00",
"currency": "AED",
"amount": "210.00",
"source_currency": "AED",
"source_amount": "210.00",
"auth_code": "",
"merchant_id": "",
"merchant_category_code": "",
"merchant_name": "",
"merchant_city": "",
"merchant_country": "",
"transaction_code": "",
"merchant_category_group": "",
"trans_id": "",
"balance_type": ""
}
}
}
}
}
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.