Registration

All Transaction with NICEPAY API V2 Professional will redirect to NICEPay Secure Payment Page for payment process.

NICEPAY Professional Step:

1. Transaction Registration.
2. Redirect to NICEPay Secure Payment Page.
3. Finish Payment in NICEPay Secure Payment Page.
4. NICEPay will redirect end-user to Merchant callbackUrl to give the payment information.

Specifications - Register

API url	nicepay/redirect/v2/registration
Request Method application/json	POST
Description	Performs Transaction Regist to NICEPAY
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)

Request Parameters - Register

Sample JSON Request

{
    "timeStamp":"20210319095959",
    "iMid":"IONPAYTEST",
    "payMethod":"00",
    "currency":"IDR",
    "amt":"25145",
    "referenceNo":"ORDER123",
    "callBackUrl":"https://merchant.com/api/callBackUrl",
    "goodsNm":"Test Transaction Nicepay",
    "billingNm":"John Doe",
    "billingPhone":"12345678",
    "billingEmail":"[email protected]",
    "billingAddr":"Jalan Bukit Berbunga 22",
    "billingCity":"Jakarta",
    "billingState":"DKI Jakarta",
    "billingPostCd":"12345",
    "billingCountry":"Indonesia",
    "deliveryNm":"[email protected]",
    "deliveryPhone":"08123456789",
    "deliveryAddr":"Jalan Bukit Berbunga 22",
    "deliveryCity":"Jakarta",
    "deliveryState":"DKI Jakarta",
    "deliveryPostCd":"12345",
    "deliveryCountry":"Indonesia",
    "dbProcessUrl":"https://merchant.com/api/dbProcessUrl/Notif",
    "vat":"",
    "fee":"",
    "notaxAmt":"",
    "description":"",
    "merchantToken":"d05ba94a6f9a1411e5e45f429be9b09b138c4c81a67ceee363bea73d5f91c55b",
    "reqDt":"",
    "reqTm":"",
    "reqDomain":"merchant.com",
    "reqServerIP":"127.0.0.1",
    "reqClientVer":"",
    "userIP":"127.0.0.1",
    "userSessionID":"697D6922C961070967D3BA1BA5699C2C",
    "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
    "userLanguage":"ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
    "cartData":"{\"count\":\"1\",\"item\":[{\"goods_id\":\"BB12345678\",\"goods_detail\":\"BB12345678\",\"goods_name\":\"Pasar Modern\",\"goods_amt\":\"25145\",\"goods_type\":\"Sembako\",\"goods_url\":\"http:\/\/merchant.com\/cellphones\/iphone5s_64g\",\"goods_quantity\":\"1\",\"goods_sellers_id\":\"SEL123\",\"goods_sellers_name\":\"Sellers 1\"}]}",
    "sellers":"[{\"sellersId\": \"SEL123\",\"sellersNm\": \"Sellers 1\",\"sellersEmail\":\"[email protected]\",\"sellersAddress\": {\"sellerNm\": \"Sellers\",\"sellerLastNm\": \"1\",\"sellerAddr\": \"jalan berbangsa 1\",\"sellerCity\":\"Jakarta Barat\",\"sellerPostCd\": \"12344\",\"sellerPhone\":\"08123456789\",\"sellerCountry\": \"ID\"}}]",
    "instmntType":"2",
    "instmntMon":"1",
    "recurrOpt":"0",
    "bankCd":"",
    "vacctValidDt":"",
    "vacctValidTm":"",
    "payValidDt":"",
    "payValidTm":"",
    "merFixAcctId":"", 
    "mitraCd":"",
    "msId":"",
    "msFee":"",
    "msFeeType":"",
    "escrowCl":"",
    "shopId":""
}

Parameter	Type	Size	Description	Example
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20170708123456
iMid Required	AN	10	Merchant ID	IONPAYTEST
payMethod Required	N	2	Payment Method	00
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount	1000
referenceNo Required	ANS	40	Merchant's RefNo.	MerchantReferenceNumber001
goodsNm Required	AN	100	Goods Name	Merchant Goods 1
billingNm Required	A	30	Buyer Name	John Doe
billingPhone Required	N	15	Buyer Phone No.	2112345678
billingEmail Required	ANS	40	Buyer Email	[email protected]
billingAddr Required	AN	100	Buyer Address	Jln Merdeka 123
billingCity Required	A	50	Buyer City	Jakara Selatan
billingState Required	A	50	Billing State	DKI Jakarta
billingPostCd Required	N	10	Billing Post Number	14350
billingCountry Required	A	10	Billing Country	Indonesia
cartData Required	JSON String	4000	Cart Data	{}
sellers Only Payloan	JSON String	4000	Sellers	{}
instmntType Required For CC & Payloan	N	2	Installment Type	1
instmntMon Required For CC & Payloan	N	2	Installment Month	1
recurrOpt Recurring CC	N	2	Recurring option 0: Automatic Cancel 1: Do not cancel 2: Do not make token	1
bankCd Required for VA	A	4	Bank Code	CENA
vacctValidDt Optional VA	N	8	VA Expiry Date (YYYYMMDD)	20200303
vacctValidTm Optional VA	N	6	VA Expiry Time (HH24MISS)	135959
merFixAcctId Required Only VA Fix	AN	40	Merchant Reserved VA ID	4
payValidDt Optional CVS	N	8	CVS Expiry Date (YYYYMMDD)	20200303
payValidTm Optional CVS	N	6	CVS Expiry Time (HH24MISS)	135959
paymentExpDt	N	8	QR Payment Expiry Date (YYYYMMDD)	20200303
paymentExpTm	N	6	QR Payment Expiry Time (HH24MISS)	135959
mitraCd Optional	A	4	Mitra Code	AKLP
userIP Required	AN	15	User IP	127.0.0.1
dbProcessUrl Required	ANS	255	Notification URL	http://www.merchant.com/notification
callBackUrl Required	ANS	255	Payment Result Forward URL (On Browser)	http://www.merchant.com/callback
merchantToken Required	AN	255	merchantToken	6cfccfc0046773c1b589d8e 98f8b596c284f3c70a4ecf8 6eba14c18944b74bcd
deliveryNm	A	30	Delivery Name	John Doe
deliveryPhone	N	15	Delivery Phone	8124125931
deliveryAddr	AN	100	Delviery Address	Jln Merdeka Riau 161
deliveryCity	A	50	Delivery City	Riau
deliveryState	A	50	Delivery State	Riau
deliveryPostCd	N	10	Delivery Post Code	14350
deliveryCountry	A	10	Delivery Country	Indonesia
vat	N	12	Vat	0
fee	N	12	Service Fee	0
notaxAmt	N	12	Tax-free Amount	0
description	AN	100	Transaction Description	Test Transaction
reqDt	N	8	Request Date (YYYYMMDD)	20200303
reqTm	N	6	Request Time (HH24MISS)	135959
reqDomain	ANS	100	Request Domain	merchant.com
reqServerIP	ANS	15	Request Server IP	127.0.0.1
reqClientVer	ANS	50	Client Version	1.0
userSessionID	AN	100	User Session ID	userSessionID
userAgent	ANS	100	User Agent	Mozilla
userLanguage	A	2	User Language	en-US
shopId	AN	25	Shop Id	216660000000833315280

Cart Data - Register

Parameter	Description
count	Total cart data count
item
item -> goods_detail	Good's Detail
item -> goods_name	Good's Name
item -> goods_amt	Good's Amount
item -> goods_url	Good's Url
item -> goods_quantity	Good's Quantity

{
    "count": "2",  
    "item": [  
        {
            "img_url": "http://img.aaa.com/ima1.jpg",  
            "goods_name": "Item 1 Name",
            "goods_detail": "Item 1 Detail",
            "goods_amt": "700",
            "goods_quantity": "1"
        },  
        {
            "img_url": "http://img.aaa.com/ima2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "300",
            "goods_quantity": "1"
        }  
        ] 
} 

Payloan Cart Data

Parameter	Description
count	Total cart data count
item
item -> goods_id	Good's ID
item -> goods_detail	Good's Detail
item -> goods_name	Good's Name
item -> goods_amt	Good's Amount
item -> goods_type	Good's Type
item -> goods_url	Good's Url
item -> goods_quantity	Good's Quantity
item -> goods_sellers_id	Sellers ID
item -> goods_sellers_name	Sellers Name

