V1 Professional

23min

❕ This  contains reference of previous   Version.  recommend  to use  newest .
﻿
NICEPAY Professional
﻿
﻿ Professional Steps:
The  registers  .
﻿ redirects   to  Secure  Page.
Finish   in  Secure  Page.
﻿ will redirect   to  callbackUrl to give   . 
Guide Flow v1 Professional
﻿
Steps Description:
The  sends a  request.
The  sends Card Data to   to create an .
﻿ sends  card data to .
﻿ will make  Page and tXid.
﻿ sends   Page and tXid to  .
The  receives   Page and tXid and then save tXid into  database.
The  will redirect to   Page.
The  visits   Page and inputs   detail.
﻿ sends  detail to .
The  sends  result.
﻿ receives  result.
The  will view   Result Page.
﻿ sends a  to .
The  receives   and checks   .
﻿ receives and sends   response to  .
The  receives  response  from .
The  updates   into database.
The  sends  confirmation to  .
﻿
Transaction Registration
﻿
Registration API Specifications
API End Point
/nicepay/api/orderRegist.do
Request Method 
﻿application﻿/x-www-form-urlencoded﻿
﻿POST﻿
Description
Perform Transaction Registration
Merchant Token
SHA256 (iMid+referenceNo+amt+merchantKey)
Payment Methods
01 ﻿
02 ﻿
03 ﻿
04 ﻿
05 ﻿
08 ﻿
09  Card
﻿
Registration API Parameters
Sample API Request
Sample API Response
// Payment Mandatory Field
nicePay.setPayMethod("01");
nicePay.setCurrency("IDR");
nicePay.setAmt("1000");
nicePay.setInstmntMon("1");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setGoodsNm("Merchant Goods 1");
nicePay.setBillingNm("John Doe");
nicePay.setBillingEmail("[email protected]");
nicePay.setBillingPhone("081234567890");
nicePay.setBillingAddr("Billing Address");
nicePay.setBillingCity("Jakarta");
nicePay.setBillingState("Jakarta");
nicePay.setBillingPostCd("12345");
nicePay.setBillingCountry("Indonesia");
nicePay.setDeliveryNm("John Doe Delivery");
nicePay.setDeliveryPhone("081234567890");
nicePay.setDeliveryAddr("Billing Address ");
nicePay.setDeliveryCity("Jakarta");
nicePay.setDeliveryState("Jakarta");
nicePay.setDeliveryPostCd("12345");
nicePay.setDeliveryCountry("Indonesia");
nicePay.setCallBackUrl("https://merchant.com/api/callBackUrl");
nicePay.setDbProcessUrl("https://merchant.com/api/dbProcessUrl/Notif");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("Description");
nicePay.setUserIP("127.0.0.1");
nicePay.shopId("NICEPAY");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");
nicePay.setInstmntMon("1");
nicePay.setInstmntType("1");
nicePay.setReccurOpt("0");

// Payment Optional Field
nicePay.setReqDt("20160301");
nicePay.setReqTm("135959");
nicePay.setReqDomain("www.merchant.com");
nicePay.setReqServerIP("127.0.0.1");
nicePay.setReqClientVer("1.0");
nicePay.setUserSessionID("userSessionID");
nicePay.setUserAgent("Mozilla");
nicePay.setUserLanguage("en-US");
nicePay.setMerFixAcctId("9999000000000001");
nicePay.setVacctValidDt("20160303");
nicePay.setVacctValidTm("135959");
nicePay.setPaymentExpiryDt("20160303");
nicePay.setPaymentExpiryTm("135959");

// Payment Request
nicePay.payPage();

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String tXid= nicePay.Get("tXid");
String requestURL= nicePay.Get("requestURL");
// Payment Mandatory Field
nicePay.setPayMethod("01");
nicePay.setCurrency("IDR");
nicePay.setAmt("1000");
nicePay.setInstmntMon("1");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setGoodsNm("Merchant Goods 1");
nicePay.setBillingNm("John Doe");
nicePay.setBillingEmail("buyer@merchant.com");
nicePay.setBillingPhone("081234567890");
nicePay.setBillingAddr("Billing Address");
nicePay.setBillingCity("Jakarta");
nicePay.setBillingState("Jakarta");
nicePay.setBillingPostCd("12345");
nicePay.setBillingCountry("Indonesia");
nicePay.setDeliveryNm("John Doe Delivery");
nicePay.setDeliveryPhone("081234567890");
nicePay.setDeliveryAddr("Billing Address ");
nicePay.setDeliveryCity("Jakarta");
nicePay.setDeliveryState("Jakarta");
nicePay.setDeliveryPostCd("12345");
nicePay.setDeliveryCountry("Indonesia");
nicePay.setCallBackUrl("https://merchant.com/api/callBackUrl");
nicePay.setDbProcessUrl("https://merchant.com/api/dbProcessUrl/Notif");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("Description");
nicePay.setUserIP("127.0.0.1");
nicePay.shopId("NICEPAY");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");
nicePay.setInstmntMon("1");
nicePay.setInstmntType("1");
nicePay.setReccurOpt("0");

