Notification - API Checkout

9min

About API Checkout Notification
﻿
﻿ sends push  through 's dbProcessUrl. The  needs to reassure there is no Blacklist  IP and should Whitelist  IP to get  push  only from 's server.
﻿
API Checkout Notification
﻿
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
﻿
Notification Parameter
Parameter
Type
Size
Description
Example / Notes
tXid
N
30
Transaction ID
﻿
merchantToken
AN
255
﻿ Token
﻿
referenceNo
ANS
40
﻿ Order Number
﻿
payMethod
N
2
﻿Payment Method Code﻿ 
﻿
amt
N
12
﻿ 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
﻿ Amount Match Flag: Notification Match Amount Indicator﻿﻿
﻿
status
A
1
Deposit Status: Notification Status Code﻿ 
0 : Deposit
1 : Reversal
﻿
When  is received to your dbProcessUrl,  strongly recommend  to verify   again by using Status Inquiry - API Checkout﻿.
﻿
Additional Parameter for Credit Card Notification
Parameter
Type
Size
Description
Example / Notes
authNo
N
10
Approval Number
﻿
IssueBankCd
A
4
﻿Issuing Bank Code﻿ 
﻿
IssueBankNm
A
255
Issuing  Name 
﻿
acquBankCd
A
4
﻿Acquiring Bank Code﻿ 
﻿
acquBankNm
A
255
Acquiring  Name
﻿
cardNo
ANS
20
Card Number with Masking
﻿
cardExpYymm
N
4
Card Expiration (YYMM)
﻿
instmntMon
N
2
Installment Month 
1: 1 Month/Full , if instmntType: null/1
3: 3 Months
6: 6 Months
12: 12 Months
﻿
instmntType
N
2
﻿Installment Type Code﻿﻿
﻿
preauthToken
AN
255
Pre-Auth Token
﻿
recurringToken
AN
255
Recurring token
﻿
ccTransType
A
2
﻿Credit Card Trans type﻿﻿
1 : Normal
2 : Recurring
3 : Pre-auth
4 : Captured
﻿
vat
N
12
﻿ 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﻿ 
﻿
vacctNo
N
16
﻿ 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﻿ 
﻿
payNo
N
12
﻿ 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)
﻿
﻿ Token that received from Notification,  must do internally re-compared to prevent  invalid/fake .
﻿
Sample for Notification Parameter
﻿
Sample POST for Notification
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}
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}
﻿
﻿

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
tXid	N	30	Transaction ID
merchantToken	AN	255	Token
referenceNo	ANS	40	Order Number
payMethod	N	2	Payment Method Code
amt	N	12	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	Amount Match Flag: Notification Match Amount Indicator
status	A	1	Deposit Status: Notification Status Code 0 : Deposit 1 : Reversal

Parameter	Type	Size	Description
authNo	N	10	Approval Number
IssueBankCd	A	4	Issuing Bank Code
IssueBankNm	A	255	Issuing Name
acquBankCd	A	4	Acquiring Bank Code
acquBankNm	A	255	Acquiring Name
cardNo	ANS	20	Card Number with Masking
cardExpYymm	N	4	Card Expiration (YYMM)
instmntMon	N	2	Installment Month 1: 1 Month/Full , if instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months
instmntType	N	2	Installment Type Code
preauthToken	AN	255	Pre-Auth Token
recurringToken	AN	255	Recurring token
ccTransType	A	2	Credit Card Trans type 1 : Normal 2 : Recurring 3 : Pre-auth 4 : Captured
vat	N	12	Number
fee	N	12	Service Fee
notaxAmt	N	12	Tax Free Amount

Parameter	Type	Size	Description
bankCd	A	4	Bank Code
vacctNo	N	16	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
mitraCd	A	4	Mitra Code
payNo	N	12	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)

Updated 23 Aug 2024

Did this page help you?

Status Inquiry - API Checkout

Cancel - API Checkout

Notification - API Checkout

About API Checkout Notification

API Checkout Notification

Notification Parameter

Additional Parameter for Credit Card Notification

Additional Parameter for Virtual Account Notification

Additional Parameter for Others Payment Method Notification

Sample for Notification Parameter

Welcome to NICEPAY DOCS