--- title: Notification - API Checkout slug: en/nicepay-api-notification-api-checkout description: Information about API Checkout - Notification for all payment methods provided by NICEPAY image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/X5iLvnCV27TKW6bmuBr1I_microsoftteams-image.png icon: {"faIcon":"fa-solid fa-book"} docTags: createdAt: 2022-11-22T08:00:04.000Z --- # About API Checkout Notification *** 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. # API Checkout Notification *** | **Method** | `POST` | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Merchant Token** | SHA256 ( `iMid`+ `tXid` + `amt`+ `merchantKey`) | | **IP** | IP Public environtment Production:
`103.20.51.34`
`103.20.51.33`
`18.98.96.50`

IP Public environtment Dev:
`103.20.51.39`
`103.20.51.40`
`18.98.96.54` | | **User-Agent** | `User-Agent: Jakarta Commons-HttpClient/3.1` | ## Notification Parameter | **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 | [Payment Method Code](docId\:NQ1y7vMa25ZtvQHN5He6W) | | | `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](docId\:HheZYw5iKlIptKqYyA5bI) | | | `status` | A | 1 | Deposit Status: [Notification Status Code](docId\:QUmT9FmvjDH5GJHd2PWy8)
`0` : Deposit
`1` : Reversal | | :::hint{type="info"} When notification is received to your `dbProcessUrl`, NICEPAY strongly recommend Merchant to verify the notification again by using [Status Inquiry - API Checkout](docId\:RhH7PmISd6IHN99yWVJHm). ::: ### Additional Parameter for Credit Card Notification | **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** | | ---------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | | `authNo` | N | 10 | Approval Number | | | `IssueBankCd` | A | 4 | [Issuing Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0) | | | `IssueBankNm` | A | 255 | Issuing Bank Name | | | `acquBankCd` | A | 4 | [Acquiring Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0) | | | `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 | [Installment Type Code](docId:_Wzur5wjwhrDR8YXI-Ppi) | | | `preauthToken` | AN | 255 | Pre-Auth Token | | | `recurringToken` | AN | 255 | Recurring token | | | `ccTransType` | A | 2 | Credit Card Transaction Type:
`1` : Normal
`2` : Recurring
`3` : Pre-auth
`4` : Captured | | | `vat` | N | 12 | VAT Number | | | `fee` | N | 12 | Service Fee | | | `notaxAmt` | N | 12 | Tax Free Amount | | ### Additional Parameter for Virtual Account Notification | **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** | | -------------- | -------- | -------- | ------------------------------------------ | ------------------- | | `bankCd` | A | 4 | [Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0) | | | `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`) | | ### Additional Parameter for Others Payment Method Notification | **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** | | ------------- | -------- | -------- | ------------------------------------------ | ------------------- | | `mitraCd` | A | 4 | [Mitra Code](docId:0luP35KfOWksiSrzKx6yZ) | | | `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`) | | :::hint{type="warning"} Merchant Token that received from Notification, Merchant must do internally re-compared to prevent the invalid/fake notification. ::: ## Sample for Notification Parameter *** :::CodeblockTabs Sample POST for Notification ```none tXid={tXid} referenceNo={referenceNo} amt={amt} merchantToken={merchantToken} matchCl={matchCl} status={status} bankCd={bankCd} vacctNo={vacctNo} authNo={authNo} cardNo={cardNo} issuBankCd = {issuBankCd} issuBankNm = {issuBankNm} acquBankCd = {acquBankCd} acquBankNm = {acquBankNm} depositDt = {depositDt} depositTm = {depositTm} payNo={payNo} ``` :::