// Payment Optional Field
nicePay.setReqDt("20160301");
nicePay.setReqTm("135959");
nicePay.setReqDomain("www.merchant.com");
nicePay.setReqServerIP("127.0.0.1");
nicePay.setReqClientVer("1.0");
nicePay.setUserSessionID("userSessionID");
nicePay.setUserAgent("Mozilla");
nicePay.setUserLanguage("en-US");
nicePay.setMerFixAcctId("9999000000000001");
nicePay.setVacctValidDt("20160303");
nicePay.setVacctValidTm("135959");
nicePay.setPaymentExpiryDt("20160303");
nicePay.setPaymentExpiryTm("135959");

// Payment Request
nicePay.payPage();

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String tXid= nicePay.Get("tXid");
String requestURL= nicePay.Get("requestURL");
﻿
Parameter
Type
Size
Description
Example Value
iMid
﻿Required﻿
AN
10
﻿ ID
IONPAYTEST
merchantToken
﻿Required﻿
AN
255
﻿ Token
6cfccfc0046773c1b589d8e98f...
payMethod
﻿Required﻿
N
2
﻿Payment Method﻿
01
currency
﻿Required﻿
A
3
Currency
IDR
amt
﻿Required﻿
N
12
Transaction Amount
10000
cartData
﻿Required﻿
JSON String
4000
Transaction Cart Data
﻿cartData 
﻿
JSON
referenceNo
﻿Required﻿
ANS
40
﻿ Order Number
MerchantReferenceNumber1
goodsNm
﻿Required﻿
AN
100
Goods Name
﻿ Goods 1
callBackUrl
﻿Required﻿
ANS
255
﻿ Result Page URL
https://merchant.com/callBackUrl
dbProcessUrl
﻿Required﻿
ANS
255
Push Notification URL
https://merchant.com/dbProcessUrl
userIP
﻿Required﻿
AN
15
User IP address
127.0.0.1
description
﻿Required﻿
AN
100
Transaction Description
this is test order
billingNm
﻿Required﻿
A
30
Billing Name
Buyer Name
billingPhone
﻿Required﻿
N
15
Billing Phone Number
2123456789
billingEmail
﻿Required﻿
ANS
40
Billing E-mail
[email protected]
billingCity
﻿Required﻿
A
50
Billing City
Jakarta Utara
billingState
﻿Required﻿
A
50
Billing State
DKI Jakarta
billingPostCd
﻿Required﻿
A
10
Billing Postcode
10160
billingCountry
﻿Required﻿
A
10
Billing Country
﻿﻿
billingAddr
AN
100
Billing Address
Billing Address
merFixAcctId
﻿Required for Fix-Type VA﻿
N
40
﻿ Fix VA Number
14015824
instmntType
﻿Required for CC﻿
N
2
﻿Installment Type﻿
1
instmntMon
﻿Required for CC﻿
N
2
Installment Month
1
deliveryNm
A
30
Delivery Name
Delivery Name
deliveryPhone
N
15
Delivery Phone Number
2123456789
deliveryAddr
AN
100
Delivery Address
Delivery Address
deliveryCity
A
50
Delivery City
Jakarta Utara
deliveryState
A
50
Delivery State
DKI Jakarta
deliveryPostCd
N
10
Delivery Postcode
10160
deliveryCountry
A
10
Delivery Country
﻿﻿
vat
N
12
Vat Number
0
fee
N
12
Service Fee
0
notaxAmt
N
12
Tax Free Amount
0
reqDt
N
8
Request Date
20180303
reqTm
N
6
Request Time
135959
reqDomain
ANS
100
Request Domain
merchant.com
reqServerIP
ANS
15
Request Server IP Address
127.0.0.1
reqClientVer
AN
50
Request Client Version
1
userSessionID
AN
100
User Session ID
userSessionID
userAgent
﻿Required for CC﻿
ANS
100
User Agent Information
Mozilla
userLanguage
ANS
2
User Language
en-US
worker
AN
10
Worker
worker
vacctValidDt
N
8
﻿ Valid Date (YYYYMMDD)
20180404
vacctValidTm
N
6
﻿ Valid Time (HH24MISS)
235959
paymentExpDt
N
8
﻿ Expired Date (YYYYMMDD)
20180404
paymentExpTm
N
6
﻿ Expired Time (HH24MISS)
235959
payValidDt
N
8
CVS Valid Date (YYYYMMDD)
20180404
payValidTm
N
6
CVS Valid Time (HH24MISS)
235959
mRefNo
N
18
﻿ Reference Number
bankcd123456789
timeStamp
N
14
Timestamp (YYYYMMDDHH24MISS)
20180404165639
mitraCd
A
4
﻿Mitra Code﻿
ESHP
version
AN
﻿
Version
﻿ Lite
shopId
﻿Required for QRIS﻿
AN
32
Shop ID
﻿﻿
Note for Jenius
﻿ use iMid: TNICECP041 and payMethod: 04 then request to Staging for developmental purposes.
Cart Data API V1
JSON
{
    "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"
        }  
        ] 
} 
{
    "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"
        }  
        ] 
} 
﻿
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
After   registers successfully, don't forget to redirect your Client to   .
﻿
NICEPAY Secure Payment Page
﻿
Payment Page
﻿
﻿
Payment Method Selection
Payment Method Selection Page
﻿
When   click  Change , they can see   above and change their preferred .
Note for ShopeePay :
In order to better user experience to  , please request give a warning message to   so they will open their mobile device.
﻿
Payment Method QRIS Option
QRIS Payment Option
﻿
Confirm   after   open   application and scan  QR code. Then click Process.  will redirect end-user to  callbackUrl to give   .
QRIS Payment Process
﻿
﻿
Payment Method Jenius Option
QRIS Payment - Jenius
﻿
After   choose Jenius and click Process , then input Cashtag ID. After that confirmation,  can be done via Jenius application.
﻿
Transaction Payment
﻿
Payment API Specifications
API Endpoint
/nicepay/api/orderInquiry.do
Request Method application﻿/x-www-form-urlencoded﻿
﻿POST﻿
Description
URL Redirect to   Page
﻿
Payment Parameters
URL
﻿﻿https://www.nicepay.co.id/nicepay/api/orderInquiry.do?tXid=IONPAYTEST01201608291733081257&optDisplayCB=0&optDisplayBL=0﻿﻿
Sample API Request
if (nicePay.Get("resultCd").equals("0000")) {   
    String site = nicePay.Get("requestURL") + "&optDisplayCB=0" + "&optDisplayBL=0"; 
             response.setStatus(response.SC_MOVED_TEMPORARILY);   
             response.setHeader("Location", site);   
         } 
