Inquiry SMS
About Inquiry SMS
The Merchant uses this API to check transmission status using InquiryMMs API (only successful SMS transmission status).
Specification for Inquiry SMS
API url | /nicepay/direct/v2/sms-check-status |
|---|---|
Request Method | POST, JSON |
Merchant Token | SHA256 (timestamp+ iMid+ tXid+ merchantKey) |
Request Parameter for Inquiry SMS
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
timeStamp Required | N | 14 | API Request Date | 20221219110059 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST10202212191102221919 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
msgRefno Required | ANS | 40 | Merchant Order Number | MSG-20221219110053 |
merchantToken Required | AN | 255 | Merchant Token | e14233565538732e4273338e8b9ac36618028ffce810747913cd5e39b3fee4f9 |
Response Parameter for Inquiry SMS
Response Objects can be added without prior notification .
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
resultCd | N | 4 | Result Code: | 0000 |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID (Key from NICEPAY) | IONPAYTEST10202212191102221919 When Success |
transDt | N | 8 | Transmission Date | 20221219 |
transTm | N | 6 | Transmission Time | 110222 |
msgRefno | ANS | 40 | Merchant Order Number (Key from Merchant) | MSG-20221219110059 |
recipientNo | N | 16 | Receiver Phone Number | 081294529025 or 6281294529025 When Success |
msgStatus | N | 2 | 00 |
Sample JSON
{
"timeStamp":"20221219110059",
"msgRefno":"MSG-20221219110059",
"iMid":"IONPAYTEST",
"tXid":"IONPAYTEST10202212191102221919",
"merchantToken":"e14233565538732e4273338e8b9ac36618028ffce810747913cd5e39b3fee4f9"
}
See also
Visit the SMS Transmit page to know detail SMS API used to sending message.
Visit the Notification SMS page to learn SMS API detail used to send notification.