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.
Set FXRates
Status:
Production
Version:
V2
Category:
Transactions
This service is used by an FI to set FX rates for a currency.
This service is used by an FI to set FX rates for a currency.
Set FXRates
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_set_fx_rates | 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_SET_FX_RATES | |||||||
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 | currency | string | 3 | Currency code the rate is setting. | ||||||
fx_type | string | 32 | FX Type code | |||||||
base_currency | string | 3 | Base currency code | |||||||
buy_rate | string | 28 | Buy rate. Dot is used as decimal separator. | |||||||
middle_rate | string | 28 | Middle rate. Dot is used as decimal separator. | |||||||
sell_rate | string | 28 | Sell rate. Dot is used as decimal separator. | |||||||
cb_rate | string | 28 | CB rate. Dot is used as decimal separator. | |||||||
effective_date | string | 28 | Date from when the FX rate is applicable | |||||||
apply_immediately | string | 32 | Flag to apply FX rate immediately | |||||||
apply_mode | string | 32 | How the FX rate should be applied | |||||||
is_cross_rate | string | 2 | Cross-Rate flag | |||||||
user_info | string | 32000 | Data of application user initiated the operation |
{
"NISrvRequest": {
"request_set_fx_rates": {
"header": {
"msg_id": "236001",
"msg_type": "TRANSACTION",
"msg_function": "REQ_SET_FX_RATES",
"src_application": "IVR",
"target_application": "PCMS",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"bank_id": "NIC"
},
"body": {
"currency": "840",
"fx_type": "",
"base_currency": "",
"buy_rate": "",
"middle_rate": "",
"sell_rate": "",
"cb_rate": "",
"effective_date": "",
"apply_immediately": "",
"apply_mode": "HEAD_OFFICE ",
"is_cross_rate": "HEAD_OFFICE ",
"user_info": ""
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_set_fx_rates | 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 - REP_SET_FX_RATES | |||||||
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 | RetCode | string | 18 | Operation result code | ||||||
RetMsg | string | 4000 | Operation result message | |||||||
ResultInfo | string | 32000 | Operation result information |
{
"NISrvResponse": {
"response_set_fx_rates": {
"header": {
"msg_id": "236001",
"msg_type": "TRANSACTION",
"msg_function": "REP_SET_FX_RATES",
"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": {
"RetCode": "0",
"RetMsg": "",
"ResultInfo": ""
}
}
}
}
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.