{
  "count": "2",
  "item": [
    {
      "goods_id": "BB12345678",
      "goods_detail": "BB123456",
      "goods_name": "iPhone 5S",
      "goods_amt": "6000000",
      "goods_type": "Smartphone",
      "goods_url": "http://merchant.com/cel lphones/iphone5s_64g",
      "goods_quantity": "1",
      "goods_sellers_id": "SEL123",
      "goods_sellers_name": "Sellers 1"
    },
    {
      "goods_id": "AZ14565678",
      "goods_name": "Hailee Sneakers Blink Silver",
      "goods_amt": "250000",
      "goods_url": "http://merchant.com/fashion/shoes/sneakers-blinkshoes",
      "goods_type": "Sneakers",
      "goods_quantity": "2",
      "goods_sellers_id": "SEL124",
      "goods_ sellers_name": "Sellers 2"
    }
  ]
}

Payloan Sellers Data

Parameter	Description
sellersId	Sellers ID
sellersNm	Sellers Name
sellersEmail	Sellers Email
sellersUrl	Sellers Url
sellersAddress -> sellerNm	Seller Name
sellersAddress -> sellerLastNm	Seller Last Name
sellersAddress -> sellerAddr	Seller Address
sellersAddress -> sellerCity	Seller City
sellersAddress -> sellerPostCd	Seller Post Code
sellersAddress -> sellerPhone	Seller Phone
sellersAddress -> sellerCountry	Seller Country

[
  {
    "sellersId": "SEL123",
    "sellersNm": "Sellers 1",
    "sellersEmail": "[email protected]",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "1",
      "sellerAddr": "jalan berbangsa 1",
      "sellerCity": "Jakarta Barat",
      "sellerPostCd": "12344",
      "sellerPhone": "08123456789",
      "sellerCountry": "ID"
    }
  },
  {
    "sellersId": "SEL124",
    "sellersNm": "Sellers 2",
    "sellersEmail": "[email protected]",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "2",
      "sellerAddr": "jalan berkelok 3",
      "sellerCity": "Jakarta Utara",
      "sellerPostCd": "12222",
      "sellerPhone": "081255556789",
      "sellerCountry": "ID"
    }
  }
]

Response Parameters - Register

Sample JSON Response

{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST00202203211109251408",
    "referenceNo": "ORDER123",
    "payMethod": "00",
    "amt": "25145",
    "transDt": "20220321",
    "transTm": "110925",
    "description": "",
    "currency": "IDR",
    "goodsNm": "Test Transaction Nicepay",
    "billingNm": "John Doe",
    "payValidDt": null,
    "payValidTm": null,
    "paymentURL": "https://www.nicepay.co.id/nicepay/redirect/v2/payment"
}

Parameter	Type	Size	Description	Example	Remark
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST00202203211109251408	When success
referenceNo	ANS	40	Merchant Order No	ORDER123
payMethod	N	2	Payment Method	00	When success
amt	N	12	Payment amount	1000	When success
currency	AN	3	Currency	IDR
goodsNm	AN	100	Goods Name	Test Transaction Nicepay
billingNm	A	30	Buyer name	John Doe
apiType	AN	2	API Type	M0	When success
transDt	N	8	Transaction Date (YYYYMMDD)	20200112	When success
transTm	N	6	Transaction Time (HH24MISS)	115416	When success
description	AN	100	Transaction Description	This Is Transaction
payValidDt	N	8	CVS Expiry Date (YYYYMMDD)	20200112
payValidTm	N	6	CVS Expiry Date (HH24MISS)	115416
paymentExpDt	N	8	Payment Expired Date (YYYYMMDD)	20200112	When Set The Value
paymentExpTm	N	6	Payment Expired Date (HH24MISS)	115416	When Set The Value
paymentURL	AN	40		https://www.nicepay.co.id/nicepay/redirect/v2/payment	When success

Payment

Specifications - Payment

API url	/nicepay/redirect/v2/payment
Request Method application/x-www-form-urlencoded	Redirect
Description	Performs Payment Request to NICEPAY
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)

Request Parameters - Payment

Sample Request

https://www.nicepay.co.id/nicepay/redirect/v2/payment?tXid=IONPAYTEST00202203211640309389

Parameter	Type	Size	Description	Example
paymentURL Required	URL	-	Link Payment	https://www.nicepay.co.id/nicepay/redirect/v2/payment
tXid Required	AN	30	Transaction ID	IONPAYTEST00202203211640309389

NICEPAY Secure Payment Page

Response Parameters - Payment

Sample Response to callbackUrl with parameter

referenceNo: ORDER123
authNo: 280847
ccTransType: 1
mRefNo: 
issuBankCd: OTHR
issuBankNm: 
tXid: IONPAYTEST00202203220912280847
transTm: 091228
mitraCd: 
recurringToken: 
resultCd: 0000
transDt: 20220322
acquBankCd: BMRI
acquBankNm: PT Bank Mandiri (Persero)
instmntType: 2
instmntMon: 1
payMethod: 01
receiptCode: 
cardExpYymm: 2612
cardNo: 421111******1111
description: 
resultMsg: SUCCESS
goodsNm: Test Transaction Nicepay
preauthToken: 
amt: 25145
billingNm: John Doe
currency: IDR

Parameter	Type	Size	Description	Example	Remark
resultCd	N	4	Result Code	0000
resultMsg	AN	30	Result Message	Success
tXid	AN	30	Transaction ID	IONPAYTEST00202203211109251408	When success
referenceNo	ANS	40	Order Number	ORD12345	When success
amt	N	12	Transaction Amount	1000	When success
transDt	N	8	Registration Date (YYYYMMDD)	20200112	When success
transTm	N	6	Registration Time (HH24MISS)	115416	When success
description	AN	100	Transaction Description	This is Testing Transaction	When success
authNo	N	10	Approval Number	1234567890	When success – Only CC (Additional)
recurringToken	AN	255	Recurring Token	5b949971aea6d468bebef20fec7b067abde88e52a4520925cd28dfa840ce5abc	When success – Only CC (Additional)
cardNo	ANS	20	Card No With Masking	420192******2327	When success – Only CC
acquBankCd	A	-	Acquire Bank Code	BMRI	When success – Only CC
issuBankCd	A	-	Acquire Bank Name	OTHR	When success – Only CC
vat	N	12	Vat Number	0	When success – Only CC (Additional)
fee	N	12	Service Fee	0	When success – Only CC (Additional)
notaxAmt	N	12	Tax Free Amount	0	When success – Only CC (Additional)
bankCd	A	4	Bank Code	BMRI	When success – Only VA
mitraCd	A	4	Mitra Code	OVOE	When success – CVS, E-Wallet, Payloan
bankVacctNo	N	20	VA Number	447770956314286	When success – VA
payNo	N	20	Payment Number	9041071059504308	When success – CVS
currency	A	3	Currency	IDR	When success – Ewallet, Payloan
goodsNm	AN	100	Goods Name	Testing Transaction Nicepay	When success – Ewallet, Payloan
billingNm	A	30	Billing Name	IONPAY NETWORK TESTING Nicepay	When success – Ewallet, Payloan
payMethod	N	2	Payment Method	03	When success – Ewallet, Payloan

Recurring Token

When the merchant signs contract as a recurring merchant, NICEPay give a recurringToken to the Payment API response.
(NICEPay calls this as recurring token making) The Merchant can use this recurringToken to next Payment API request without cardNo, cardExpYymm (but cardCvv is mandatory)

Response Parameter Recurring Token

Parameter	Type	Size	Description	Remark
tXid	AN	30	TXID	RECURRTEST01202206230959067259
referenceNo	AN	40	Merchant Order No	20220623095906
amt	N	12	Payment Amount	15000
recurringToken	AN	255	Recurring Token	f19e3128784d0b33c189d5df21321c781b5bd107b185587fd8a54781aa845c84
resultMsg	A	30	Result Message	SUCCESS

Preauth Token

When the merchant signs contract as PAC(Pre-Auth/Capture) merchant, NICEPay give a preauthToken to the Payment API response.(NICEPay calls this as "Pre-auth token making", this isnot real transaction, should need Captureprocess)The Merchant can capture using preauthToken to Payment API request without cardNo, cardExpYymm, cardCvv

Response Parameter PreauthToken - Hold

Parameter	Type	Size	Description	Remark
tXid	AN	30	TXID	PACTEST00101202206241007570327
referenceNo	AN	40	Merchant Order No	20220624100756
amt	N	12	Payment Amount	15000
preauthToken	AN	255	Recurring Token	5c6ba40e61c45d9fa37e763ea1f86b9d6ac5f1f7ed279e4d4531191c83279320
resultMsg	A	30	Result Message	SUCCESS
amt	N	12	Payment Capture	15000

