- Previous: Notification Service
- Up: Notification Service
- Next: Error Codes
SMS and Email Notification
Request Parameters:
Node |
Child Node |
Type |
Max |
Description |
Remarks |
||
header |
msg_id |
String |
12 |
Unique Source Message ID |
Mandatory |
||
msg_type |
String |
12 |
Request Type Default: "TRANSACTION" |
Mandatory |
|||
msg_function |
String |
50 |
Function name to be used Default: "REQ_SEND_NOTIFICATION" |
Mandatory |
|||
src_application |
String |
10 |
Source requesting channel Ex: “softPOS”. Might change. |
Mandatory |
|||
target_application |
String |
10 |
Target application name Ex. : "TIBCO" |
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 Ex: NI-Test |
Mandatory |
|||
body |
acquirer_id |
Num |
15 |
Acquirer ID |
Mandetory |
||
merchant_id |
Num |
12 |
Merchant ID |
Mandetory |
|||
terminal_id |
Num |
12 |
Terniaml ID |
Mandetory |
|||
comm_type_field |
string |
12 |
Type of communication |
Mandetory |
|||
merchant_name |
string |
30 |
Name of the merchant |
Mandetory |
|||
merchant_city |
string |
20 |
City |
Mandetory |
|||
merchant_mobile_number |
string |
14 |
Mechant mobile number |
Mandetory |
|||
merchant_email_addres |
string |
30 |
Mechant Email ID |
Mandetory |
|||
This userid group required only if comm_type_field is userid |
|||||||
userid |
merchant_uid |
String |
30 |
|
Mandetory |
||
This userid group required only if comm_type_field is otp |
|||||||
otp |
merchant_uid |
String |
30 |
Merchant UID |
Conditional |
||
otp_value |
|
50 |
PT Text |
Conditional |
|||
This userid group required only if comm_type_field is transaction_reciept |
|||||||
transaction_receipt |
transaction_type |
string |
30 |
Transaction Type |
Conditional |
||
txn_seq_number |
string |
12 |
Transaction Sequence Number |
Conditional |
|||
transaction_amount |
string |
12 |
Transaction Amount |
Conditional |
|||
transaction_tip_amount | string | 12 | Transaction TIP amount | Conditional | |||
rrn | string | 20 |
Retrieval Reference Number
|
Conditional | |||
transaction_currency |
string |
3 |
Currency of the transaction |
Conditional |
|||
transaction_date |
date |
10 |
Date of the transaction |
Conditional |
|||
transaction_time |
time |
11 |
Transaction time |
Conditional |
|||
card_scheme |
string |
6 |
Card Scheme Name |
Conditional |
|||
card_num |
string |
19 |
Card Number |
Conditional |
|||
contactless_withpin |
string |
1 |
Contactless with Pin (Y/N) |
Conditional |
|||
auth_code |
Num |
10 |
Authtorisation code |
Conditional |
|||
reject_reason |
string |
20 |
reason for rejection |
Conditional |
|||
customer_mobile |
string |
12 |
Customer Mobile number with country code |
Conditional |
|||
customer_email |
string |
20 |
Customer Email ID |
Conditional |
|||
transaction_receipt_link | string | 100 | Transaction receipt link | Conditional |
Request Json
{
"NISrvRequest":{
"request_notification_service":{
"header":{
"msg_id":"1234",
"msg_type":"TRANSACTION",
"msg_function":"REQ_SEND_NOTIFICATION",
"src_application":"SoftPOS",
"target_application":"TIBCO",
"timestamp":"2021-06-13T19:27:50.829+05:30",
"tracking_id":"1234",
"bank_id":"NI"
},
"body":{
"acquirer_id":"12451245",
"merchant_id":"23452345",
"terminal_id":"56565656",
"comm_type_field":"trn_receipt",
"merchant_name":"Test",
"merchant_city":"Sharjah",
"merchant_mobile_number":"+971123456789",
"merchant_email_address":"test@gmail.com",
"userid":{
"merchant_uid":"123"
},
"otp":{
"merchant_uid":"123",
"otp_value":"123456"
},
"transaction_receipt":{
"transaction_type":"test",
"txn_seq_number":"123",
"transaction_amount":"12",
"transaction_tip_amount":"1",
"rrn":"12345678",
"transaction_currency":"AED",
"transaction_date":"2021-06-13+05:30",
"transaction_time":"10:04:53.93",
"card_scheme":"VISA",
"card_num":"4561234561231234",
"contactless_withpin":"Y",
"auth_code":"456789",
"reject_reason":"Reject",
"customer_mobile":"+971123456789",
"customer_email":"test@gmail.com",
"transaction_receipt_link":"https://tinyurl.com/ye9dfbyt"
}
}
}
}
}
Response parameters:
Node |
Child Node |
Type |
Max |
Description |
Remarks |
header |
msg_id |
String |
12 |
The msg_id sent in the request will be sent back in response in this field. Unique Source Message ID e.g. “ada123456fdsf” |
Mandatory |
msg_type |
String |
12 |
msg_type sent in the request will be sent back in response in this field. |
Mandatory |
|
msg_function |
String |
50 |
Default: “REQ_SEND_NOTIFICATION” |
Mandatory |
|
src_application |
String |
10 |
The src_application sent in the request will be sent back in response in this field. Source requesting channel e.g. “softPOS” |
Mandatory |
|
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 Date & time. Format “DD/MM/YYYY HH:MM:SS” |
Mandatory |
|
tracking_id |
String |
15 |
The tracking_id sent in the request will be sent back in response in this field. N/A |
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 Format “DD/MM/YYYY HH:MM:SS” |
Mandatory |
|
status |
String |
1 |
Status of the request (S/F) Success- S, Failure - F |
Mandatory |
|
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 |
Response Json
{
"NISrvResponse":{
"response_card_activation":{
"header":{
"msg_id":"223001",
"msg_type":"TRANSACTION",
"msg_function":"REQ_SEND_NOTIFICATION",
"src_application":"softPOS",
"target_application":"TIBCO",
"timestamp":"19/07/2020 12:59:23",
"tracking_id":"223001",
"bank_id":"NI-Test"
},
"exception_details":{
"application_name":"NITIB_TCC_ADP_SSP_1",
"date_time":"2020-07-19T12:57:49.439+04:00",
"status":"S",
"error_code":"000",
"error_description":"Success",
"transaction_ref_id":null
}
}
}
}
- Previous: Notification Service
- Up: Notification Service
- Next: Error Codes
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.