---
title: Notification - API Checkout
slug: nicepay-api-notification-api-checkout
description: Informasi tentang API Checkout - Notification untuk semua metode pembayaran yang disediakan oleh NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/UQk7CJb_3GtxX4WH5dD9T_rdrx9d8diazpgm07xfz2test-1.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2022-11-22T08:00:04.000Z
---
# Tentang Notification - API Checkout
***
NICEPAY mengirimkan *push notification* melalui `dbProcessUrl` Merchant. Merchant harus memastikan tidak melakukan Blacklist IP NICEPAY dan melakukan Whitelist IP NICEPAY untuk mendapatkan *push notification* yang hanya dikirim dari server NICEPAY.
# Notification - API Checkout
***
| **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 for Notification - API Checkout
| **Parameter** | **Tipe** | **Ukuran** | **Deskripsi** | **Contoh / Catatan** |
| --------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------- | -------------------- |
| `tXid` | N | 30 | Transaction ID | |
| `merchantToken` | AN | 255 | Merchant Token | |
| `referenceNo` | ANS | 40 | Merchant Order Number | |
| `payMethod` | N | 2 | [Payment Method Code](docId\:g7inRV70XcSA9lP7bpmok) | |
| `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\:WdoGjBeqc1VmRdFJqG1ZE) | |
| `status` | A | 1 | Deposit Status: [Notification Status Code](docId\:CdRwf99UxER6PH64ADA2C)
`0` : Deposit
`1` : Reversal | |
:::hint{type="info"}
Ketika notifikasi diterima pada `dbProcessUrl` Anda, kami sangat menyarankan Merchant untuk melakukan verifikasi notifikasi kembali dengan menggunakan [Status Inquiry - API Checkout](docId\:K9vBS87ev9_w5oJAU0et3).
:::
### Additional Parameter for Credit Card Notification
| **Parameter** | **Tipe** | **Ukuran** | **Deskripsi** | **Contoh / Catatan** |
| ---------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `authNo` | N | 10 | Approval Number | |
| `IssueBankCd` | A | 4 | [Issuing Bank Code](docId:1U7QOax_wrzXMoCG-Mqad) | |
| `IssueBankNm` | A | 255 | Issuing Bank Name | |
| `acquBankCd` | A | 4 | [Acquiring Bank Code](docId:1U7QOax_wrzXMoCG-Mqad) | |
| `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, jika `instmntType`*: null/1*
`3`: 3 Months
`6`: 6 Months
`12`: 12 Months | |
| `instmntType` | N | 2 | [Installment Type Code](docId:7CIX-U_4z295XgtNVEsbO) | |
| `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** | **Tipe** | **Ukuran** | **Deskripsi** | **Contoh / Catatan** |
| -------------- | -------- | ---------- | ----------------------------------------- | -------------------- |
| `bankCd` | A | 4 | [Bank Code](docId:1U7QOax_wrzXMoCG-Mqad) | |
| `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** | **Tipe** | **Ukuran** | **Deskripsi** | **Contoh / Catatan** |
| ------------- | -------- | ---------- | ------------------------------------------- | -------------------- |
| `mitraCd` | A | 4 | [Mitra Code](docId\:DwzaQDD7DXZMECz80A6o8) | |
| `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* yang diterima dari *Notification*, Merchant harus melakukan perbandingan kembali secara internal untuk mencegah notifikasi palsu/tidak berlaku.
:::
## Sample Parameter for Notification - API Checkout
***
### Request Parameter
:::CodeblockTabs
cURL
```curl
curl --location 'https://www.merchant-dbprocessurl.com' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'ccTransType=1' \
--data-urlencode 'fee=0' \
--data-urlencode 'tXid=TESTMPGS0401202510271659168614' \
--data-urlencode 'amt=20' \
--data-urlencode 'notaxAmt=0' \
--data-urlencode 'cardNo=51234500****0008' \
--data-urlencode 'issuBankCd=BTPN' \
--data-urlencode 'matchCl=1' \
--data-urlencode 'preauthToken=null' \
--data-urlencode 'cardExpYymm=3912' \
--data-urlencode 'acquBankNm=CIMB' \
--data-urlencode 'payMethod=01' \
--data-urlencode 'currency=IDR' \
--data-urlencode 'instmntMon=1' \
--data-urlencode 'cc_trans_type=1' \
--data-urlencode 'issuBankNm=BTPN' \
--data-urlencode 'merchantToken=8fb6a2b3748fea22590c58db8679d5b35e0781b33b1ad995823026fc0bcaa882' \
--data-urlencode 'goodsNm=Payment of Reference No 382-20251027165916' \
--data-urlencode 'referenceNo=382-20251027165916' \
--data-urlencode 'authNo=320082' \
--data-urlencode 'transTm=165916' \
--data-urlencode 'cpGuaranteeableStatus=null' \
--data-urlencode 'recurringToken=null' \
--data-urlencode 'vat=0' \
--data-urlencode 'instmntType=1' \
--data-urlencode 'billingNm=Inka Fazarillah' \
--data-urlencode 'acquBankCd=BNIA' \
--data-urlencode 'transDt=20251027' \
--data-urlencode 'status=0'
```
:::
### Response Parameter
:::CodeblockTabs
Sample Response
```json
{
"resultCd": "200",
"resultMsg": "SUCCESS",
}
// Response is customizable, Nicepay will read the http Status Code for success indicator
```
:::