Response Capture Parameter PreauthToken - Payment

Parameter	Type	Size	Description	Remark
tXid	AN	30	TXID	PACTEST00101202206241043210344
referenceNo	AN	40	Merchant Order No	20220624100756
amt	N	12	Payment Amount	15000
resultMsg	A	30	Result Message	SUCCESS

Status Inquiry

Specifications - Inquiry

API url	/nicepay/direct/v2/inquiry
Request Method application/json	POST
Description	Merchant can check order status using Inquiry API. If merchant receive notification, NICEPay strongly recommend that the merchant check the transaction again using the Inquiry API.
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)

Request Parameters - Inquiry

Sample JSON Request

{
 "timeStamp": "20210319095959",
 "merchantToken": "f678c812215a83eff4e71273323ecb3eb1c3f17145717aba71fe516b5b2fa9df",
 "referenceNo": "ORDER123",
 "tXid": "IONPAYTEST00202203220949484733",
 "amt": "1000",
 "iMid": "IONPAYTEST"
}

Parameter	Type	Size	Description	Example
timeStamp Required	N	14	API Request Date (YYYYMMDDHH24MISS)	20210319095959
tXid Required	AN	30	Transaction Id	IONPAYTEST00202203220949484733
iMid Required	AN	10	Merchant Id	IONPAYTEST
referenceNo Required	ANS	40	Merchant Order No	ORDER123
amt Required	N	12	Transaction Amount	1000
merchantToken Required	AN	255	merchantToken	f678c812215a83eff4e71273323ec...

Response Parameters - Inquiry

Sample JSON Response

{
    "tXid": "IONPAYTEST00202203220949484733",
    "iMid": "IONPAYTEST",
    "currency": "IDR",
    "amt": "1000",
    "instmntMon": "1",
    "instmntType": "2",
    "referenceNo": "ORDER123",
    "goodsNm": "Test Transaction Nicepay",
    "payMethod": "01",
    "billingNm": "John Doe",
    "reqDt": "20220322",
    "reqTm": "094948",
    "status": "0",
    "resultCd": "0000",
    "resultMsg": "paid",
    "cardNo": "421111******1111",
    "preauthToken": null,
    "acquBankCd": "BMRI",
    "issuBankCd": "OTHR",
    "vacctValidDt": null,
    "vacctValidTm": null,
    "vacctNo": null,
    "bankCd": null,
    "payNo": null,
    "mitraCd": null,
    "receiptCode": null,
    "cancelAmt": null,
    "transDt": "20220322",
    "transTm": "094948",
    "recurringToken": null,
    "ccTransType": "1",
    "payValidDt": null,
    "payValidTm": null,
    "mRefNo": null,
    "acquStatus": "10",
    "cardExpYymm": "2612",
    "acquBankNm": "Mandiri",
    "issuBankNm": "OTHER",
    "depositDt": null,
    "depositTm": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "paymentTrxSn": null,
    "cancelTrxSn": null,
    "userId": null,
    "shopId": null
}

Parameter	Type	Size	Description
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message
tXid	AN	30	Transaction Id
iMid	AN	10	Merchant Id
referenceNo	ANS	40	Merchant Order No
payMethod	N	2	Payment Method
amt	N	12	Payment amount
cancelAmt	N	12	Cancel amount
reqDt	N	8	Transaction request date (YYYYMMDD)
reqTm	N	6	Transaction request time (HH24MISS)
transDt	N	8	Transaction date (YYYYMMDD)
transTm	N	6	Transaction time (HH24MISS)
depositDt	N	8	Transaction deposit date (YYYYMMDD)
depositTm	N	6	Transaction deposit time (HH24MISS)
currency	A	3	Currency
goodsNm	AN	100	Goods Name
billingNm	A	30	Buyer name
status	N	1	Transaction Status

Additional Response Parameters - Credit Card

Parameter	Type	Size	Description
authNo	N	10	Approval Number
issuBankCd	A	4	Issuer Bank Code
acquBankCd	A	4	Acquire Bank Code
cardNo	ANS	20	Masked Card Number
cardExpYymm	N	4	Card Expiration (YYMM)
instmntMon	N	2	Installment Month
instmntType	N	2	Installment Type
preauthToken	AN	255	Pre-Auth Token (Needed for Capture Payment)
recurringToken	AN	255	Recurring Token (Needed for Recurring Payment)
ccTransType	N	2	Credit Card Transaction Type
acquStatus	N	2	Purchase Status 1: Normal 2: Recurring 3: Pre-auth 4: Capture
vat	N	12	Vat
fee	N	12	Service Fee
notaxAmt	N	12	Tax-free Amount

Additional Response Parameters - Virtual Account

Parameter	Type	Size	Description
bankCd	A	4	Bank Code
vacctNo	N	16	Bank Virtual Account Number
vacctValidDt	N	8	VA expiry date (YYYYMMDD)
vacctValidTm	N	6	VA expiry time (HH24MISS)

Additional Response for QRIS

Parameter	Type	Size	Description
mitraCd	A	4	QSHP
cancelAmt	N	12	Cancel amount
paymentTrxSn	AN	32	Payment Transaction Number
paymentExpDt	N	6	QR Payment Expiry Date (YYYYMMDD)
shopId	AN	32	Shop Id
paymentExpTm	N	6	QR Payment Expiry Time (HH24MISS)
cancelTrxSn	AN	32	Cancel Transaction Number
userId	AN	128	QRIS User ID Hash

Additional Response Parameters - Others

Parameter	Type	Size	Description
mitraCd	A	4	Mitra code (CVS, ClickPay, E-Wallet, Payloan)
payNo	N	12	CVS number (CVS)
payValidDt	N	8	CVS expiry date (YYYYMMDD) (CVS)
payValidTm	N	6	CVS expiry time (HH24MISS) (CVS)
receiptCode	ANS	20	Authorization code (CVS)
mRefNo	AN	20	Bank reference No (ClickPay)

Cancel

Specifications - Cancel

API url	/nicepay/direct/v2/cancel
Request Method application/json	POST
Description	Request Transaction Cancel to Nicepay
Merchant Token	SHA256(timeStamp+iMid+tXid+amt+merchantKey)

Payment Methods Available for Cancel:

Code	PayMethod
01	Credit Card
02	Virtual Account
03	Convenience Store
04	ClickPay
05	E-Wallet
06	Payloan
08	QRIS

Request Parameters - Cancel

Sample JSON request

{
    "timeStamp":"20180123100505",
    "tXid":"IONPAYTEST01202103311759347262",
    "iMid":"IONPAYTEST",
    "payMethod":"01",
    "cancelType":"1",
    "cancelMsg":"Request Cancel",
    "merchantToken":"66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119",
    "preauthToken":"",
    "amt":"10000",
    "cancelServerIp":"127.0.0.1",
    "cancelUserId":"admin",
    "cancelUserIp":"127.0.0.1",
    "cancelUserInfo":"Test Cancel",
    "cancelRetryCnt":"3",
    "referenceNo": "CancelNo20160525000-52104",
    "worker":""
}

Parameter	Type	Size	Description	Example
timeStamp	N	14	API Request Timestamp Required	20170708123456
tXid	AN	30	Transaction Id Required	IONPAYTEST02201603091207051498
iMid	AN	10	Merchant Id Required	IONPAYTEST
payMethod	N	2	Payment Method Required	01
cancelType	N	2	Cancel Type Required	1
merchantToken	AN	255	merchantToken Required	6cfccfc0046773c1b89d8e98f8b5…
amt	N	12	Payment Amount Required	1000
cancelMsg	AN	255	Cancel Message	Test Cancel
preauthToken	AN	100	Pre-authToken	d4ef98b26f917a697691807cf…
referenceNo	ANS	40	Merchant Cancel No (Optional For CC)	CancelNo20160525000-52104
cancelServerIp	AN	15	Server IP	127.0.0.1
cancelUserId	AN	30	User ID	Admin
cancelUserIp	AN	15	User IP	127.0.0.1
cancelUserInfo	AN	100	User Information	Test Cancel
cancelRetryCnt	N	2	Retry Count	5
worker	AN	10	Worker	Worker

Response Parameters - Cancel

Sample JSON Response

{
    "tXid": "IONPAYTEST01202103311759347262",
    "referenceNo": "ord20210331170394",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20210331",
    "transTm": "175934",
    "amt": "10000",
    "cancelReferenceNo": "CancelNo20160525000-52104"
}