if (nicePay.Get("resultCd").equals("0000")) {   
    String site = nicePay.Get("requestURL") + "&optDisplayCB=0" + "&optDisplayBL=0"; 
             response.setStatus(response.SC_MOVED_TEMPORARILY);   
             response.setHeader("Location", site);   
         } 
﻿
Parameter
Type
Size
Description
Example Value
tXid
﻿Required﻿
AN
30
Transaction ID
IONPAYTEST02201607291027025291
optDisplayCB
N
2
Display change ﻿
show = 0 hide = 1
optDisplayBL
N
2
Display Back Link
show = 0 hide = 1
To prevent your Client changing  , set optDisplayCB = 1.
﻿
Payment Response Parameters
Sample Response to callbackUrl with parameter
https://merchant.com/result?resultCd=0000&resultMsg=SUCCESS&bankVacctNo=44779000090927472371&tXid=IONPAYTEST02202011050927472371&referenceNo=order%2020201105091192&transDt=20201105&transTm=092747&amount=150000&bankCd=CENA&description=Payment+of+referenceNo+order+20201105091192
https://merchant.com/result?resultCd=0000&resultMsg=SUCCESS&bankVacctNo=44779000090927472371&tXid=IONPAYTEST02202011050927472371&referenceNo=order%2020201105091192&transDt=20201105&transTm=092747&amount=150000&bankCd=CENA&description=Payment+of+referenceNo+order+20201105091192
﻿
Note:
 Response Parameter will be sent through callBackurl using URL String Query.
