Notification - API Virtual Account
NICEPAY provides push notifications via dbProcessUrl Merchant. 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.
Request 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 |
When your dbProcessUrl received a notification, NICEPAY strongly recommend Merchant to verify the notification using the Status Inquiry - API Virtual Account.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
tXid | N | 30 | Transaction ID | IONPAYTEST02202212141423372834 |
merchantToken | AN | 255 | Merchant Token | 76a7ea699351eef2ffd1ade233547ed7f3b44aea5859aee7c2250bff1bae7dc9 |
referenceNo | ANS | 40 | Merchant Order Number | order123 |
payMethod | N | 2 | | |
amt | N | 12 | Payment amount | 10000 |
vacctNo | N | 20 | VA Number | 70014000091423372834 |
transTm | N | 6 | Transaction time | 142527 |
transDt | N | 8 | Transaction date | 20221214 |
instmntType | N | 2 | 1 | |
instmntMon | N | 2 | Installment Month | null |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | 142337 |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) | 20221216 |
currency | A | 3 | Currency | |
goodsNm | AN | 100 | Goods name | Test+Transaction+Nicepay |
billingNm | A | 100 | Billing name | Customer Name |
status | A | 1 | 0 | |
matchCl | N | 1 | Payment Flag: Notification Match Amount Indicator | 1 |
Parameter | Type | Size | Descriprion |
|---|---|---|---|
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) |
The Merchant Token received by the Notification Endpoint must compare internally to prevent fake/invalid notifications.
💡Example Case:
For example, you have a merchantKey that is used to generate a token, which is 1234. When the merchantToken generated by the Merchant is known, it is abcd, while the merchantToken obtained in the notification is abdd. Then the notification is considered fake/invalid.
⚠️ Pay attention to the reversal process that can occur in a Virtual Account. For reversal status on Virtual Accounts, notifications will automatically be sent from the Bank to the Customer as a failed transaction. NICEPAY will forward the notification regarding the reversal process to the Merchant to be handled further by the Merchant as a status update to failed/cancel. Please learn more about VA Transaction Settlement.