Parameter	Type	Size	Description	Remark
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message
tXid	AN	30	Transaction ID	When Success
referenceNo	ANS	40	Merchant Order No	When Success
transDt	N	8	Transaction Date	When Success
transTm	N	6	Transaction Time	When Success
description	AN	255	Description	When Success
amt	N	12	Amount	When Success
canceltXid	AN	30	Cancel Transaction ID	When Success
cancelTrxSn	AN	32	Cancel Transaction Number	When Success
cancelReferenceNo	AN	40	Merchant Cancel No (Optional For CC)	When Success

Notification

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}
transDt = {depositDt}
transTm = {depositTm}
payNo={payNo}

NICEPAY provides push notification through merchant's dbProcessUrl.
To Allow Push Notifications from NICEPAY Server, please add these details to your firewall whitelist:

Method	Merchant Token	IP	User-Agent
POST application/x-www-form-urlencoded	SHA256(iMid+tXid+amt+merchantKey)	103.20.51.0/24 103.117.8.0/24	User-Agent: Jakarta Commons-HttpClient/3.1

Notification Parameter

Parameter	Type	Size	Description
tXid	N	30	Transaction ID
merchantToken	AN	255	Merchant Token
referenceNo	ANS	40	Merchant Order No
payMethod	N	2	Payment method
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	30	Billing name
matchCl	N	1	Payment Flag
status	A	1	Deposit Status: 0 Deposit 1 Reversal

Additional Parameter for Credit Card Notification

Parameter	Type	Size	Description
authNo	N	10	Approval number
IssueBankCd	A	4	Issue bank code
IssueBankNm	A		Issue bank name.
acquBankCd	A		Acquire bank code
acquBankNm	A		Acquire bank name.
cardNo	ANS	20	Card no with masking
cardExpYymm	N		Card expiry (YYMM)
instmntMon	N	2	Installment month
instmntType	N	2	Installment Type
preauthToken	AN	255	Preauth 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	Vat number
fee	N	12	Service fee
notaxAmt	N	12	Tax free amount

Additional Parameter for Virtual Account Notification

Parameter	Type	Size	Description
bankCd	A	4	Bank Code
vacctNo	N	16	Bank VA Number
vacctValidDt	N	8	VA Expiry Date (YYYYMMDD)
vacctValidTm	N	6	VA Expiry Time (HH24MISS)

Additional Parameter for QRIS Notification

Parameter	Type	Size	Description
paymentTrxSn	AN	32	Payment Transaction Number
userId	AN	128	QRIS User ID Hash
shopId	AN	32	Shop Id

Additional Parameter for Others Payment Method Notification

Parameter	Type	Size	Description
mitraCd	A	4	Mitra Code
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 No.

Nicepay Code

Field Type

Value Code	Meaning
A	Alphabet
AN	Alphabet Numeric
N	Numeric
ANS	Alphabet Numeric Symbol
AOO	Array of Object

Installment Type

Value Code	Meaning
1	Customer charge
2	Merchant charge

Payment Method

Value Code	Meaning
01	Credit Card
02	Virtual Account
03	CVS (Convenience Store)
04	ClickPay
05	E-Wallet
06	Payloan
08	QRIS
09	GPN Card

Payment Status Code

Credit Card	Meaning
0	Success
1	Failed
2	Void/Refund
9	Initialization / Reversal

Virtual Account	Meaning
0	Paid
3	Unpaid
4	Expired

CVS	Meaning
0	Paid
3	Unpaid
4	Expired
5	Ready to Paid (for Alfamart)

E-Wallet OVO	Meaning
0	Paid
1	Void
8	Fail
9	Init

E-Wallet Shopeepay	Meaning
0	Paid
1	Void
2	Refund
3	Unpaid
4	Processing
5	Expired
8	Fail
9	Init

E-Wallet DANA	Meaning
0	Paid
1	Void
2	Refund
3	Unpaid
5	Expired
8	Fail
9	Init

E-Wallet Linkaja	Meaning
0	Paid
1	Void
2	Refund
3	Unpaid
8	Fail
9	Init

E-Wallet AstraPay	Meaning
0	Paid
3	Unpaid
8	Fail

Payloan	Meaning
0	Paid
1	Void
2	Refund
3	Unpaid
4	Expired
5	Preauth
8	Fail
9	Init

QRIS	Meaning
0	Success
1	Void
2	Refund
3	Unpaid
4	Processing
5	Not Found
6	Payment Failed

Notification Status Code

Value Code	Meaning
0	Deposit
1	Reversal

Notification Match Amount Indicator

Value Code	Meaning
1	Match
2	Over
3	Under

Cancel Type

Value Code	Meaning
1	Full Cancellation
2	Partial Cancellation

Bank Code

Value Code	Meaning
BMRI	Bank Mandiri
IBBK	Bank International Indonesia Maybank
BBBA	Bank Permata
BBBB	Bank Permata Syariah
CENA	Bank Central Asia
BNIN	Bank Negara Indonesia 46
HNBN	Bank KEB Hana Indonesia
BRIN	Bank Rakyat Indonesia
BNIA	Bank PT. BANK CIMB NIAGA, TBK.
BDIN	Bank PT. BANK DANAMON INDONESIA, TBK
PDJB	Bank BJB
YUDB	Bank BNC
BDKI	Bank DKI
OTHR	etc, unknown

Mitra Code

Value Code	Meaning
ALMA	CVS Alfamart
INDO	CVS Indomaret
MDRC	ClickPay Mandiri
BCAC	ClickPay BCA
CIMC	ClickPay CIMB
JENC	Jenius Pay
MDRE	E-Wallet Mandiri
BCAE	E-Wallet BCA(Sakuku)
AKLP	Akulaku
KDVI	Kredivo
IDNA	Indodana
OVOE	OVO
LINK	LinkAja
DANA	DANA
ESHP	E-Wallet Shopeepay
QSHP	QRIS ShopeePay

Error Code

Value	Description
	Common
0000	Success
1001	Connection error
1002	Socket error
1003	Server error
1004	Timeout error
9501	Invalid transaction number.
9502	Transaction not allowed.
9503	It has been stopped or terminated in its stores.
9504	No offus information.
9505	No bank information.
9506	No Merchant Paymethod information.
9507	Http timeout exception.
	Order
8001	Order registration error.
8002	Order inquiry error.
8003	Order registration data error.
8004	The tXid error during the order inquiry.
8005	OrderAuthType API Response data null.
9001	Failed to register your order. Please check your HTTP Message.
9002	Server is busy. Please kindly try again in few minutes.
9003	Invalid Order.
9004	Error on inquiry of order confirmation.
9005	Failed to check status. Please contact NICEPay for further information.
9006	Transaction number generated error.
9007	Undefined: Amount. Please check your request parameter and make sure [amt] is defined.
9008	Invalid Request Amount. Amount should only number and do not includes decimal.
9009	Reference Number already exist. Please generate unique [referenceNo].
9010	Invalid Merchant Token. Contact NICEPay for further information.
9011	Invalid MID, Merchant is not registered. Contact NICEPay for further information.
9012	This Payment method is currently not activated. Contact Nicepay for further information.
9013	Undefined: Currency Code. Please check your request parameter and make sure [currencyCode] is defined.
9014	Undefined: Reference No. Please check your request parameter and make sure [referenceNo] is defined.
9015	Undefined: Goods Name. Please check your request parameter and make sure [goodsNm] is defined.
9016	Undefined: Buyer Name. Please check your request parameter and make sure [billingNm] is defined.
9017	Undefined: Buyer Phone Number. Please check your request parameter and make sure [billingPhone] is defined.
9018	Undefined: Buyer Email Address. Please check your request parameter and make sure [billingEmail] is defined.
9019	Undefined: Callback URL. Please check your request parameter and make sure [callbackUrl] is defined.
9020	Undefined: Debit Process URL. Please check your request parameter and make sure [dbProcessUrl] is defined.
9021	Failed in inquiring the criterion information (BO_MER_MGNT ORD_NO_DUP_CHK_FLG).
9022	Invalid Card Data. Please check [cartData] parameter, and make sure you send valid JSON format.
9023	Invalid Cart Data. Amount is different with Cart Data total amount. Please make sure [amt] = sum of [amt] in [cartData]
9024	Undefined: Customer IP Address. Please check your request parameter and make sure [userIP] is defined.
9025	Undefined: Buyer City. Please check your request parameter and make sure [billingCity] is defined.
9026	Undefined: Buyer State. Please check your request parameter and make sure [billingState] is defined.
9027	Undefined: Buyer Postal Code. Please check your request parameter and make sure [billingPostCd] is defined.
9028	Undefined: Buyer Country. Please check your request parameter and make sure [billingCountry] is defined.
9029	Installment is not available for defined month
9030	Transaction Fail. Please check information.
9031	Date/Time check.
	Card
