Registration
Specifications - Register
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Payment Methods:
Code | PayMethod | Description |
---|---|---|
01 | Credit Card | Order will be created |
02 | Virtual Account | Virtual Account (vacctNo ) will be created |
03 | Convenience Store | Pay Number (payNo ) will be created |
04 | ClickPay | Order will be created |
05 | E-Wallet | Order will be created |
06 | Payloan | Order will be created |
08 | QRIS | Order and QRIS will be created |
09 | GPN Card | Order will be created |
Request Parameters - Register
Sample JSON Request
{
"bankCd": "BMRI",
"timeStamp": "20200923132509",
"iMid": "IONPAYTEST",
"payMethod": "02",
"currency": "IDR",
"amt": "529500",
"referenceNo": "MerchantRefrenceNo001",
"goodsNm": "Test transaction",
"dbProcessUrl": "https://merchant.com/api/dbProcessUrl/Notif",
"description": "",
"merchantToken": "a571183b8fd6c6051bcfa85b09c2bf2013e055ce313d00494dfb04b17a6a13ab",
"reqDt": "",
"reqTm": "",
"reqDomain": "merchant.com",
"reqServerIP": "127.0.0.1",
"reqClientVer": "",
"userIP": "127.0.0.1",
"userSessionID": "x97CLk6=6habd4usu8mqeh4mpgt4ph63secf7ush",
"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": "en-US,en;q=0.9,id;q=0.8",
"cartData": "{\"count\":1,\"item\":[{\"img_url\":\"https://images.ctfassets.net/od02wyo8cgm5/14Njym0dRLAHaVJywF8WFL/1910357dd0da0ae38b61bc8ad3db86e4/cloudflyer_2-fw19-grey_lime-m-g1.png\",\"goods_name\":\"Shoe\",\"goods_detail\":\"Shoe\",\"goods_amt\":529500}]}",
"instmntType": "2",
"instmntMon": "1",
"recurrOpt": "0",
"vacctValidDt": "20200927",
"vacctValidTm": "121517",
"merFixAcctId": "",
"billingNm": "John Doe",
"billingPhone": "081234567890",
"billingEmail": "[email protected]",
"billingAddr": "Jl. Perumnas",
"billingCity": "Bandung",
"billingState": "Jawa Barat",
"billingPostCd": "12345",
"billingCountry": "Indonesia",
"deliveryNm": "John Doe",
"deliveryPhone": "081234567890",
"deliveryAddr": "Jl. Perumnas",
"deliveryCity": "Bandung",
"deliveryState": "Jawa Barat",
"deliveryPostCd": "12345",
"deliveryCountry": "Indonesia"
}
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 | 01 |
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 | {} |
instmntType Required for CC | N | 2 | Installment Type | 1 |
instmntMon Required | N | 2 | Installment Month Required for CC | 1 |
recurrOpt Required | N | 2 | 0 : Automatic Cancel1 : Do not cancel 2 : Do not make token | 2 |
bankCd Required for VA | A | 4 | Bank Code | CENA |
vacctValidDt Required | N | 8 | VA Expiry Date (YYYYMMDD) | 20200303 |
vacctValidTm Required | N | 6 | VA Expiry Time (HH24MISS) | 135959 |
merFixAcctId Required | AN | 40 | Merchant Reserved VA ID | 4 |
mitraCd Required for CVS, E-Wallet, Payloan, QRIS | A | 4 | Mitra Code | AKLP |
userIP Required for CC, E-Wallet, Payloan, QRIS | AN | 15 | User IP | 127.0.0.1 |
dbProcessUrl Required | ANS | 255 | Notification URL | https://merchant.com/dbProcessUrl |
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 |
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 Required for QRIS | AN | 32 | Shop Id | NICEPAY |
Cart Data - Register
Parameter | Description |
---|---|
count | Total cart data count |
item | |
item -> img_url | Good's image URL (50x50 size) |
item -> goods_name | Good's name |
item -> goods_detail | Good's description |
item -> goods_amt | Good's amount |
{
"count": "2",
"item": [
{
"img_url": "http://img.aaa.com/ima1.jpg",
"goods_name": "Item 1 Name",
"goods_detail": "Item 1 Detail",
"goods_amt": "700"
},
{
"img_url": "http://img.aaa.com/ima2.jpg",
"goods_name": "Item 2 Name",
"goods_detail": "Item 2 Detail",
"goods_amt": "300"
}
]
}
Response Parameters - Register
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST02202009261955267274",
"referenceNo": "MerchantRefrenceNo001",
"payMethod": "02",
"amt": "529500",
"transDt": "20200926",
"transTm": "195526",
"description": null,
"bankCd": "BMRI",
"vacctNo": "70014000091955267274",
"mitraCd": null,
"payNo": null,
"currency": "IDR",
"goodsNm": "Test transaction",
"billingNm": "John Doe",
"vacctValidDt": "20200927",
"vacctValidTm": "121517",
"payValidDt": null,
"payValidTm": null,
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}
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 |
payMethod | N | 2 | Payment Method | When success |
amt | N | 12 | Payment amount | When success |
currency | A | 3 | Currency | When success VA and CVS |
goodsNm | AN | 100 | Goods Name | When success VA and CVS |
billingNm | A | 30 | Buyer name | When success VA and CVS |
transDt | N | 8 | Transaction Date (YYYYMMDD) | When success |
transTm | N | 6 | Transaction Time (HH24MISS) | When success |
description | AN | 100 | Transaction Description | When success VA and CVS |
bankCd | A | 4 | Bank Code | When success VA |
vacctNo | N | 20 | Virtual Account No. | When success VA |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) | When success VA |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | When success VA |
mitraCd | A | 4 | Mitra Code | When success CVS, Payloan, E-Wallet |
payNo | N | 12 | CVS Payment Number | When success CVS |
payValidDt | N | 8 | CVS Expiry Date (YYYYMMDD) | When success CVS |
payValidTm | N | 6 | CVS Expiry Time (HH24MISS) | When success CVS |
requestURL | ANS | 360 | Request URL | - |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) | When success QRIS |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) | When success QRIS |
qrContent | ANS | 360 | QR String in Plain Text | When success QRIS |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes | When success QRIS |
Payment
Specifications - Payment
API url | /nicepay/direct/v2/payment |
Request Method application/x-www-form-urlencoded | Popup , Redirect , Submit |
Description | Performs Payment Request to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Payment Methods Available for Payment:
Code | PayMethod | Description |
---|---|---|
01 | Credit Card | If 3DS / MIGS authentication is required, users will be redirected to the card issuer page. |
04 | ClickPay | Redirect to Bank Page |
05 | E-Wallet | Redirect to E-Wallet Page / App Notification |
06 | Payloan | Redirect to Payloan Mitra Page |
Request Parameters - Payment
Sample Request
https://dev.nicepay.co.id/nicepay/direct/v2/payment?timeStamp=20180302112151&tXid=TESTIDTEST01201803021122164984&merchantToken=b4171e8228be7a75d19ad29b509e76d5fc70a4c000ef87bc55cf0cda72767e72&cardNo=1234567890123456&cardExpYymm=2006&cardCvv=123&cardHolderNm=Thomas Alfa Edison&recurringToken=&preauthToken=&clickPayNo=&dataField3=&clickPayToken=&callBackUrl=https://merchant.com/callBackUrl
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp Required | N | 14 | API Request Timestamp (YYYYMMDDHH24MISS) | 20170708123456 |
tXid Required | AN | 30 | Transaction ID | BMRITEST0102201607291027025291 |
cardNo Required for CC | N | 20 | Credit Card Number | 1234567890123450 |
cardExpYymm Required for CC | N | 4 | Card Expiry (YYMM) | 2412 |
cardCvv Required for CC | N | 4 | Card CVV | 141 |
cardHolderNm Required for CIMB | A | 50 | Card Holder Name | John Doe |
recurringToken Required for Recurring | AN | 64 | Recurring Token | 9338d54573688ae18e175240b025... |
preauthToken Required for Capture | AN | 64 | Pre-Auth Token | 9338d54573688ae18e175240b025... |
merchantToken Required | AN | 255 | merchantToken | 6cfccfc0046773c1b589d8e98f8b59... |
callBackUrl Required | ANS | 255 | Payment Result URL | https://merchant.com/callBackUrl |
clickPayNo | N | 16 | ClickPay No | 1234567890123450 |
dataField3 | N | 16 | Token 3 for Clickpay | 123 |
clickPayToken | N | 6 | Code Response Token | 123456 |
Response Parameters - Payment
Sample Response to callbackUrl with parameter
referenceNo: ORD12345
authNo: 084760
ccTransType: 1
mRefNo:
issuBankCd: BMRI
issuBankNm: PT Bank Mandiri (Persero)
tXid: IONPAYTEST01201804191202084760
transTm: 120208
mitraCd:
recurringToken:
resultCd: 0000
transDt: 20180419
acquBankCd: BMRI
acquBankNm: PT Bank Mandiri (Persero)
instmntType: 2
instmntMon: 1
payMethod: 01
receiptCode:
cardExpYymm: 2012
cardNo: 422222******2222
description:
resultMsg: SUCCESS
goodsNm: Test Transaction Nicepay
preauthToken:
amt: 10000
billingNm: John Doe
currency: IDR
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 |
payMethod | N | 2 | Payment Method | When success |
amt | N | 12 | Payment Amount | When success |
currency | A | 3 | Currency | When success |
goodsNm | AN | 100 | Goods Name | When success |
billingNm | A | 30 | Buyer Name | When success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | When success |
transTm | N | 6 | Transaction Time (HH24MISS) | When success |
description | AN | 100 | Transaction Description | When success |
authNo | N | 10 | Approval Number | When success, CC |
issuBankCd | A | 4 | Issuer Bank Code | When success, CC |
acquBankCd | A | 4 | Acquire Bank Code | When success, CC |
cardNo | ANS | 20 | Masked Card No | When success, CC |
cardExpYymm | N | 4 | Card Expiry (YYMM) | When success, CC |
instmntMon | N | 2 | Installment Month | When success, CC |
instmntType | N | 2 | Installment Type | When success, CC |
recurringToken | AN | 64 | Recurring Payment Token | When Success CC Recurring |
preauthToken | AN | 64 | Pre-Auth Payment Token | When Success CC Pre-Auth |
ccTransType | N | 2 | Credit Card Transaction Type | When Success, CC1 : Normal2 : Recurring3 : Pre-auth4 : Capture |
vat | N | 12 | Vat | When Success, CC |
fee | N | 12 | Service Fee | When Success, CC |
notaxAmt | N | 12 | Tax-free Amount | When Success, CC |
mitraCd | A | 4 | Mitra Code | When success ClickPay, E-Wallet, Payloan |
receiptCode | ANS | 20 | Authrization No | When success ClickPay |
mRefNo | AN | 18 | Bank Reference No | When success ClickPay |
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 | Performs Inquiry Request to NICEPAY for Status Checking |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - Inquiry
Sample JSON Request
{
"timeStamp": "20200818121517",
"merchantToken": "38ca5d2f91f7ebfad5558563fa0435f874d362cf0f2498e3fce256a8f0f57d82",
"referenceNo": "ORDER1210",
"tXid": "IONPAYTEST02202009231352136562",
"amt": "1000",
"iMid": "IONPAYTEST"
}
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp Required | N | 14 | API Request Date (YYYYMMDDHH24MISS) | 20170708123456 |
tXid Required | AN | 30 | Transaction Id | IONPAYTEST02201607291027025291 |
iMid Required | AN | 10 | Merchant Id | IONPAYTEST |
referenceNo Required | ANS | 40 | Merchant Order No | OrdNo20160525000-52104 |
amt Required | N | 12 | Transaction Amount | 1000 |
merchantToken Required | AN | 255 | merchantToken | 6cfccfc0046773c1b89d8e98f8b59... |
Response Parameters - Inquiry
Sample JSON Response
{
"tXid": "IONPAYTEST02202009231352136562",
"iMid": "IONPAYTEST",
"currency": "IDR",
"amt": "1000",
"instmntMon": "1",
"instmntType": "2",
"referenceNo": "ORDER1210",
"goodsNm": "Test Transaction Nicepay",
"payMethod": "02",
"billingNm": "John Doe",
"reqDt": "20200923",
"reqTm": "135213",
"status": "3",
"resultCd": "0000",
"resultMsg": "unpaid",
"cardNo": null,
"preauthToken": null,
"acquBankCd": null,
"issuBankCd": null,
"vacctValidDt": "20200924",
"vacctValidTm": "121517",
"vacctNo": "70014000091352136562",
"bankCd": "BMRI",
"payNo": null,
"mitraCd": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": "20200923",
"transTm": "135213",
"recurringToken": null,
"ccTransType": null,
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": null,
"cardExpYymm": null,
"acquBankNm": null,
"issuBankNm": null,
"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 | Performs Transaction Cancel Request 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 |
fee | N | 12 | Fee | 0 |
vat | N | 12 | Vat | 0 |
notaxAmt | N | 12 | Tax-free Amount | 0 |
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 |
---
Credit Card
Transaction Flow:
- Merchant Request Credit Card Registration to NICEPay.
- Merchant Request Credit Card Payment to NICEPay.
- NICEPay will redirect to 3DS / MIGS Bank Page.
- Customer input OTP in Bank Page.
- NICEPay send notification
- Merchant Handle notification
Registration - Credit Card
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - Credit Card Registration
Sample JSON Request
{
"timeStamp":"20180123100505",
"iMid":"IONPAYTEST",
"payMethod":"01",
"currency":"IDR",
"amt":"10000",
"referenceNo":"ORD12345",
"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":"12345678",
"deliveryAddr":"Jalan Bukit Berbunga 22",
"deliveryCity":"Jakarta",
"deliveryState":"DKI Jakarta",
"deliveryPostCd":"12345",
"deliveryCountry":"Indonesia",
"dbProcessUrl":"https://merchant.com/api/dbProcessUrl/Notif",
"merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
"reqDomain":"merchant.com",
"reqServerIP":"127.0.0.1",
"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",
"instmntType":"2",
"instmntMon":"1",
"recurrOpt":"2"
}
Credit Card Registration Additional Parameters
Parameters | Type | Size | Description | Value |
---|---|---|---|---|
payMethod Required | N | 2 | Credit Card (CC) | 01 |
instmntType Required | N | 2 | Installment Type | 2 |
instmntMon Required | N | 2 | Default 1 for Full Payment | 1 |
userIP Required | AN | 15 | User IP address | 127.0.0.1 |
userAgent Required | ANS | 100 | User Agent Information | Mozilla |
recurrOpt Required For Recurring CC | N | 2 | 0 : Automatic Cancel1 : Do not cancel 2 : Do not make token | 2 |
Response Parameters - Credit Card Registration
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST01202009181410155748",
"referenceNo": "ORD12345",
"payMethod": "01",
"amt": "100",
"transDt": "20200918",
"transTm": "141017",
"description": "",
"bankCd": null,
"vacctNo": null,
"mitraCd": null,
"payNo": null,
"currency": null,
"goodsNm": null,
"billingNm": null,
"vacctValidDt": null,
"vacctValidTm": null,
"payValidDt": null,
"payValidTm": null,
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transactionn ID |
referenceNo | ANS | 40 | Merchant Reference No. |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transction Tim (HH24MISS) |
description | AN | 100 | Transaction Description |
bankCd | A | 4 | Bank Code |
vacctNo | N | 20 | VA Number |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) |
payNo | N | 12 | Payment Number |
mitraCd | AN | 4 | Mitra Code |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) |
payValidTm | N | 6 | Expiry Time (HH24MISS) |
requestURL | ANS | 360 | Request URL |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
qrContent | ANS | 360 | QR String in Plain Text |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes |
Payment - Credit Card
API url | /nicepay/direct/v2/payment |
Request Method application/x-www-form-urlencoded | Popup , Redirect , Submit |
Description | Performs Payment Request to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - Credit Card Payment
Sample POST Request Parameter
timeStamp=20180123100505&tXid=IONPAYTEST01201804191202084760&merchantToken=f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5&cardNo=4222222222222222&cardExpYymm=2006&cardCvv=123&cardHolderNm=Thomas Alfa Edison&callBackUrl=http://merchant.com/callbackUrl
Credit Card Payment Parameters
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp Required | N | 14 | API Request Timestamp (YYYYMMDDHH24MISS) | 20170708123456 |
tXid Required | AN | 30 | Transaction ID | BMRITEST0102201607291027025291 |
cardNo Required | N | 20 | Card Number | 1234567890123450 |
cardExpYymm Required | N | 4 | Expiry (YYMM) | 2412 |
cardCvv Required | N | 4 | Card CVV | 141 |
cardHolderNm Required CIMB | AN | 50 | Card Holder Name | John Doe |
merchantToken Required | AN | 255 | merchantToken | 9338d54573688ae18e175240b025… |
callBackUrl Required | ANs | 255 | Payment Result URL | https://merchant.com/callBackUrl |
Response Parameters - Credit Card Payment
Sample Response to callbackUrl with parameter
resultCd: 0000
resultMsg: SUCCESS
tXid: BMRIFRMS0101202201201607529730
referenceNo: ORD12345
payMethod: 01
amt: 1000
transDt: 20220120
transTm: 161703
description:
authNo: 769769
issuBankCd: BMRI
acquBankCd: BMRI
cardNo: 524325******3412
receiptCode:
mitraCd:
recurringToken: af747d94690d28f22c97466d3d2807ccad630fb542337320521c11316008d856
preauthToken:
currency: IDR
goodsNm: Test Transaction Nicepay
billingNm: John Doe
ccTransType: 1
mRefNo:
instmntType: 2
instmntMon: 1
cardExpYymm: 2503
issuBankNm: Mandiri
acquBankNm: Mandiri
timeStamp: 20220120161141
merchantToken: bfeb48c833128a13ff09767909babb4cb4f8c2e0ccc6688fdb1a48d6e8f468fc
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transaction ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transaction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
authNo | N | 10 | Approval No |
issuBankCd | A | 4 | Issue Bank Code |
issuBankNm | A | Issue Bank Name | |
acquBankCd | A | 4 | Acquire Bank Code |
acquBankNm | A | Acquire Bank Name. | |
cardNo | N | 20 | Masked Card Number |
cardExpYymm | N | 4 | Card Expiry (YYMM) |
currency | AN | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Billing Name |
ccTransType | AN | 2 | Credit Card Trans Type |
instmntType | N | 2 | Installment Type |
instmntMon | N | 2 | Insatllment Month |
receiptCode | ANS | 20 | Authrization No |
recurringToken | AN | 64 | Recurring Payment Token |
preauthToken | AN | 64 | Pre-Auth Payment Token |
mRefNo | AN | 18 | Bank Reference No |
mitraCd | A | 4 | Mitra Code |
timeStamp | N | 14 | API Request Date (YYYYMMDDHH24MISS) |
merchantToken | AN | 255 | merchantToken |
Virtual Account
NICEPay offers Virtual Account as Payment Method. By using this method, customer will have the option to make payment via ATM, SMS Banking, Internet Banking, or Mobile Banking. Real time Notification will be sent when customer has completed the payment.
Supported Bank:
- Bank Mandiri
- Bank International Indonesia Maybank
- Bank Permata
- Bank Permata Syariah
- Bank Central Asia (BCA)
- Bank Negara Indonesia 46 (BNI)
- Bank KEB Hana Indonesia
- Bank Rakyat Indonesia (BRI)
- Bank CIMB Niaga
- Bank DANAMON
- ATM Bersama, Alto, Link and Prima
Transaction Flow:
- Merchant Request VA Registration to NICEPay.
- Merchant Display VA Details and How-To-Pay to Customer.
- Customer Make Payment using Preferred Channel
- NICEPay Send Notification
- Merchant Handle Notification
Registration - Virtual Account
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - Virtual Account Registration
Sample JSON Request
{
"timeStamp":"20180123100505",
"iMid":"IONPAYTEST",
"payMethod":"02",
"currency":"IDR",
"amt":"10000",
"referenceNo":"ORD12345",
"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":"12345678",
"deliveryAddr":"Jalan Bukit Berbunga 22",
"deliveryCity":"Jakarta",
"deliveryState":"DKI Jakarta",
"deliveryPostCd":"12345",
"deliveryCountry":"Indonesia",
"description":"Transaction Description",
"dbProcessUrl":"https://merchant.com/api/dbProcessUrl/Notif",
"merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
"reqDomain":"merchant.com",
"reqServerIP":"127.0.0.1",
"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":"{}",
"bankCd":"CENA",
"vacctValidDt":"20180306",
"vacctValidTm":"091309",
"merFixAcctId":""
}
Virtual Account Registration Additional Parameters
Parameters | Type | Size | Description | Value |
---|---|---|---|---|
payMethod Required | N | 2 | Virtual Account | 02 |
bankCd Required | A | 4 | Bank Code | CENA |
vacctValidDt Required | N | 8 | VA Expiry Date (YYYYMMDD) | 20200303 |
vacctValidTm Required | N | 6 | VA Expiry Time (HH24MISS) | 091309 |
merFixAcctld Required for Fix VA Type | N | 8 | Merchant Reserved VA ID | 000045 |
Response Parameters - Virtual Account Registration
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST02202009181401585747",
"referenceNo": "ORD12345",
"payMethod": "02",
"amt": "100",
"transDt": "20200918",
"transTm": "140158",
"description": null,
"bankCd": "CENA",
"vacctNo": "111111101401585747",
"mitraCd": null,
"payNo": null,
"currency": "IDR",
"goodsNm": "Test Transaction Nicepay",
"billingNm": "John Doe",
"vacctValidDt": "20200920",
"vacctValidTm": "140157",
"payValidDt": null,
"payValidTm": null,
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transactionn ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
bankCd | A | 4 | Bank Code |
vacctNo | N | 20 | VA Number |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) |
payNo | N | 12 | Payment Number |
mitraCd | AN | 4 | Mitra Code |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) |
payValidTm | N | 6 | Expiry Time (HH24MISS) |
requestURL | ANS | 360 | Request URL |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
qrContent | ANS | 360 | QR String in Plain Text |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes |
Convenience Store
NICEPay offers Convenience Store as a Payment Method. Notification will be sent real-time when customer has completed the payment.
Supported CVS by NICEPay:
- Alfamart
- Indomaret
- Lawson
- Alfamidi
- Dan+Dan Store
Transaction Flow:
- Merchant Request CVS Registration to NICEPay.
- Merchant Display CVS Details and How-To-Pay to Customer.
- Customer Make Payment at preferred Convenience Store.
- NICEPay Send Notification
- Merchant Handle Notification
Registration - Convenience Store
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - Convenience Store Registration
Sample JSON Request
{
"timeStamp":"20180123100505",
"iMid":"IONPAYTEST",
"payMethod":"03",
"currency":"IDR",
"amt":"10000",
"referenceNo":"ORD12345",
"goodsNm":"Test Transaction Nicepay",
"billingNm":"John Doe",
"billingPhone":"08123456789",
"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",
"description":"Transaction Description",
"dbProcessUrl":"https://merchant.com/api/dbProcessUrl/Notif",
"merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
"reqDomain":"merchant.com",
"reqServerIP":"127.0.0.1",
"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":"{}",
"mitraCd":"ALMA",
"payValidDt":"20180308",
"payValidTm":"095500"
}
Parameters | Type | Size | Description | Example |
---|---|---|---|---|
payMethod Required | N | 2 | Convenience Store (CVS) | 03 |
mitraCd Required | A | 4 | Mitra Code | ALMA |
payValidDt Required | N | 8 | CVS Expiry Date (YYYYMMDD) | 20200404 |
payValidTm Required | N | 6 | CVS Expiry Time (HH24MISS) | 091309 |
Response Parameters - Convenience Store Registration
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST03202009181415187993",
"referenceNo": "ORD12345",
"payMethod": "03",
"amt": "10000",
"transDt": "20200918",
"transTm": "141518",
"description": "Transaction Description",
"bankCd": null,
"vacctNo": null,
"mitraCd": "ALMA",
"payNo": "9041181415187993",
"currency": null,
"goodsNm": null,
"billingNm": null,
"vacctValidDt": null,
"vacctValidTm": null,
"payValidDt": "20180308",
"payValidTm": "095500",
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transactionn ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
bankCd | A | 4 | Bank Code |
vacctNo | N | 20 | VA Number |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) |
payNo | N | 12 | Payment Number |
mitraCd | AN | 4 | Mitra Code |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) |
payValidTm | N | 6 | Expiry Time (HH24MISS) |
requestURL | ANS | 360 | Request URL |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
qrContent | ANS | 360 | QR String in Plain Text |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes |
ClickPay
NICEPay offers ClickPay as Payment Method.
Supported ClickPay by NICEPay:
- CIMB Clicks
- BCA KlikPay
- Jenius Pay
Transaction Flow :
- Merchant Request ClickPay Registration to NICEPay.
- Merchant Request ClickPay Payment to NICEPay.
- NICEPay will redirect to Bank Page.
- Customer pay ClickPay in Bank Page.
- NICEPay Send Notification.
- Merchant Handles Notification.
Registration - ClickPay
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - ClickPay Registration
Sample JSON Request
{
"timeStamp": "20210301081059",
"iMid": "TNICECP041",
"payMethod": "04",
"currency": "IDR",
"amt": "10000",
"referenceNo": "MerchantRefereceNo001",
"goodsNm": "Test transaction",
"dbProcessUrl": "https://merchant.com/api/dbProcessUrl/Notif",
"description": "Test Transaction",
"merchantToken": "ce0a46dcd64cd7a33910ad19c7646116135b71cfe985e21939d34086fc3de3b4",
"reqDt": "",
"reqTm": "",
"reqDomain": "merchant.com",
"reqServerIP": "127.0.0.1",
"reqClientVer": "",
"userIP": "127.0.0.1",
"userSessionID": "x97CLk6=6habd4usu8mqeh4mpgt4ph63secf7ush",
"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": "en-US,en;q=0.9,id;q=0.8",
"cartData": "{\"count\":\"1\",\"item\":[{\"img_url\":\"https://d3nevzfk7ii3be.cloudfront.net/igi/vOrGHXlovukA566A.medium\",\"goods_name\":\"Nokia 3360\",\"goods_detail\":\"Old Nokia 3360\",\"goods_amt\":\"10000\"}]}",
"billingNm": "John Doe",
"billingPhone": "081294529025",
"billingEmail": "[email protected]",
"billingCity": "Jakarta",
"billingState": "DKI Jakarta",
"billingPostCd": "12345",
"billingCountry": "Indonesia"
}
Parameters | Type | Size | Description | Example |
---|---|---|---|---|
payMethod Required | N | 2 | ClickPay | 04 |
mitraCd Required | A | 4 | Mitra code | CIMC |
mRefNo | AN | 18 | ClickPay CIMB Reference No |
Request Parameters Required - Jenius Registration
Parameters | Type | Size | Description | Example |
---|---|---|---|---|
payMethod Required | N | 2 | Jenius Pay | 04 |
mitraCd Required | A | 4 | Mitra code | JENC |
iMid Required | AN | 10 | Merchant ID | TNICECP041 |
Response Parameters - ClickPay Registration
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "TNICECP04104202103010811166278",
"referenceNo": "MerchantRefereceNo001",
"payMethod": "04",
"amt": "10000",
"transDt": "20210301",
"transTm": "081116",
"description": "Jenius Test",
"bankCd": null,
"vacctNo": null,
"mitraCd": null,
"payNo": null,
"currency": null,
"goodsNm": null,
"billingNm": null,
"vacctValidDt": null,
"vacctValidTm": null,
"payValidDt": null,
"payValidTm": null,
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transactionn ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
bankCd | A | 4 | Bank Code |
vacctNo | N | 20 | VA Number |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) |
payNo | N | 12 | Payment Number |
mitraCd | AN | 4 | Mitra Code |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) |
payValidTm | N | 6 | Expiry Time (HH24MISS) |
requestURL | ANS | 360 | Request URL |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
qrContent | ANS | 360 | QR String in Plain Text |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes |
Payment - ClickPay
API url | /nicepay/direct/v2/payment |
Request Method application/x-www-form-urlencoded | Popup , Redirect , Submit |
Description | Performs Payment Request to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Sample POST Parameter Request
callBackUrl=http://merchant.com/callbackUrl&tXid=TESTIMIDTEST01201803020917502088&timeStamp=20180305105635&merchantToken=58161e87726ecf5cdaed5462a994d9bf05172d786c1cbfe0ad03e133c5797645&clickPayNo=1234567890123456&dataField3=123&clickPayToken=123456
ClickPay Payment Parameters
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp | N | 14 | API Request Timestamp (YYYYMMDDHH24MISS) | 20170708123456 |
tXid | AN | 30 | Transaction ID | IONPAYTEST02201607291027025291 |
clickPayNo | N | 16 | ClickPay No | 1234567890123456 |
dataField3 | N | 16 | ClickPay Token 3 | 123 |
clickPayToken | N | 6 | Code Response Token | 123456 |
merchantToken | AN | 255 | merchantToken | 9338d54573688ae18e175240b02... |
callBackUrl | ANS | 255 | Payment Result Url | https://merchant.com/callBackUrl |
Jenius Payment Parameters
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp | N | 14 | API Request Timestamp (YYYYMMDDHH24MISS) | 20210226104459 |
tXid | AN | 30 | Transaction ID | TNICECP04104202102261041533824 |
referenceNo | ANS | 40 | Merchant Order No | 1234567890123456 |
callBackUrl | ANS | 255 | Payment Result Url | https://merchant.com/callBackUrl |
cashtag | A | 100 | cashtagId (with $) | $johndoe |
merchantToken | AN | 255 | merchantToken | 9338d54573688ae18e175240b02... |
Response Parameters - ClickPay Payment
Sample Response to callbackUrl with parameter
http://merchant.com/callbackUrl?resultCd=0000&resultMsg=SUCCESS&tXid=TESTIMIDTEST01201803020917502088&referenceNo=ORD12345&payMethod=04&amt=10000&transDt=20180302&transTm=151052&description=Transaction Description&receiptCode=0684G143372548&mitraCd=MDRC¤cy=IDR&goodsNm=Test Transaction Nicepay&billingNm=Customer Name&mRefNo=2017514268567
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transaction ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transaction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
mitraCd | A | 4 | Mitra Code |
receiptCode | ANS | 20 | Authrization Number |
mRefNo | AN | 18 | Bank Reference No |
E-Wallet
NICEPay offers E-Wallet as Payment Method. This allows customer to make payment with OVO, LinkAja, DANA and Shopeepay (Jump App).
Real time Notification will be sent when customer has completed the payment.
Supported E-Wallet:
- OVO
- Link Aja
- DANA
- Shopeepay
Integration Step :
- Merchant Request Registration
- Merchant Request Payment
- NICEPay will Redirect to Mitra Payment Page/App or Send Notification to App
- Customer Make Payment on Mitra Payment Page/App
- NICEPay Send Notification to Merchant
- Merchant Handle Notification
Registration - E-Wallet
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - E-Wallet Registration
Sample JSON Request
{
"timeStamp":"20210315112359",
"iMid":"IONPAYTEST",
"payMethod":"05",
"currency":"IDR",
"amt":"1000",
"referenceNo":"ORD54321",
"goodsNm":"Test Transaction Nicepay",
"billingNm":"John Doe",
"billingPhone":"08123456789",
"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":"a45e163042746131307bad89ef6cc0c517c136895a6cfe6cb77c4a62ce1ee5b3",
"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\":[{\"img_url\":\"http:\/\/www.jamgora.com\/media\/avatar\/noimage.png\",\"goods_name\":\"Hoodie\",\"goods_detail\":\"Hoodie\",\"goods_amt\":\"1000\"}]}",
"mitraCd":"OVOE"
}
Parameters | Type | Size | Description | Value |
---|---|---|---|---|
payMethod | N | 2 | E-Wallet | 05 |
mitraCd | A | 4 | Mitra Code | OVOE |
userIP | ANS | 15 | Customer IP | 127.0.0.1 |
cartData | JSON String | 4000 | Cart Data | JSON |
E-Wallet Cart Data
Parameter | Description |
---|---|
count | Total cart data count |
item | |
item -> img_url | Good's image URL (50x50 size) |
item -> goods_name | Good's name |
item -> goods_detail | Good's description |
item -> goods_amt | Good's amount |
item -> goods_quantity | Good's Quantity (Add for LinkAja, DANA, Shopeepay) |
{
"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" //Add for LinkAja, DANA, Shopeepay
},
{
"img_url": "http://img.aaa.com/ima2.jpg",
"goods_name": "Item 2 Name",
"goods_detail": "Item 2 Detail",
"goods_amt": "300",
"goods_quantity": "1" //Add for LinkAja, DANA, Shopeepay
}
]
}
Response Parameters - E-Wallet Registration
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST05202103151123583200",
"referenceNo": "ORD54321",
"payMethod": "05",
"amt": "1000",
"transDt": "20210315",
"transTm": "112358",
"description": "",
"bankCd": null,
"vacctNo": null,
"mitraCd": "OVOE",
"payNo": null,
"currency": "IDR",
"goodsNm": "Test Transaction Nicepay",
"billingNm": "John Doe",
"vacctValidDt": null,
"vacctValidTm": null,
"payValidDt": null,
"payValidTm": null,
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transactionn ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
bankCd | A | 4 | Bank Code |
vacctNo | N | 20 | VA Number |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) |
payNo | N | 12 | Payment Number |
mitraCd | AN | 4 | Mitra Code |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) |
payValidTm | N | 6 | Expiry Time (HH24MISS) |
requestURL | ANS | 360 | Request URL |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
qrContent | ANS | 360 | QR String in Plain Text |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes |
Payment - E-Wallet
API url | /nicepay/direct/v2/payment |
Request Method application/x-www-form-urlencoded | Popup , Redirect , Submit |
Description | Performs Payment Request to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Sample POST Parameter Request
callBackUrl=http://localhost/ci_nicepay_v2/CallPaymentEW?tXid=IONPAYTEST05201908141607307963&timeStamp=20180123095456&amt=100000&merchantToken=1f90b3f4fbfc7476a800cf2c108509be3cf193f4678dc91e9a69c3b941d97ccc
E-Wallet Payment Parameters
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20170708123456 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST02201607291027025291 |
merchantToken Required | AN | 255 | merchantToken | 9338d54573688ae18e175240b02... |
callBackUrl Required | AN | 255 | Result Page | https://merchant.com/callBackUrl |
returnJsonFormat Optional For Shopeepay to get URL redirect Shopeepay | AN | 100 | Return Json format | 1: return redirect_Url_App and redirect_Url_Http or empty/0: return HTML to redirect |
Response Parameters - E-Wallet Payment
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transaction ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transaction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
mitraCd | A | 4 | Mitra Code |
AstraPay Registrasi - E-Wallet
API url | /nicepay/api/linkEnable.do |
Request Method application/x-www-form-urlencoded | Popup , Redirect , Submit |
Description | Connecting account to NICEPay |
Merchant Token | SHA256(iMid +referenceNo +billingPhone +merchantKey ) |
E-Wallet AstraPay Parameters
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
payMethod Required | A | 2 | Payment Method | 05 |
mitraCd Required | AN | 255 | Mitra Code | ASTR : AstraPay |
merchantToken Required | AN | 255 | Merchant Token | 97a8a4fc10846093a0dc5c73c7a31b01ffbfa3b5de9368a1c88571c3c9590512 |
referenceNo Required | AN | 255 | Order Number Merchant | MerchantReferenceNumber001 |
billingPhone Required | A | 12 | Buyer Phone Number | 081234567891 |
returnJsonFormat Required | AN | 100 | Return Json format | Null : Default “2” 1 : Merchant hit link redirect astrapay 2 : NICEPay hit link redirect astrapay |
dbProcessUrl Required | AN | 255 | Notification URL | https://merchant.com/dbProcessUrl |
callBackUrl Required | AN | 255 | Payment Result Forward URL | https://merchant.com/callBackUrl |
Response Parameters - E-Wallet Registrasi AstraPay
Response Parameters - Registrasition E-Wallet
Contoh Response JSON
{
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST05202210171347370616",
"referenceNo": "ncpy20221017134738",
"payMethod": "05",
"amt": null,
"transDt": "20221017",
"transTm": "134738",
"mitraCd": "ASTR",
"paymentExpDt": null,
"paymentExpTm": null,
"redirectUrlHttp": "https://sandbox.astrapay.com/merchant-service/link?clientId=1baf55ad-2130-4d46-bf48-91b0b01004a1&merchantUserId=2210174a6a4d69a12dc956",
"redirectUrlApp": null,
"redirectToken": null
}
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transaction ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transaction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
mitraCd | A | 4 | Mitra Code |
redirectUrlHttp | ANS | 255 | Redirect to MitraPage |
AstraPay Payment - E-Wallet
API url | /nicepay/api/linkInitiate.do |
Request Method application/x-www-form-urlencoded | Popup , Redirect , Submit |
Description | Pembayaran melalui AstraPay |
Merchant Token | SHA256(iMid +referenceNo +amt +merchantKey ) |
E-Wallet AstraPay Parameters
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
payMethod Required | A | 2 | Payment Method | 05 |
mitraCd Required | AN | 255 | Mitra Code | ASTR : AstraPay |
merchantToken Required | AN | 255 | Merchant Token | 97a8a4fc10846093a0dc5c73c7a31b01ffbfa3b5de9368a1c88571c3c9590512 |
referenceNo Required | AN | 255 | Order Number Merchant | MerchantReferenceNumber001 |
billingPhone Required | A | 12 | Buyer Phone Number | 081234567891 |
returnJsonFormat Required | AN | 100 | Return Json format | Null : Default “2” 1 : Merchant hit link redirect astrapay 2 : NICEPay hit link redirect astrapay |
dbProcessUrl Required | AN | 255 | Notification URL | https://merchant.com/dbProcessUrl |
callBackUrl Required | AN | 255 | Payment Result Forward URL | https://merchant.com/callBackUrl |
timeStamp Required | AN | 255 | API Request Date | 20221017134738 |
mandateID Required | AN | 255 | Mandate ID | IONPAYTEST123412345 |
cartData Required | JSON-STRING | 4000 | JSON FORMAT | Cart Data |
E-Wallet Cart Data
Parameter | Deskripsi |
---|---|
count | Total jenis item di dalam cart |
item | |
item -> img_url | URL untuk Gambar barang (50x50) |
item -> goods_name | Nama Barang |
item -> goods_detail | Deskripsi Barang |
item -> goods_amt | Harga Barang |
item -> goods_quantity | Jumlah Barang (Add for LinkAja, DANA, Shopeepay) |
{
"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" //Add for LinkAja, DANA, Shopeepay
},
{
"img_url": "http://img.aaa.com/ima2.jpg",
"goods_name": "Item 2 Name",
"goods_detail": "Item 2 Detail",
"goods_amt": "300",
"goods_quantity": "1" //Add for LinkAja, DANA, Shopeepay
}
]
}
Response Parameters - E-Wallet Registrasi AstraPay
Response Parameters - Registrasi E-Wallet
Contoh Response JSON
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST05202210171614560733",
"mandateID": "IONPAYTEST081214714045",
"referenceNo": "ncpy20221017161458",
"payMethod": "05",
"amt": "2000",
"transDt": "20221017",
"transTm": "161458",
"mitraCd": "ASTR",
"redirectUrlHttp": "https://sandbox.astrapay.com/merchant-service/payments/90e10eb0-c508-47d5-9663-91c3d37a98da"
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transaction ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transaction Time (HH24MISS) |
mitraCd | A | 4 | Mitra Code |
redirectUrlHttp | ANS | 255 | Redirect to MitraPage |
mandateID | ANS | 255 | Mandate ID |
Payloan
NICEPay offers Pay Loan (Cardless Credit) as a Payment Method.
Notification will be sent real-time when customer has completed the payment.
Supported Payloan:
- Akulaku
- Kredivo
- Indodana
Integration Step :
- Merchant Request Registration
- Merchant Request Payment
- NICEPay will Redirect to Pay Loan Payment Page
- Customer Confirms Payment on Mitra Page
- NICEPay Send Notification
- Handle Notification
- Merchant Confirms Transaction (AKULAKU Only)
Registration - Payloan
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - Payloan Registration
Sample JSON Request
{
"timeStamp": "20210312175959",
"iMid": "PAYLOANTES",
"payMethod": "06",
"currency": "IDR",
"amt": "12000",
"referenceNo": "ord20200910170911",
"goodsNm": "Test Transaction Nicepay",
"billingNm": "John Doe",
"billingPhone": "08123456789",
"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":"e7cb9d64f23df1e5f9ceb1f634ccd63cea8994b57bad2c540f38194955bdb2f8",
"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\":3,\"item\":[{\"goods_id\":30,\"goods_name\":\"Beanie\",\"goods_type\":\"Accessories\",\"goods_amt\":5500,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.com/product/beanie/\"},{\"goods_id\":31,\"goods_name\":\"Belt\",\"goods_type\":\"Accessories\",\"goods_amt\":6000,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.store/product/belt/\"},{\"img_url\":\"http://www.jamgora.com/media/avatar/noimage.png\",\"goods_name\":\"Shipping Fee\",\"goods_id\":\"Shipping for Ref. No. 278\",\"goods_detail\":\"Flat rate\",\"goods_type\":\"Shipping with Flat rate\",\"goods_amt\":\"500\",\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":\"1\",\"goods_url\":\"https://wwww.nicestore.store\"}]}",
"sellers": "[{\"sellersId\":\"NICEPAY-NamaMerchant\",\"sellersNm\":\"NICEPAYSHOP\",\"sellersUrl\":\"http://nicestore.store/product/beanie/\",\"sellersEmail\":\"[email protected]\",\"sellersAddress\":{\"sellerNm\":\"NICEPAYSHOP\",\"sellerLastNm\":\"NICEPAYSHOP\",\"sellerAddr\":\"Jln. Kasablanka Kav 88\",\"sellerCity\":\"Jakarta\",\"sellerPostCd\":\"14350\",\"sellerPhone\":\"082111111111\",\"sellerCountry\":\"ID\"}}]",
"instmntType": "2",
"instmntMon": "1",
"recurrOpt": "0",
"bankCd": "",
"vacctValidDt": "",
"vacctValidTm": "",
"merFixAcctId": "",
"payValidDt": "",
"payValidTm": "",
"mitraCd": "KDVI"
}
Parameters | Type | Size | Description | Example |
---|---|---|---|---|
payMethod Required | N | 2 | Pay Loan | 06 |
userIp Required | ANS | 15 | Buyer's IP Address | 127.0.0.1 |
deliveryNm Required | A | 30 | Delivery Name | John Doe |
deliveryPhone Required | N | 15 | Delivery Phone | 08211xxxx |
deliveryAddr Required | AN | 100 | Delviery Address | Jln. Merdeka |
deliveryCity Required | A | 50 | Delivery City | Jakarta Pusat |
deliveryState Required | A | 50 | Delivery State | DKI Jakarta |
deliveryPostCd Required | N | 10 | Delivery Post Code | 14350 |
deliveryCountry Required | A | 10 | Delivery Country | Indonesia |
instmntType Required | N | 2 | Installment Type | 1 |
instmntMon Required | N | 2 | Installment Month | 1 |
mitraCd Required | A | 4 | Mitra Code | KDVI |
cartData Required | JSON String | 4000 | Cart Data | JSON |
sellers Required | JSON String | 4000 | Sellers Data | JSON |
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 - Payloan Registration
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "PAYLOANTES06202103230759131541",
"referenceNo": "ord20200910170911",
"payMethod": "06",
"amt": "12000",
"transDt": "",
"transTm": "",
"description": null,
"bankCd": null,
"vacctNo": null,
"mitraCd": "KDVI",
"payNo": null,
"currency": null,
"goodsNm": null,
"billingNm": null,
"vacctValidDt": null,
"vacctValidTm": null,
"payValidDt": "",
"payValidTm": null,
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transaction ID |
referenceNo | ANS | 40 | Reference No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transaction Time (HH24MISS) |
description | AN | 100 | Description |
mitraCd | A | 4 | Mitra Code |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) |
payValidTm | N | 6 | Expiry Time (HH24MISS) |
requestURL | ANS | 360 | Request URL |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
qrContent | ANS | 360 | QR String in Plain Text |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes |
Payment - Payloan
API url | /nicepay/direct/v2/payment |
Request Method application/x-www-form-urlencoded | Popup , Redirect , Submit |
Description | Performs Payment Request to NICEPAY |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Payloan Payment Parameters
Sample POST Parameter Request
callBackUrl=http://ptsv2.com/t/0ftrz-1519971382/post&tXid=PAYLOANTES06202010221238593706&timeStamp=20200910170911&amt=208000&merchantToken=d27544e13fd9937be9fc5d99ba39a75344b0e6dd1c6c358c9858a94606a74c4e
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20170708123456 |
tXid Required | AN | 30 | Transaction ID | PAYLOANTES06202010221238593706 |
merchantToken Required | AN | 255 | merchantToken | 9338d54573688ae18e175240b02... |
callBackUrl Required | ANS | 255 | Result Page | https://merchant.com/callBackUrl |
Response Parameters - Payloan Payment
Sample Redirect with parameter
https://dev.nicepay.co.id/nicepay/direct/v2/payment?tXid=PAYLOANTES06202010221238593706&timeStamp=20200910170911&callBackUrl=https://ptsv2.com/t/5yzim-1565926086/post&merchantToken=d27544e13fd9937be9fc5d99ba39a75344b0e6dd1c6c358c9858a94606a74c4e&referenceNo=ord20200910170911&amt=208000
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transaction ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transaction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
mitraCd | A | 4 | Mitra Code |
instmntMon | N | 2 | Installment Month |
instmntType | N | 2 | Installment Type |
Confirm Receipt - Akulaku Only
API url | /nicepay/api/direct/v2/confirmAkulaku |
Request Method JSON | POST |
Description | Performs Receipt Confirmation for Fund Settlement. |
Merchant Token | SHA256(timeStamp +tXid +iMid +merchantKey ) |
AkuLaku Confirm Receipt Parameters
Parameter | Type | Size | Description | Example |
---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20170708123456 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST02201607291027025291 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
merchantToken Required | ANS | 255 | Merchant Token | 6cfccfc0046773c1b589d8e98f8... |
Response Parameters - AkuLaku Confirm Receipt
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
ResponseData | AN | 30 | null |
QRIS
NICEPay provides a new service in QRIS payment method from cooperation with ShopeePay. By using this method, the customer will have the option to make payment via E-wallet (ShopeePay, OVO, Gopay, and DANA). Realtime Notification will be sent when the customer has completed the payment.
Transaction Flow :
- Merchant Request QRIS Registration to NICEPay.
- Merchant Display QR Code and How-To-Pay to Customer.
- Customer will scan QR, and do authentication for payment.
- Nicepay will check the payment status, then Nicepay send Notification.
- Merchant Handle Notification
Registration - QRIS
API url | /nicepay/direct/v2/registration |
Request Method application/json | POST |
Description | QRIS payment API |
Merchant Token | SHA256(timeStamp +iMid +referenceNo +amt +merchantKey ) |
Request Parameters - QRIS Registration
Sample JSON Request
{
"timeStamp": "20180123100505",
"iMid": "IONPAYTEST",
"payMethod": "08",
"currency": "IDR",
"amt": "5",
"referenceNo": "ORD54321",
"goodsNm": "Test Transaction Nicepay",
"billingNm": "John Doe",
"billingPhone": "081294529025",
"billingEmail": "[email protected]",
"billingCity": "Jakarta",
"billingState": "DKI Jakarta",
"billingPostCd": "12345",
"billingCountry":"Indonesia",
"dbProcessUrl": "https://merchant.com/api/dbProcessUrl/Notif",
"merchantToken": "14b2d810fd2c2725bde0e747392bdd6353b5dcfd3807ccc7a0b5106bdd4af099",
"paymentExpDt" : "",
"paymentExpTm" : "",
"userIP":"127.0.0.1",
"cartData":"{}",
"mitraCd":"QSHP",
"shopId": "NICEPAY"
}
QRIS Registration Additional Parameters
Parameters | Type | Size | Description | Value |
---|---|---|---|---|
mitraCd Required | A | 4 | Mitra Code | QSHP |
shopId Required | AN | 32 | Shop Id | NICEPAY |
paymentExpDt | N | 6 | QR Expiry | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Expiry | QR Payment Expiry Time (HH24MISS) |
Response Parameters - QRIS Registration
Sample JSON Response
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "IONPAYTEST08202009232134539218",
"referenceNo": "ORD54321",
"payMethod": "08",
"amt": "5",
"transDt": "20200923",
"transTm": "213454",
"description": null,
"bankCd": null,
"vacctNo": null,
"mitraCd": "QSHP",
"payNo": null,
"currency": "IDR",
"goodsNm": "Test Transaction Nicepay",
"billingNm": "John Doe",
"vacctValidDt": null,
"vacctValidTm": null,
"payValidDt": null,
"payValidTm": null,
"requestURL": null,
"paymentExpDt": "20200923",
"paymentExpTm": "213953",
"qrContent": "00020101021226590016ID.CO.SHOPEE.WWW011893600918000041566602064156660303UME52045399530336054045.005802ID5913NICEPAY dummy6015KOTA JAKARTA SE61051287062360520082020092321345398890708T0000001630430F1",
"qrUrl": "https://api.wallet.airpay.co.id/v3/merchant-host/qr/download?qr=wnWp74RHftl3pEyGdA1ATYpJcJmBdTbOJeXej6fA79"
}
Parameter | Type | Size | Description |
---|---|---|---|
resultCd | N | 4 | Result Code |
resultMsg | AN | 255 | Result Message |
tXid | AN | 30 | Transactionn ID |
referenceNo | ANS | 40 | Merchant Ref. No |
payMethod | N | 2 | Payment Method |
amt | N | 12 | Payment Amount |
transDt | N | 8 | Transaction Date (YYYYMMDD) |
transTm | N | 6 | Transction Time (HH24MISS) |
description | AN | 100 | Transaction Description |
bankCd | A | 4 | Bank Code |
vacctNo | N | 20 | VA Number |
currency | A | 3 | Currency |
goodsNm | AN | 100 | Goods Name |
billingNm | A | 30 | Buyer Name |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) |
payNo | N | 12 | Payment Number |
mitraCd | AN | 4 | Mitra Code |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) |
payValidTm | N | 6 | Expiry Time (HH24MISS) |
requestURL | ANS | 360 | Request URL |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
qrContent | ANS | 360 | QR String in Plain Text |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes |
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 Deposit1 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 type1 Normal2 Recurring3 Pre-auth4 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. |
Live Integration Checklist
⬜️ Implement Inquiry status after getting callback.
⬜️ Implement Inquiry status after getting notification in dbProcessUrl
.
⬜️ Review payment log.
⬜️ Review firewall settings (eg. claudflare for dbprocessUrl
settings).
⬜️ Implement merchantToken
check.
⬜️ Run Test Scenario in Development Env.
⬜️ Run Test Scenario in Production Env.
⬜️ Review Error Handling (Timeout, Failed, Negative Case).
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
- Update Guide Flow V1 Prof & CC Ent
- Update Guide Flow CC V2 Prof & Ent
2.70
23 Maret 2022
- New Page for API V2 Professional
- Fix : Remove mitraCd sample POST for Notification
- Fix : Remove Scroll bar in Page API V1 Professional and Enterprise
2.69
15 Maret 2022
- Add GPN payment method (09)
2.68
21 Januari 2022
- Update sample response Credit Card to callBackurl with parameter on V2 direct
2.67
20 Januari 2022
- add bank code BNC
- add parameter sellersUrl
- add flow ShopeePay and flow Indodana v2 direct
2.66
7 April 2021
- Add response parameter cancelReferenceNo Optional For CC, on V2 Cancel
- Fix: Parameter returnJsonFormat Optional For Shopeepay to get URL redirect Shopeepay
- Fix: Sample JSON Request and Response for QRIS Registration, on V1 direct
2.65
30 Maret 2021
- Add Request Parameters Required For Indodana, on V2 direct
- Add Indodana Mitra Code
- Fix: Sample JSON Request and Response for Payloan Registration, on V2 direct
- Fix: E-Wallet Status Code
2.64
19 Maret 2021
- Add Request Parameters Required For E-Wallet Shopeepay, on V1
- Add Request Parameters Required For E-Wallet Shopeepay, on V2 direct
- Fix: Sample JSON Request and Response for E-Wallet Registration, on V2 direct
2.63
10 Maret 2021
- Add Request Parameters Required For Jenius Pay, on V1
- Add Jenius option on payment page, on V1 Professional
2.62
3 Maret 2021
- Add Request Parameters Required For Jenius Pay, on V2
- Add Jenius Pay Mitra Code
- Fix: Sample JSON Request and Response for ClickPay Registration, on V2
2.61
2 December 2020
- Fix typo on payloan data V2.
- Fix: Request and Response type on Ewallet V1 Enterprise, from JSON to POST Parameter.
- Fix typo on ewallet data V2
2.60
5 November 2020
- Fix Permata Syariah Bank Code
- Add E-Wallet Status Code
- Add Payloan Status Code
- Fix QRIS Status Code
- Add Payment Response/Callback Parameter to V1 Professional
2.57
26 October 2020
- Fix Sample POST Parameter Request for Payloan
- Fix Request Method for Payloan
2.56
7 October 2020
- Add QRIS Documentation
- Update response parameter Registration
- Add parameter required for QRIS
2.55
18 September 2020
- Added Permata Syariah as Supported Bank
- Added ShopeePay as Supported Mitra
- Added DANA as Supported Mitra
- Added Details: LinkAja does not support special characters on cartData
- Update Sample Payload for V2 APIs
- Changed wording JSON OBJECT to JSON STRING for cartData
- Update New Parameters for API V2 Register for QRIS
- Fix API URL for Akulaku Confirm Receipt
- Fix wrong VA API V2 Diagram Flow
- Fix Details: API V2 Payment callBack does not use String Query but POST Parameter
2.51
4 June 2020
- Fix userAgent Requirement for CC
- Fix Seller and cartData for E-Wallet
- Remove Unused JSON Button
2.50
4 June 2020
- Online Docs UI and UX Update
- Update E-Wallet Documentation
- Update Payloan Documentation
- Minor Fixes on Parameter Length and Type
- Add Git Link for Plugins and Libraries
- Update New POSTMAN Collection
2.15
17 May 2018
- Update card error code
2.13
14 May 2018
- Add parameter payment API timeStamp, merchantToken
2.12
18 April 2018
- Update Error Code
2.07
01 February 2018
- Add parameter CardHolderNm on Payment API
2.06
01 january 2018
- Add parameter fee on Payment, Notification, and Inquiry
2.05
15 December 2017
- Update Error Code
2.04
14 November 2017
- Change url from WWW to API
2.03
10 October 2017
- Add parameter cardExpYymm on Payment, Notification, and Inquiry API
2.02
10 July 2017
- Update Registration API
- Update Notification API
- Update Inquiry API
- Update Credit Card Installation information API
2.01
10 July 2017
- Add parameter Timestamp
2.00
06 July 2017
- Initial Release API Version 2
1.18.9
18 April 2018
- Update Error Code
1.18.5
1 February 2018
- Add parameter cardHolderNm on Payment API
1.17.2
29 Mar 2017
- Add ClickPay Payment
1.17.1
24 Mar 2017
- Add card installment API
- Add notification parameter