Notification - API Checkout
NICEPAY sends push notification through Merchant's dbProcessUrl. The Merchant needs to reassure there is no Blacklist NICEPAY IP and should Whitelist NICEPAY IP to get the push notification only from NICEPAY's server.
Method | POST |
Merchant Token | SHA256 ( iMid+ tXid + amt+ merchantKey) |
IP | 103.20.51.0/24 103.117.8.0/24 |
User-Agent | User-Agent: Jakarta Commons-HttpClient/3.1 |
Parameter | Type | Size | Description | Example / Notes |
tXid | N | 30 | Transaction ID | |
merchantToken | AN | 255 | Merchant Token | |
referenceNo | ANS | 40 | Merchant Order Number | |
payMethod | N | 2 | | |
amt | N | 12 | Payment Amount | |
transDt | N | 8 | Transaction Date | |
transTm | N | 6 | Transaction Time | |
currency | A | 3 | Currency | |
goodsNm | AN | 100 | Goods Name | |
billingNm | A | 100 | Billing Name | |
matchCl | N | 1 | Payment Amount Match Flag: Notification Match Amount Indicator | |
status | A | 1 | |
When notification is received to your dbProcessUrl, NICEPAY strongly recommend Merchant to verify the notification again by using Status Inquiry - API Checkout.
Parameter | Type | Size | Description | Example / Notes |
authNo | N | 10 | Approval Number | |
IssueBankCd | A | 4 | | |
IssueBankNm | A | 255 | Issuing Bank Name | |
acquBankCd | A | 4 | | |
acquBankNm | A | 255 | Acquiring Bank Name | |
cardNo | ANS | 20 | Card Number With Masking | |
cardExpYymm | N | 4 | Card Expiration (YYMM) | |
instmntMon | N | 2 | Installment Month 1: 1 Month/Full Payment, if instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months | |
instmntType | N | 2 | | |
preauthToken | AN | 255 | Pre-Auth Token | |
recurringToken | AN | 255 | Recurring token | |
ccTransType | A | 2 | | |
vat | N | 12 | Vat Number | |
fee | N | 12 | Service Fee | |
notaxAmt | N | 12 | Tax Free Amount | |
Parameter | Type | Size | Description | Example / Notes |
bankCd | A | 4 | | |
vacctNo | N | 16 | Bank VA Number | |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) | |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | |
depositDt | N | 8 | Deposit Date (YYYYMMDD) | |
depositTm | N | 6 | Deposit Time (HH24MISS) | |
Parameter | Type | Size | Description | Example / Notes |
mitraCd | A | 4 | | |
payNo | N | 12 | Payment Number | |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) | |
payValidTm | N | 6 | Expiry Time (HH24MISS) | |
receiptCode | ANS | 20 | Authorization Number | |
mRefNo | AN | 18 | Reference Number | |
depositDt | N | 8 | Deposit Date (YYYYMMDD) | |
depositTm | N | 6 | Deposit Time (HH24MISS) | |
Merchant Token that received from Notification, Merchant must do internally re-compared to prevent the invalid/fake notification.