8021	Card authorization error.
8022	The tXid error during the card authorization.
8023	The tXid error during the card net cancel.
8024	The MID error during the card net cancel.
8026	Failed card VISA 3D.
8027	Invalid Parameter (PAN or expiry or country_code)
8028	Invalid Parameter (callbackUrl)
8029	Invalid Parameter (onePassToken)
8030	Not Support Keyin Payment.
9101	Server is busy. Please kindly try again in few minutes.
9102	Server is busy. Please kindly try again in few minutes.
9103	Error in inquiring card ledger.
9104	Server is busy. Please kindly try again in few minutes.
9105	Server is busy. Please kindly try again in few minutes.
9106	Transaction failed.
9107	Server is busy. Please kindly try again in few minutes.
9108	This Payment method is currently not activated. Contact Nicepay for further information.
9109	Reference Number Maximum Length Exceed. [referenceNo] should have maximum 40 characters length.
9110	Transaction failed. Please check card information and try again.
9111	Transaction failed. Please check card information and try again.
9112	Transaction failed. Please check card information and try again.
9113	Transaction failed. Please check card information and try again.
9114	MERCHANT_CARDINFO query error.
9115	Invalid Amount: too low. Please increase amount.
9116	Transaction already exist. Please make new transaction.
9117	3D Secure Failed. Please kindly check your card data and try again.
9118	Invalid Installment Type.
9119	Transaction failed: Invalid Terminal ID or Merchant ID
9120	Transaction failed: Invalid Terminal ID or Merchant ID
9121	This Payment method is currently not activated. Contact Nicepay for further information.
9122	Transaction failed. Please check settlement interval.
9123	Transaction failed. Transaction limit reached.
9124	Invalid Amount: too low. Please increase amount.
9125	Transaction failed. Please check card information and try again.
9126	Transaction already approved.
9127	Transaction already exist. Please make new transaction.
9128	Transaction failed. Please check card information and try again.
9129	Transaction failed: Expired transaction. Please make new transaction.
9130	Forbidden. You do not have permission to access this resource.
9131	Invalid Token. Please check [onePassToken] parameter
9132	Transaction failed. Please check Risk Management.
9133	Email not sent.
9134	Card Recurring Token Failed.
9135	Card Recurring Auto Void Failed.
9136	Card Recurring Token Unregistraion Failed.
9137	Card MIGS Transaction Number not found. (queryDR, vpc_DRExists : N)
9138	Card MIGS SecureHash not match.
9139	Card MIGS Amount not match.
9140	Recurring Payment Parameter CVV code is mandatary.
9141	Recurring Payment AuthType is '1' or '2'.
9142	Cards issued overseas can not be paymented.
9143	Card PreAuth Token Failed.
9144	Card PreAuth Token Unregistraion Failed.
9145	capture amount must be less than pre-authorised amount.
9146	Failed to card token inquiry
9147	Invalid parameters.
9148	Recurring Token is only available for 3DS.
9149	Recurring Payment Use Check : Fail.
9150	Recurring Payment CVV Check : Fail.
9151	cardBin Information exist in blackList.
9152	FDS Check : high risk score.
9153	FDS Check : binCountry is not local card.
9154	card daily transaction limit count over.
9155	card daily transaction limit amount over.
9156	FDS Check : server communication error.
9157	There is no valid authentication data. Please make new transaction.
9158	Card Holder Name is Mandatory.
9159	Transaction failed. please contact merchant.
9160	Invalid expired date format YYMM
9161	Token not found
9162	FDS Check : binCountry is not permit to payment.
00	Successful approval/completion or that V.I.P. PIN verification is valid
01	Refer to card issuer
02	Refer to card issuer, special condition
03	Invalid merchant or service provider
04	Pickup card
05	Do not honor
06	General Error
07	Pickup card, special condition (other than lost/stolen card)
08	Honor with identification
09	Request in progress
10	Partial Approval
11	V.I.P. approval
12	Invalid transaction
13	Invalid amount (currency conversion field overflow) or amount exceeds maximum for card program
14	Invalid account number (no such number)
15	No such issuer
16	Insufficient funds
17	Customer cancellation
19	Re-enter transaction
20	Invalid response
21	No action taken (unable to back out prior transaction)
22	Suspected Malfunction
25	Unable to locate record in file, or account number is missing from the inquiry
28	File is temporarily unavailable
30	Format Error
41	Pickup card (lost card)
43	Pickup card (stolen card)
51	Insufficient funds
52	No checking account
53	No savings account
54	Expired card
55	Incorrect PIN
57	Transaction not permitted to cardholder
58	Transaction not allowed at terminal
59	Suspected fraud
61	Activity amount limit exceeded
62	Restricted card (for example, in Country Exclusion table)
63	Security violation
65	Activity count limit exceeded
68	Response received too late
75	Allowable number of PIN - entry tries exceeded
76	Unable to locate previous message (no match on Retrieval Reference number)
77	Previous message located for a repeat or reversal, but repeat or reversal data are inconsistent with original message
78	’Blocked, first used’ - The transaction is from a new cardholder, and the card has not been properly unblocked.
80	Visa transactions: credit issuer unavailable. Private label and check acceptance: Invalid date
81	PIN cryptographic error found (error found by VIC security module during PIN decryption)
82	Negative CAM, dCVV, iCVV, or CVV results
83	Unable to verify PIN
85	No reason to decline a request for account number verification, address verification, CVV2 verification, or a credit voucher or merchandise return
91	Issuer unavailable or switch inoperative (STIP not applicable or available for this transaction)
92	Destination cannot be found for routing
93	Transaction cannot be completed, violation of law
94	Duplicate Transmission
95	Reconcile error
96	System malfunction, System malfunction or certain field error conditions
B1	Surcharge amount not permitted on Visa cards (U.S. acquirers only)
N0	Force STIP
N3	Cash service not available
N4	Cashback request exceeds issuer limit
N7	Decline for CVV2 failure
P2	Invalid biller information
P5	PIN Change/Unblock request declined
P6	Unsafe PIN
Q1	Card Authentication failed
R0	Stop Payment Order
R1	Revocation of Authorization Order
R3	Revocation of All Authorizations Order
XA	Forward to issuer
XD	Forward to issuer
Z3	Unable to go online
C101	Error setting mandatory fields, TRANSACTION_TYPE is empty!
C102	Invalid value for TRANSACTION_TYPE! Acceptable Value : QUERY=1, SALES=2, AUTHORIZED=3, CAPTURE=4
C103	This transaction is not authorized, cannot proceed to be captured.
C104	Error setting mandatory fields, MERCHANT_ACC_NO is empty!
C105	Invalid MERCHANT_ACC_NO! Unable to find merchant with provided MERCHANT_ACC_NO.
C106	The status of this MERCHANT_ACC_NO is suspended! All transactions are not allowed temporary. Please check with administrator for the status.
C107	The status of this MERCHANT_ACC_NO is still pending and not yet activated. Please check with administrator for the status.
C108	The status of this MERCHANT_ACC_NO is invalid! Please check the merchant setting.
C109	The setting of this MERCHANT_ACC_NO does not allow the requested transaction type. Please check the merchant setting.
C110	The setting of this MERCHANT_ACC_NO do not allow transaction request from this IP address. Please checks the merchant allow IP setting.
C111	Error setting mandatory fields, AMOUNT is empty!
C112	Invalid value for AMOUNT
C113	Error setting mandatory fields, CARD_NO is empty!
C114	Error setting mandatory fields, CARD_EXP_MM is empty!
C115	Error setting mandatory fields, CARD_EXP_YY is empty!
C116	Error setting mandatory fields, CARD_CVC is empty!
C117	Invalid value for CARD_NO. CARD_NO must be numeric and with valid length!
C118	Invalid value for CARD_EXP_MM. CARD_EXP_MM must be numeric and with valid length!
C119	Invalid value for CARD_EXP_YY. CARD_EXP_YY must be numeric and with valid length!
C120	Invalid value for CARD_CVC. CARD_CVC must be numeric and with valid length!
C121	Invalid payment method. Please call bank to check Merchant Settings.
C122	Amount has been over transaction limit for today. Please call bank to check Merchant Settings.
C123	Transaction not permitted through this merchant type. Please call bank to check Merchant Settings.
C124	Undefined Error. Error Code:1024
C301	Error setting mandatory fields, TRANSACTION_ID is empty! TRANSACTION_ID is required for CAPTURE transaction type
C302	Error setting mandatory fields, RETURN_URL is empty!
C303	Error setting mandatory fields, RESPONSE_TYPE is empty!
C304	Error setting mandatory fields, TXN_URL is Null for RESPONSE_TYPE using HTTP!
C305	Invalid value for RESPONSE_TYPE for non-3D transaction! Acceptable Value : HTTP, XML, PLAIN
C306	Error setting mandatory fields, TXN_SIGNATURE is empty!
C307	Invalid value for TXN_SIGNATURE! Computed signature does not match one included in the request.
C308	Invalid format for TXN_SIGNATURE! TXN_SIGNATURE must be length of 32, and in hexadecimal format.
C309	Unable to find the transaction record!
C310	MERCHANT_ACC_NO not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_ACC_NO is the same MERCHANT_ACC_NO submitted during previous transaction.
C311	AMOUNT not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the AMOUNT is the same AMOUNT submitted during previous transaction.
C312	CUSTOMER_ID not matched with previous submitted transaction request! To capture/query previous transaction, if this field is being used, please ensure the CUSTOMER_ID is the same CUSTOMER_ID submitted during previous transaction.
C313	MERCHANT_TRANID not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_TRANID is the same MERCHANT_TRANID submitted during previous transaction.
C314	Insecure mode for RETURN_URL. Please specify an URL which uses HTTPS protocol!
C315	Insecure mode for TXN_URL. Please specify an URL which uses HTTPS protocol!
C401	Error setting mandatory fields, CARD_HOLDER_NAME is empty!
C402	Error setting mandatory fields, MERCHANT_TRANID is empty!
C403	Duplicate MERCHANT_TRANID detected! Please ensure the MERCHANT_TRANID is always unique.
C404	Error setting mandatory fields, TXN_DESC is empty!
C405	Error setting mandatory fields for 3D transaction, MPI_CODE is empty!
C406	Error setting mandatory fields for 3D transaction, MPI_CAVV is empty!
C407	Error setting mandatory fields for 3D transaction, MPI_CAVV_ALG is empty!
C408	Error setting mandatory fields for 3D transaction, MPI_ECI is empty!
C409	Error setting mandatory fields for 3D transaction, MPI_MSG is empty!
C501	Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_EMAIL is empty!
C502	Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_COUNTRY is empty!
C503	Error setting mandatory fields for fraud risk detection, FR_BILLING_ADDRESS is empty!
C504	Error setting mandatory fields for fraud risk detection, FR_SHIPPING_ADDRESS is empty!
C505	Error setting mandatory fields for fraud risk detection, FR_SHIPPING_COST is empty!
C506	Error setting mandatory fields for fraud risk detection, CUSTOMER_IP is empty!
C507	Error setting mandatory fields for fraud risk detection, FR_PURCHASE_HOUR is empty!
C508	Transaction was blocked due to fraud level exceeded threshold limit.
C509	Transaction was blocked due to blacklisted card detected.
C601	Unable to get connection to MPI Server!
C602	Time out occurred during communication with MPI Server!
C603	Unable to update MPI Ref. No in system. Please try again.
C604	There was an error occurred during 3D authentication with MPI. Please check logs for details.
C605	Invalid message or response received from MPI. Please try again.
C606	MPI Settings are not configured correctly. Please check MPI_HOST and MPI_PORT in system configuration.
C607	Error occurred when trying to display ACS Form in web browser for 3D authentication. Please try again.
C608	Problem occurred on MPI side, cannot proceed to display ACS Form. Please check MPI message or try again.
C609	Unable to locate back transaction to update system after 3-D authentication process. Please try again.
C610	Empty response received from MPI, please try again.
C611	MPI Code received is not allowed to proceed to process the transaction.
C612	Transaction was aborted because 3-D authentication process is not completed.
C613	Attempted duplicate submission of 3-D authentication result. Please try with new transaction.
C614	MALL NAME is required for 3-D transaction. Please call bank to check Merchant Settings.
C615	MALL URL is required for 3-D transaction. Please call bank to check Merchant Settings.
C616	Invalid value for RESPONSE_TYPE for 3D transaction! Acceptable Value : HTTP only
C801	This MERCHANT_ACC_NO is not authorized to proceed with this transaction via website! Please check the merchant setting.
C802	This MERCHANT_ACC_NO is not authorized to proceed with this transaction via batch upload! Please check the merchant setting.
C803	Exception while query Payment Server!
C804	Exception while checking for fraud risk!
C999	Internal Exception. Please call bank to report.
C988	Server Time Out Exception.
C977	Bank Connection Error!
C966	Reply from bank is empty/incorrect!
C967	Bank rejected transaction!
C955	Error when trying to insert transaction table. Transaction ID is empty!
C933	Server interruption occurred during processing. Manual checking required. Please inform Administrator.
C935	Cancel payment by customer.
C937	Insufficient point to redeem in cardholder's account. Please enter another card number.
1	Transaction could not be processed
2	Transaction Declined - Contact Issuing Bank
3	Transaction Declined- No reply from Bank
4	Transaction Declined - Expired Card
5	Transaction Declined - Insufficient credit
6	Transaction Declined - Bank system error
7	Payment Server Processing Error - Typically caused by invalid input data such as an invalid credit card number. Processing errors can also occur. (This is only relevant for Payment Servers that enforce the uniqueness of this field) Processing errors can also occur.
8	Transaction Declined - Transaction Type Not Supported
9	Bank Declined Transaction (Do not contact Bank)
A	Transaction Aborted
B	Transaction Blocked - Returned
C	Transaction Cancelled
D	Deferred Transaction
E	Transaction Declined - Refer to card issuer
F	3D Secure Authentication Failed
I	Card Security Code Failed
L	Shopping Transaction Locked (This indicates that there is another transaction taking place using the same shopping transaction number)
N	Cardholder is not enrolled in 3D Secure (Authentication Only)
P	Transaction is Pending
R	Retry Limits Exceeded, Transaction Not Processed
T	Address Verification Failed
U	Card Security Code Failed
V	Address Verification and Card Security Code Failed
	Virtual Account