Parameter
Type
Size
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
﻿Result Message﻿﻿
Success
tXid
AN
30
﻿ Trans ID
IONPAYTEST 02201607291027025291
﻿
When success
referenceNo
ANS
40
﻿ Order No.
OrdNo20160525000
﻿
When success
authNo
N
10
﻿ Auth No.
123456
﻿
When success (CC)
amount
N
12
Amount
1000
﻿
When success
transDt
N
8
Transaction Date
20200303
﻿
When success
transTm
N
6
Transaction Time
135959
﻿
When success
description
AN
100
Transaction Description
{{paym}} of OrdNo20160525000
﻿
When success
bankVacctNo
N
20
﻿ Number
123457891011
﻿
When success (VA)
bankCd
A
4
﻿VA Bank Code﻿﻿
BMRI
﻿
When success (VA)
﻿
Reccuring Token
﻿
When   signs contract as a Recurring ,  give a recurringToken to    response.
API Endpoint
/nicepay/api/recurringToken.do
Request Method application﻿/x-www-form-urlencoded﻿
﻿POST﻿
Description
Request  One Time Use Transaction Token recurringToken.do is almost same onePassToken.do The difference is whether using card info or using recurringToken
Merchant Token
SHA256 (Merchant ID + Reference Number + Amount + Merchant Key)
Request Parameter For Token
Parameter
Type
Size
Description
Remark
amt
N
12
Amount
10000
referenceNo
AN
40
﻿ Order No.
20220623095906
merchantToken
AN
255
﻿ Amount
141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b
iMid
AN
10
﻿ ID
BMRITEST01
recurringToken
AN
100
Recurring Token
d4ef98b26f917a697691807cf737251cc15ef570a01457d15211a4f06e38ae64
instmntType
AN
2
﻿Installment Type﻿﻿
﻿
instmntMon
N
2
Installment Month
1
Response Parameter For Token
Parameter
Type
Size
Description
Remark
resultCd
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
﻿Result Message﻿﻿
SUCCESS
cardToken
AN
64
One time use  token
c954f03ef83a363f94fa26bef6ec4d08fa7693590a735386fcce6e2ef1caae8a
paymentType
AN
1
﻿CC Authorization type﻿﻿
1 : 3Ds
2 : KeyIn
﻿
When Callback to your callbackurl is received, we strongly recommend s to verify  Status by using Inquiry .
﻿

API End Point	/nicepay/api/orderRegist.do
Request Method application/x-www-form-urlencoded	POST
Description	Perform Transaction Registration
Merchant Token	SHA256 (iMid+referenceNo+amt+merchantKey)
Payment Methods	01 02 03 04 05 08 09 Card

