- Previous: Version2
- Up: Version2
- Next: Get Eligible Plans
Get Eligible Transactions
Request Parameters:
Node | Child Node | Type | Max | Description | Remarks |
header | msg_id | A/N | 12 | Unique Source Message ID | Mandatory |
msg_type | String | 12 | Request Type Default: "ENQUIRY" | Mandatory | |
msg_function | String | 50 | Function name to be used Default: "REQ_GET_CARD_TRANSACTION" | Mandatory | |
src_application | String | 10 | Source requesting channel e.g. “IB” or "IVR" etc. Might change. | Mandatory | |
target_application | String | 10 | Target application name Ex. : "WAY4" or "DCMS" or "PCMS" | Mandatory | |
timestamp | String | 30 | Timestamp of the request Format “DD/MM/YYYY HH:MM:SS” | Mandatory | |
tracking_id | String | 15 | Transaction Tracking Id | Optional | |
bank_id | String | 4 | Source Bank Id e.g. “XXXX” | Mandatory | |
instance_id | String | 10 | N/A | Optional | |
body | card_identifier_id | String | 32 | 454545XXXXXX1234 | Mandatory |
card_identifier_type | String | 20 | CONTRACT_NUMBER or EXID | Mandatory | |
transaction_type | String | 16 | authorized, time_based/posted, statemented,instalment | Mandatory | |
date_from | String | 10 | Format YYYY-MM-DD.Maximum interval is 90days. Maxim from date is 12 months from the current date. | Conditional for posted. | |
date_to | String | 10 | Format YYYY-MM-DD.Maximum interval is 90days | Conditional for posted | |
statement_period | String | 4 | Format YYMM (Maximum statement is 12 months from the current date) | Conditional Mandatory for statemented | |
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 | Optional | |
requested_page_no | String | 4 | Page number of the current request, could be from 1 to 99. | Optional | |
plan_number | String | 5 | Plan Number | Optional |
Request Json
{
"NISrvRequest":{
"request_get_card_transactions":{
"header":{
"msg_id":"236001",
"msg_type":"ENQUIRY",
"msg_function":"REQ_GET_CARD_TRANSACTION",
"src_application":"IVR",
"target_application":"WAY4",
"timestamp":"2022-11-16T10:49:02.366+04:00",
"tracking_id":"236001",
"bank_id":"bankID"
},
"body":{
"card_identifier_id":"454545XXXXXX1234",
"card_identifier_type":"CONTRACT_NUMBER/EXID",
"transaction_type":"instalment",
"date_from": "",
"date_to": "",
"statement_period": "",
"no_of_transactions_requested":"",
"requested_page_no":"",
"plan_number":""
}
}
}
}
Response Parameters:
Node |
Child Node |
Data |
Max |
Description |
Remarks |
||
header |
msg_id |
String |
12 |
The msg_id sent in the request will be sent back in response in this field. |
Mandatory |
||
Unique Source Message ID e.g. “ada123456fdsf” |
|||||||
msg_type |
String |
12 |
msg_type sent in the request will be sent back in response in this field. |
Mandatory |
|||
msg_function |
String |
50 |
Function name to be used Default: "REP_GET_CARD_TRANSACTION" |
Mandatory |
|||
src_application |
String |
10 |
The src_application sent in the request will be sent back in response in this field. |
Mandatory |
|||
Source requesting channel e.g. “IB” or "IVR" etc |
|||||||
target_application |
String |
10 |
The target_application sent in the request will be sent back in response in this field. |
Mandatory |
|||
timestamp |
String |
30 |
Timestamp of the response |
Mandatory |
|||
Date & time. Format “DD/MM/YYYY HH:MM:SS” |
|||||||
tracking_id |
String |
15 |
The tracking_id sent in the request will be sent back in response in this field. |
Optional |
|||
bank_id |
String |
4 |
The bank_id sent in the request will be sent back in response in this field. E.g. ‘ABCD |
Mandatory |
|||
instance_id |
String |
10 |
N/A |
Optional |
|||
exception_details |
application_name |
String |
20 |
Tibco Application Name |
Mandatory |
||
date_time |
String |
30 |
Timestamp of the response |
Mandatory |
|||
Format “DD/MM/YYYY HH:MM:SS” |
|||||||
status |
String |
1 |
Status of the request (S/F) |
Mandatory |
|||
Success- S, Failure - F |
|||||||
error_code |
String |
4 |
EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) |
Mandatory |
|||
error_description |
String |
100 |
Error Description (Check error codes section for the complete list of error codes and error code descriptions) |
Mandatory |
|||
transaction_ref_id |
String |
20 |
The tracking_id sent in the request will be sent back in response in this field. |
Optional |
|||
body |
card_identifier_id |
String |
Min – 16 to Max - 19 |
16/19-digit card no |
Mandatory |
||
e.g: XXXXXXXXXXXX0833 |
|||||||
First 6 digits will be BIN for cards |
|||||||
card_identifier_type |
String |
20 |
CONTRACT_NUMBER or EXID |
Mandatory |
|||
transaction_type |
String |
16 |
authorized, time_based/posted, statemented |
Mandatory |
|||
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 |
Mandatory |
|||
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 |
Optional |
|||
requested_page_no |
String |
2 |
Page number of the current request, could be from 1 to 99 |
Optional |
|||
total_no_of_pages |
String |
2 |
Total number of requests |
Optional |
|||
transactions |
card_identifier_id |
String |
Min – 16 to Max - 19 |
16/19-digit card no |
Mandatory |
||
card_identifier_type |
String |
20 |
CONTRACT_NUMBER or EXID |
Mandatory |
|||
trans_date |
Date |
Format |
Transaction date |
Mandatory |
|||
post_date |
Date |
Format |
Posting date |
Mandatory |
|||
debit_credit_flag |
String |
1 |
Type of direction |
Mandatory |
|||
response_code |
Number |
3 |
Return code |
Mandatory |
|||
description |
String |
255 |
Transaction description |
Mandatory |
|||
transaction_ref_number |
String |
12 |
Transaction reference number |
Mandatory |
|||
currency |
String |
3 |
Currency |
Mandatory |
|||
amount |
String |
20 |
Amount |
Mandatory |
|||
source_currency |
String |
3 |
Trans currency |
Mandatory |
|||
source_amount |
String |
20 |
Trans amount |
Mandatory |
|||
auth_code |
String |
32 |
Authorization code |
Optional |
|||
merchant_id |
String |
32 |
Merchant ID number |
Optional |
|||
merchant_category_code |
String |
4 |
SIC |
Optional |
|||
merchant_name |
String |
64 |
Merchant Name |
Optional |
|||
merchant_address |
String |
64 |
Merchant Address |
Optional |
|||
merchant_city |
String |
64 |
Merchant City |
Optional |
|||
merchant_country |
String |
64 |
Merchant Country |
Optional |
|||
transaction_code |
String |
32 |
Transaction code |
Optional |
|||
trans_id |
String |
18 |
Transaction ID |
Mandatory |
|||
balance_type |
String |
64 |
Balance Type |
Mandatory |
Node |
Child Node |
Data |
Max |
Description |
Remarks |
||
header |
msg_id |
String |
12 |
The msg_id sent in the request will be sent back in response in this field. |
Mandatory |
||
Unique Source Message ID e.g. “ada123456fdsf” |
|||||||
msg_type |
String |
12 |
msg_type sent in the request will be sent back in response in this field. |
Mandatory |
|||
msg_function |
String |
50 |
Function name to be used Default: "REP_GET_CARD_TRANSACTION" |
Mandatory |
|||
src_application |
String |
10 |
The src_application sent in the request will be sent back in response in this field. |
Mandatory |
|||
Source requesting channel e.g. “IB” or "IVR" etc |
|||||||
target_application |
String |
10 |
The target_application sent in the request will be sent back in response in this field. |
Mandatory |
|||
timestamp |
String |
30 |
Timestamp of the response |
Mandatory |
|||
Date & time. Format “DD/MM/YYYY HH:MM:SS” |
|||||||
tracking_id |
String |
15 |
The tracking_id sent in the request will be sent back in response in this field. |
Optional |
|||
bank_id |
String |
4 |
The bank_id sent in the request will be sent back in response in this field. E.g. ‘ABCD |
Mandatory |
|||
instance_id |
String |
10 |
N/A |
Optional |
|||
exception_details |
application_name |
String |
20 |
Tibco Application Name |
Mandatory |
||
date_time |
String |
30 |
Timestamp of the response |
Mandatory |
|||
Format “DD/MM/YYYY HH:MM:SS” |
|||||||
status |
String |
1 |
Status of the request (S/F) |
Mandatory |
|||
Success- S, Failure - F |
|||||||
error_code |
String |
4 |
EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) |
Mandatory |
|||
error_description |
String |
100 |
Error Description (Check error codes section for the complete list of error codes and error code descriptions) |
Mandatory |
|||
transaction_ref_id |
String |
20 |
The tracking_id sent in the request will be sent back in response in this field. |
Optional |
|||
body |
card_identifier_id |
String |
Min – 16 to Max - 19 |
16/19-digit card no |
Mandatory |
||
e.g: XXXXXXXXXXXX0833 |
|||||||
First 6 digits will be BIN for cards |
|||||||
card_identifier_type |
String |
20 |
CONTRACT_NUMBER or EXID |
Mandatory |
|||
transaction_type |
String |
16 |
authorized, time_based/posted, statemented |
Mandatory |
|||
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 |
Mandatory |
|||
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 |
Optional |
|||
requested_page_no |
String |
2 |
Page number of the current request, could be from 1 to 99 |
Optional |
|||
total_no_of_pages |
String |
2 |
Total number of requests |
Optional |
|||
transactions |
card_identifier_id |
String |
Min – 16 to Max - 19 |
16/19-digit card no |
Mandatory |
||
card_identifier_type |
String |
20 |
CONTRACT_NUMBER or EXID |
Mandatory |
|||
trans_date |
Date |
Format |
Transaction date |
Mandatory |
|||
post_date |
Date |
Format |
Posting date |
Mandatory |
|||
debit_credit_flag |
String |
1 |
Type of direction |
Mandatory |
|||
response_code |
Number |
3 |
Return code |
Mandatory |
|||
description |
String |
255 |
Transaction description |
Mandatory |
|||
transaction_ref_number |
String |
12 |
Transaction reference number |
Mandatory |
|||
currency |
String |
3 |
Currency |
Mandatory |
|||
amount |
String |
20 |
Amount |
Mandatory |
|||
source_currency |
String |
3 |
Trans currency |
Mandatory |
|||
source_amount |
String |
20 |
Trans amount |
Mandatory |
|||
auth_code |
String |
32 |
Authorization code |
Optional |
|||
merchant_id |
String |
32 |
Merchant ID number |
Optional |
|||
merchant_category_code |
String |
4 |
SIC |
Optional |
|||
merchant_name |
String |
64 |
Merchant Name |
Optional |
|||
merchant_address |
String |
64 |
Merchant Address |
Optional |
|||
merchant_city |
String |
64 |
Merchant City |
Optional |
|||
merchant_country |
String |
64 |
Merchant Country |
Optional |
|||
transaction_code |
String |
32 |
Transaction code |
Optional |
|||
trans_id |
String |
18 |
Transaction ID |
Mandatory |
|||
balance_type |
String |
64 |
Balance Type |
Mandatory |
Response JSON
{
"NISrvResponse":{
"response_get_card_transactions":{
"header":{
"msg_id":"56000",
"msg_type":"ENQUIRY",
"msg_function":"REP_GET_CARD_TRANSACTION",
"src_application":"IVR",
"target_application":"WAY4",
"timestamp":"2022-11-16T11:06:36.588+04:00",
"tracking_id":"56000",
"bank_id":"NIC",
"instance_id":"56000"
},
"exception_details":{
"application_name":"NITIB_TCC_ADP_SSP_1",
"date_time":"2022-11-16T10:33:47.934+04:00",
"status":"S",
"error_code":"000",
"error_description":"Success",
"transaction_ref_id":null
},
"body": {
"card_identifier_id":"454545XXXXXX1234",
"card_identifier_type":"CONTRACT_NUMBER/EXID",
"transaction_type": "",
"date_from": "",
"date_to": "",
"statement_period": "",
"no_of_transactions_returned": "",
"no_of_transactions_requested": "",
"requested_page_no": "",
"total_no_of_pages": "",
"transactions": {
"card_identifier_id":"454545XXXXXX1234",
"card_identifier_type":"CONTRACT_NUMBER/EXID",
"trans_date": "",
"post_date": "",
"debit_credit_flag": "",
"response_code": "",
"description": "",
"transaction_ref_number": "",
"currency": "",
"amount": "",
"source_currency": "",
"source_amount": "",
"auth_code": "",
"merchant_id": "",
"merchant_category_code": "",
"merchant_name": "",
"merchant_address": "",
"merchant_city": "",
"merchant_country": "",
"transaction_code": "",
"trans_id": "",
"balance_type": ""
}
}
}
}
}
- Previous: Version2
- Up: Version2
- Next: Get Eligible Plans
Docs Navigation
- API Security
- Falcon Services
- Card Services
- BETA
- Version 1.0
- Card Balance Enquiry
- Card Activation
- Card Set Pin
- Card Change PIN
- Card PIN Verification
- Card Status Update
- Card Limit Update
- Card Details
- Customer Details
- List Of Cards
- Customer Demographic Update
- Card Used Limits
- Card Statement Summary
- Card Transaction
- Utility Payments
- Account Create
- Account Update
- Account Closure
- Card Create
- Card Update
- Card Replacement
- Client Create
- Client Update
- Transaction Details
- PIN Retries Counter Reset
- Digital Status Chnage
- Get CVV2 Service
- Card Link Delink
- Card Insurance Products
- Card Change Insurance Product Status
- Card Direct Debit
- Update Card Direct Debit
- Card Balance Conversion Enquiry
- Card Balance Conversion
- Card Transaction Eligibility
- Card Transaction EPP Conversion
- Card Replacement Embossing
- Card NMON Transactions
- Retail Banking Transactions
- Appendix 1
- Appendix 2
- Appendix 3
- Appendix 4
- HTTP Codes
- Error Codes
- Version 2.0
- Lookup Card Identifier
- List Of Cards
- Card Activation
- Card Set PIN
- Card Change PIN
- Card Status Update
- Client Create
- Account Create
- Card Create
- Customer Demographic Update
- Account Update
- Card Update
- Card Replacement
- Customer Details
- Card Details
- Client Update
- Card Balance Enquiry
- Card Transaction
- Card Limit Update
- Card PIN Verification
- PIN Retried Counter Reset
- Get CVV2 Service
- Card Verification
- Card Transaction Details
- Get Encryption Certificate
- Get Dictionaries MCC
- Get Account Balance
- Card Insurance Product
- Card Insurance Product Update
- Card Direct Debit Update
- Card Direct Debit
- P2P Transfer
- Account Transaction
- Account Status Change
- Card Statement Summary
- Account Transaction Details
- Card Contact Details
- List of Accounts
- Account Hierarchy
- Notification Service
- Appendix 1
- Appendix 2
- Appendix 3
- Appendix 4
- HTTP Codes
- Error Codes
- Buy Now Pay Later
- Card Limits
- Insurance Services
- Webhook Services
- Switch Services
- Card Control Services
- Merchant Digital Onboarding
- Notification Service
- SMS Security Services
- Terms and Condition
0 Comments
Please sign in to post a comment.