8041	Virtual account registration error.
8042	The tXid error during the vertual account registration.
8045	requestVacctCustomerInquiryAPI is null.
9201	Server is busy. Please kindly try again in few minutes.
9202	Server is busy. Please kindly try again in few minutes.
9203	Failed to generate virtual account. Pool is empty or reached maximum.
9204	Server is busy. Please kindly try again in few minutes.
9205	Failed to generate virtual account. Invalid Virtual Account.
9206	Server is busy. Please kindly try again in few minutes.
9207	Reference Number Maximum Length Exceed. [referenceNo] should have maximum 40 characters length.
9208	Error in non-usage of criterion information.
9209	the payment amount is too small.
9210	Error in expiration date of deposit, expiration time for deposit, and inclusion of letters.
9211	Expiration date and time for deposit length is not valid.
9212	Error of check for merchant ID, payment method.
9213	TB_TRANS_HISTORY registration error.
9214	Failed in inquiring settlement interval.
9215	Order number redundancy check (TB_MOID_VERIFY) updates error.
9216	Virtual account failure ledger (TB_VACCT_FAIL) registration error.
9217	Order number redundancy check (TB_MOID_VERIFY) delete error.
9218	Virtual account ledger inquiry failure.
9219	Server is busy. Please kindly try again in few minutes.
9220	Server is busy. Please kindly try again in few minutes.
9221	Error in non-usage of criterion information(VACCT_SET).
9222	Error in non-usage of criterion information(VACCT_CONT).
9223	Invalid customer id.
9224	Error of check for customerId.
9225	Invalid Merchant Token. Contact NICEPay for further information.
9226	VacctNo is exceeded limit digit.
9227	DB insert error.
9228	Transaction not found.
9229	Fix account accountType error.
9230	Not exist customerId.
9231	Data is null error.
9232	iMid is exist.
9233	vacctNo is duplicate.
9234	customerId already exist.
9235	Invalid customer name.
9236	Try check date.
9237	Invalid BankCd.
	Cancel