Parameter	Type	Size	Description	Example Value
iMid Required	AN	10	ID	IONPAYTEST
merchantToken Required	AN	255	Token	6cfccfc0046773c1b589d8e98f...
payMethod Required	N	2	Payment Method	01
currency Required	A	3	Currency	IDR
amt Required	N	12	Transaction Amount	10000
cartData Required	JSON String	4000	Transaction Cart Data	cartData JSON
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber1
goodsNm Required	AN	100	Goods Name	Goods 1
callBackUrl Required	ANS	255	Result Page URL	https://merchant.com/callBackUrl
dbProcessUrl Required	ANS	255	Push Notification URL	https://merchant.com/dbProcessUrl
userIP Required	AN	15	User IP address	127.0.0.1
description Required	AN	100	Transaction Description	this is test order
billingNm Required	A	30	Billing Name	Buyer Name
billingPhone Required	N	15	Billing Phone Number	2123456789
billingEmail Required	ANS	40	Billing E-mail	[email protected]
billingCity Required	A	50	Billing City	Jakarta Utara
billingState Required	A	50	Billing State	DKI Jakarta
billingPostCd Required	A	10	Billing Postcode	10160
billingCountry Required	A	10	Billing Country
billingAddr	AN	100	Billing Address	Billing Address
merFixAcctId Required for Fix-Type VA	N	40	Fix VA Number	14015824
instmntType Required for CC	N	2	Installment Type	1
instmntMon Required for CC	N	2	Installment Month	1
deliveryNm	A	30	Delivery Name	Delivery Name
deliveryPhone	N	15	Delivery Phone Number	2123456789
deliveryAddr	AN	100	Delivery Address	Delivery Address
deliveryCity	A	50	Delivery City	Jakarta Utara
deliveryState	A	50	Delivery State	DKI Jakarta
deliveryPostCd	N	10	Delivery Postcode	10160
deliveryCountry	A	10	Delivery Country
vat	N	12	Vat Number	0
fee	N	12	Service Fee	0
notaxAmt	N	12	Tax Free Amount	0
reqDt	N	8	Request Date	20180303
reqTm	N	6	Request Time	135959
reqDomain	ANS	100	Request Domain	merchant.com
reqServerIP	ANS	15	Request Server IP Address	127.0.0.1
reqClientVer	AN	50	Request Client Version	1
userSessionID	AN	100	User Session ID	userSessionID
userAgent Required for CC	ANS	100	User Agent Information	Mozilla
userLanguage	ANS	2	User Language	en-US
worker	AN	10	Worker	worker
vacctValidDt	N	8	Valid Date (YYYYMMDD)	20180404
vacctValidTm	N	6	Valid Time (HH24MISS)	235959
paymentExpDt	N	8	Expired Date (YYYYMMDD)	20180404
paymentExpTm	N	6	Expired Time (HH24MISS)	235959
payValidDt	N	8	CVS Valid Date (YYYYMMDD)	20180404
payValidTm	N	6	CVS Valid Time (HH24MISS)	235959
mRefNo	N	18	Reference Number	bankcd123456789
timeStamp	N	14	Timestamp (YYYYMMDDHH24MISS)	20180404165639
mitraCd	A	4	Mitra Code	ESHP
version	AN		Version	Lite
shopId Required for QRIS	AN	32	Shop ID

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

API Endpoint	/nicepay/api/orderInquiry.do
Request Method application/x-www-form-urlencoded	POST
Description	URL Redirect to Page

Parameter	Type	Size	Description	Example Value
tXid Required	AN	30	Transaction ID	IONPAYTEST02201607291027025291
optDisplayCB	N	2	Display change	show = 0 hide = 1
optDisplayBL	N	2	Display Back Link	show = 0 hide = 1

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message	Success
tXid	AN	30	Trans ID	IONPAYTEST 02201607291027025291 When success
referenceNo	ANS	40	Order No.	OrdNo20160525000 When success
authNo	N	10	Auth No.	123456 When success (CC)
amount	N	12	Amount	1000 When success
transDt	N	8	Transaction Date	20200303 When success
transTm	N	6	Transaction Time	135959 When success
description	AN	100	Transaction Description	{{paym}} of OrdNo20160525000 When success
bankVacctNo	N	20	Number	123457891011 When success (VA)
bankCd	A	4	VA Bank Code	BMRI When success (VA)

API Endpoint	/nicepay/api/recurringToken.do
Request Method application/x-www-form-urlencoded	POST
Description	Request One Time Use Transaction Token recurringToken.do is almost same onePassToken.do The difference is whether using card info or using recurringToken
Merchant Token	SHA256 (Merchant ID + Reference Number + Amount + Merchant Key)

Parameter	Type	Size	Description	Remark
amt	N	12	Amount	10000
referenceNo	AN	40	Order No.	20220623095906
merchantToken	AN	255	Amount	141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b
iMid	AN	10	ID	BMRITEST01
recurringToken	AN	100	Recurring Token	d4ef98b26f917a697691807cf737251cc15ef570a01457d15211a4f06e38ae64
instmntType	AN	2	Installment Type
instmntMon	N	2	Installment Month	1

Parameter	Type	Size	Description	Remark
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message	SUCCESS
cardToken	AN	64	One time use token	c954f03ef83a363f94fa26bef6ec4d08fa7693590a735386fcce6e2ef1caae8a
paymentType	AN	1	CC Authorization type 1 : 3Ds 2 : KeyIn

Updated 08 Oct 2024

Did this page help you?

API Version 1 (V1)

V1 Enterprise

V1 Professional

NICEPAY Professional

Guide Flow v1 Professional

Transaction Registration

Registration API Specifications

Registration API Parameters

Cart Data API V1

NICEPAY Secure Payment Page

Payment Method Selection

Payment Method QRIS Option

Payment Method Jenius Option

Transaction Payment

Payment API Specifications

Payment Parameters

Payment Response Parameters

Reccuring Token

Request Parameter For Token

Response Parameter For Token

Welcome to NICEPAY DOCS