8061	Full canceled error.
8062	Partial cancled error.
8063	The MID error during the full cancel.
8064	The tXID error during the full cancel.
8065	The MID error during the partial cancel.
8066	The tXID error during the partial cancel.
8067	The amount error during the partial cancel.
8090	Net canceled error.
9301	Invalid Cancel Type.
9302	Server is busy. Please kindly try again in few minutes.
9303	Server is busy. Please kindly try again in few minutes.
9304	TB_TRANS_HISTORY update error.
9305	Ledger card registration error.
9306	Ledger partial cancel registration error.
9307	Cards query error.
9308	Database connection error.
9309	Bank connection error.
9310	TB_TRANS HISTORY registration error.
9311	Transaction number generated error.
9312	No cancellation amount or cancellation amount includes the letter.
9313	Partial cancellation is only possible mandiri.
9314	Can not cancel your request transaction number.
9315	Cancel Ledger duplicate registration error.
9316	Bank code duplication errors.
9317	Bank Mandiri is available once a partial canceled.
9318	Virtual account can not request to cancel.
9319	The amount you entered is larger than the amount you want to cancel.
9320	Can not cancel the entire data already partially canceled.
9321	Please fill in the requested amount greater than zero.
9322	Merchant infomaition(CARD_BIN) query fail.
9323	Merchant infomaition(Merchant_INFO) query fail.
9324	MERCHANT_CARDINFO query error.
9325	B_MID,B_TID query error.
9326	It can not be canceled after purchase.
9327	It can not be partial cancelation before purchase.
9328	The information can not be canceled (Void Risk Check).
9329	The information can not be partial cancelation (Void Risk Check).
9330	Virtual account deposit has been completed can not be canceled.
9331	The merchant can not be canceled.
9332	The merchant can not be partial cancellation.
9333	The merchant can not be cancellation. (Debt cancellation prevent restrictions)
9334	Cancellation period exceeds(limit 90 days).
	One Pass
8200	One Pass inquiry error.
8201	OnePass Token Duplicate.
8202	OnePass Invalid Amount.
	CVS
9501	Server is busy. Please kindly try again in few minutes.
9502	Server is busy. Please kindly try again in few minutes.
9503	Failed to generate CVS Number. Pool is empty or reached maximum.
9504	Server is busy. Please kindly try again in few minutes.
9505	Failed to generate virtual account. Invalid CVS.
9506	Server is busy. Please kindly try again in few minutes.
9507	Reference Number Maximum Length Exceed. [referenceNo] should have maximum 40 characters length.
9508	Error in non-usage of criterion information.
9509	the payment amount is too small.
9510	Error in expiration date of deposit, expiration time for deposit, and inclusion of letters.
9511	Expiration date and time for deposit length is not valid.
9512	Error of check for merchant ID, payment method.
9513	TB_TRANS_HISTORY registration error.
9514	Failed in inquiring settlement interval.
9515	Order number redundancy check (TB_MOID_VERIFY) updates error.
9516	CVS NUmber failure ledger (TB_CVS_FAIL) registration error.
9517	Order number redundancy check (TB_MOID_VERIFY) delete error.
9518	CVS ledger inquiry failure.
9519	Server is busy. Please kindly try again in few minutes.
9520	Server is busy. Please kindly try again in few minutes.
9521	Error in non-usage of criterion information(CVS_SET).
9522	Error in non-usage of criterion information(MITRA_CONT).
9523	Invalid customer id.
9524	Error of check for customerId.
9525	Invalid Merchant Token. Contact NICEPay for further information.
9526	CVS Number is exceeded limit digit.
9527	DB insert error.
9528	Transaction not found.
9529	Fix account accountType error.
9530	Not exist customerId.
9531	Data is null error.
9532	iMid is exist.
9533	CVS Number is duplicate.
9534	customerId already exist.
9535	Invalid customer name.
9536	Try check date.
	EWALLET
9750	E-Wallet Generate ID Fail.
9751	Invalid Parameter.
9752	E-Wallet Payment Fail.
	CLICKPAY
9801	Internal system error
9802	Invalid parameter
9803	User registration error
9804	Invalid Token
9805	Invalid Card Number
9806	Transaction Payment Fail
9807	Transaction Reversal Fail
9808	TXID is duplicate
9809	Failed in inquiring settlement interval
9810	Other error

CIMB Error Code

Value	Description
0	APPROVED OR COMPLETED
1001	Error setting mandatory fields, TRANSACTION_TYPE is empty!
1002	Invalid value for TRANSACTION_TYPE! Acceptable Value : QUERY=1, SALES=2, AUTHORIZED=3, CAPTURE=4
1003	This transaction is not authorized, cannot proceed to be captured.
1004	Error setting mandatory fields, MERCHANT_ACC_NO is empty!
1005	Invalid MERCHANT_ACC_NO! Unable to find merchant with provided MERCHANT_ACC_NO.
1006	The status of this MERCHANT_ACC_NO is suspended! All transactions are not allowed temporary. Please check with administrator for the status.
1007	The status of this MERCHANT_ACC_NO is still pending and not yet activated. Please check with administrator for the status.
1008	The status of this MERCHANT_ACC_NO is invalid! Please check the merchant setting.
1009	The setting of this MERCHANT_ACC_NO does not allow the requested transaction type. Please check the merchant setting.
1010	The setting of this MERCHANT_ACC_NO do not allow transaction request from this IP address. Please checks the merchant allow IP setting.
1011	Error setting mandatory fields, AMOUNT is empty!
1012	Invalid value for AMOUNT
1013	Error setting mandatory fields, CARD_NO is empty!
1014	Error setting mandatory fields, CARD_EXP_MM is empty!
1015	Error setting mandatory fields, CARD_EXP_YY is empty!
1016	Error setting mandatory fields, CARD_CVC is empty!
1017	Invalid value for CARD_NO. CARD_NO must be numeric and with valid length!
1018	Invalid value for CARD_EXP_MM. CARD_EXP_MM must be numeric and with valid length!
1019	Invalid value for CARD_EXP_YY. CARD_EXP_YY must be numeric and with valid length!
1020	Invalid value for CARD_CVC. CARD_CVC must be numeric and with valid length!
1021	Invalid payment method. Please call bank to check Merchant Settings.
1022	Amount has been over transaction limit for today. Please call bank to check Merchant Settings.
1023	Transaction not permitted through this merchant type. Please call bank to check Merchant Settings.
1024	Undefined Error. Error Code:1024
3001	Error setting mandatory fields, TRANSACTION_ID is empty! TRANSACTION_ID is required for CAPTURE transaction type
3002	Error setting mandatory fields, RETURN_URL is empty!
3003	Error setting mandatory fields, RESPONSE_TYPE is empty!
3004	Error setting mandatory fields, TXN_URL is Null for RESPONSE_TYPE using HTTP!
3005	Invalid value for RESPONSE_TYPE for non-3D transaction! Acceptable Value : HTTP, XML, PLAIN
3006	Error setting mandatory fields, TXN_SIGNATURE is empty!
3007	Invalid value for TXN_SIGNATURE! Computed signature does not match one included in the request.
3008	Invalid format for TXN_SIGNATURE! TXN_SIGNATURE must be length of 32, and in hexadecimal format.
3009	Unable to find the transaction record!
3010	MERCHANT_ACC_NO not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_ACC_NO is the same MERCHANT_ACC_NO submitted during previous transaction.
3011	AMOUNT not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the AMOUNT is the same AMOUNT submitted during previous transaction.
3012	CUSTOMER_ID not matched with previous submitted transaction request! To capture/query previous transaction, if this field is being used, please ensure the CUSTOMER_ID is the same CUSTOMER_ID submitted during previous transaction.
3013	MERCHANT_TRANID not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_TRANID is the same MERCHANT_TRANID submitted during previous transaction.
3014	Insecure mode for RETURN_URL. Please specify an URL which uses HTTPS protocol!
3015	Insecure mode for TXN_URL. Please specify an URL which uses HTTPS protocol!
4001	Error setting mandatory fields, CARD_HOLDER_NAME is empty!
4002	Error setting mandatory fields, MERCHANT_TRANID is empty!
4003	Duplicate MERCHANT_TRANID detected! Please ensure the MERCHANT_TRANID is always unique.
4004	Error setting mandatory fields, TXN_DESC is empty!
4005	Error setting mandatory fields for 3D transaction, MPI_CODE is empty!
4006	Error setting mandatory fields for 3D transaction, MPI_CAVV is empty!
4007	Error setting mandatory fields for 3D transaction, MPI_CAVV_ALG is empty!
4008	Error setting mandatory fields for 3D transaction, MPI_ECI is empty!
4009	Error setting mandatory fields for 3D transaction, MPI_MSG is empty!
5001	Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_EMAIL is empty!
5002	Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_COUNTRY is empty!
5003	Error setting mandatory fields for fraud risk detection, FR_BILLING_ADDRESS is empty!
5004	Error setting mandatory fields for fraud risk detection, FR_SHIPPING_ADDRESS is empty!
5005	Error setting mandatory fields for fraud risk detection, FR_SHIPPING_COST is empty!
5006	Error setting mandatory fields for fraud risk detection, CUSTOMER_IP is empty!
5007	Error setting mandatory fields for fraud risk detection, FR_PURCHASE_HOUR is empty!
5008	Transaction was blocked due to fraud level exceeded threshold limit.
5009	Transaction was blocked due to blacklisted card detected.
6001	Unable to get connection to MPI Server!
6002	Time out occurred during communication with MPI Server!
6003	Unable to update MPI Ref. No in system. Please try again.
6004	There was an error occurred during 3D authentication with MPI. Please check logs for details.
6005	Invalid message or response received from MPI. Please try again.
6006	MPI Settings are not configured correctly. Please check MPI_HOST and MPI_PORT in system configuration.
6007	Error occurred when trying to display ACS Form in web browser for 3D authentication. Please try again.
6008	Problem occurred on MPI side, cannot proceed to display ACS Form. Please check MPI message or try again.
6009	Unable to locate back transaction to update system after 3-D authentication process. Please try again.
6010	Empty response received from MPI, please try again.
6011	MPI Code received is not allowed to proceed to process the transaction.
6012	Transaction was aborted because 3-D authentication process is not completed.
6013	Attempted duplicate submission of 3-D authentication result. Please try with new transaction.
6014	MALL NAME is required for 3-D transaction. Please call bank to check Merchant Settings.
6015	MALL URL is required for 3-D transaction. Please call bank to check Merchant Settings.
6016	Invalid value for RESPONSE_TYPE for 3D transaction! Acceptable Value : HTTP only
8001	This MERCHANT_ACC_NO is not authorized to proceed with this transaction via website! Please check the merchant setting.
8002	This MERCHANT_ACC_NO is not authorized to proceed with this transaction via batch upload! Please check the merchant setting.
8003	Exception while query Payment Server!
8004	Exception while checking for fraud risk!
9999	Internal Exception. Please call bank to report.
9988	Server Time Out Exception.
9977	Bank Connection Error!
9966	Reply from bank is empty/incorrect!
9967	Bank rejected transaction!
9955	Error when trying to insert transaction table. Transaction ID is empty!
9933	Server interruption occurred during processing. Manual checking required. Please inform Administrator.
9935	Cancel payment by customer.
9937	Insufficient point to redeem in cardholder's account. Please enter another card number.

F.A.Q

Q	What is the callback URL?
> Answer	Callback URL is a URL that accepts the response data from NICEPAY.
Q	What is the dbprocess URL?
> Answer	DbProcess URL is a URL that is provided to receive and process Notifications.
Q	Can merchant check payment status?
> Answer	Yes, NICEPAY provides Status Inquiry API.
Q	Can merchants use provided testing Merchant ID and Merchant Key to test in the Live Environment?
> Answer	Yes, Merchant ID & Merchant Key provided for testing can be used in the Live Environment.
Q	What merchant must do if customer payment has been rejected?
> Answer	First, merchant can check Virtual Account Number, Expiry payment, and payment amount and match it with the invoice. If it is correct, and the payment was rejected, please use another payment channel, for example, initially customer make a payment at ATM and the result was rejected, please make payments with another channel options, such as; Mobile Banking. In case of rejection after changing a channel of payment, please contact NICEPAY Customer Service.
Q	What if the customer has successfully pay the transaction, but they have not receive any email?
> Answer	Normally, customer will receive a confirmation email within a maximum of 5 minutes. If customer do not receive a payment confirmation email within 5 minutes, please send an email to customer service along with proof of payment.

Have any inquiry ?
Feel free contact us : [email protected].

Changelog

2.75

Add API E-wallet AstraPay

2.74

General info RecurringToken & PreauthToken Live integration check

2.73

add Handler Flow

2.72

06 Juni 2022

Add BankCd DKI

2.71

26 April 2022

1. Update Guide Flow V1 Prof & CC Ent
2. Update Guide Flow CC V2 Prof & Ent

2.70

23 Maret 2022

1. New Page for API V2 Professional
2. Fix : Remove mitraCd sample POST for Notification
3. Fix : Remove Scroll bar in Page API V1 Professional and Enterprise

2.69

15 Maret 2022

1. Add GPN payment method (09)

2.68

21 Januari 2022

1. Update sample response Credit Card to callBackurl with parameter on V2 direct

2.67

20 Januari 2022

1. add bank code BNC
2. add parameter sellersUrl
3. add flow ShopeePay and flow Indodana v2 direct

2.66

7 April 2021

1. Add response parameter cancelReferenceNo Optional For CC, on V2 Cancel
2. Fix: Parameter returnJsonFormat Optional For Shopeepay to get URL redirect Shopeepay
3. Fix: Sample JSON Request and Response for QRIS Registration, on V1 direct

2.65

30 Maret 2021

1. Add Request Parameters Required For Indodana, on V2 direct
2. Add Indodana Mitra Code
3. Fix: Sample JSON Request and Response for Payloan Registration, on V2 direct
4. Fix: E-Wallet Status Code

2.64

19 Maret 2021

1. Add Request Parameters Required For E-Wallet Shopeepay, on V1
2. Add Request Parameters Required For E-Wallet Shopeepay, on V2 direct
3. Fix: Sample JSON Request and Response for E-Wallet Registration, on V2 direct

2.63

10 Maret 2021

1. Add Request Parameters Required For Jenius Pay, on V1
2. Add Jenius option on payment page, on V1 Professional

2.62

3 Maret 2021

1. Add Request Parameters Required For Jenius Pay, on V2
2. Add Jenius Pay Mitra Code
3. Fix: Sample JSON Request and Response for ClickPay Registration, on V2

2.61

2 December 2020

1. Fix typo on payloan data V2.
2. Fix: Request and Response type on Ewallet V1 Enterprise, from JSON to POST Parameter.
3. Fix typo on ewallet data V2

2.60

5 November 2020

1. Fix Permata Syariah Bank Code
2. Add E-Wallet Status Code
3. Add Payloan Status Code
4. Fix QRIS Status Code
5. Add Payment Response/Callback Parameter to V1 Professional

2.57

26 October 2020

1. Fix Sample POST Parameter Request for Payloan
2. Fix Request Method for Payloan

2.56

7 October 2020

1. Add QRIS Documentation
2. Update response parameter Registration
3. Add parameter required for QRIS

2.55

18 September 2020

1. Added Permata Syariah as Supported Bank
2. Added ShopeePay as Supported Mitra
3. Added DANA as Supported Mitra
4. Added Details: LinkAja does not support special characters on cartData
5. Update Sample Payload for V2 APIs
6. Changed wording JSON OBJECT to JSON STRING for cartData
7. Update New Parameters for API V2 Register for QRIS
8. Fix API URL for Akulaku Confirm Receipt
9. Fix wrong VA API V2 Diagram Flow
10. Fix Details: API V2 Payment callBack does not use String Query but POST Parameter

2.51

4 June 2020

1. Fix userAgent Requirement for CC
2. Fix Seller and cartData for E-Wallet
3. Remove Unused JSON Button

2.50

4 June 2020

1. Online Docs UI and UX Update
2. Update E-Wallet Documentation
3. Update Payloan Documentation
4. Minor Fixes on Parameter Length and Type
5. Add Git Link for Plugins and Libraries
6. Update New POSTMAN Collection

2.15

17 May 2018

1. Update card error code

2.13

14 May 2018

1. Add parameter payment API timeStamp, merchantToken

2.12

18 April 2018

1. Update Error Code

2.07

01 February 2018

1. Add parameter CardHolderNm on Payment API

2.06

01 january 2018

1. Add parameter fee on Payment, Notification, and Inquiry

2.05

15 December 2017

1. Update Error Code

2.04

14 November 2017

1. Change url from WWW to API

2.03

10 October 2017

1. Add parameter cardExpYymm on Payment, Notification, and Inquiry API

2.02

10 July 2017

1. Update Registration API
2. Update Notification API
3. Update Inquiry API
4. Update Credit Card Installation information API

2.01

10 July 2017

1. Add parameter Timestamp

2.00

06 July 2017

1. Initial Release API Version 2

1.18.9

18 April 2018

1. Update Error Code

1.18.5

1 February 2018

1. Add parameter cardHolderNm on Payment API

1.17.2

29 Mar 2017

1. Add ClickPay Payment

1.17.1

24 Mar 2017

1. Add card installment API
2. Add notification parameter