Registration - API E-Wallet

13min

About API for E-Wallet Registration 
﻿
Currently,  is working with 5  channels that facilitate  s in   business, namely:
OVO
LinkAja
DANA
ShopeePay
AstraPay
In general,   stages for  OVO, LinkAja, DANA, and ShopeePay are  same. However, there are significant differences in   of  AstraPay. Specifically for AstraPay Registration and Payment, please visit AstraPay Registration - API E-Wallet﻿  and AstraPay Payment - API E-Wallet﻿.
﻿
API for E-Wallet Registration 
﻿

 Registration  uses so that s can connect with      with   . So,    that has been provided and hosted from   side can integrate with   from . The following s can use for  OVO, LinkAja, DANA, and ShopeePay.
API Endpoint
/nicepay/direct/v2/registration
Request Method
﻿POST﻿
Description
Performs Transaction Regist to 
Merchant Token
SHA256(timeStamp+iMid+tXid+amt+merchantKey)
Request Format
application/json
The following s can be implemented for  OVO, LinkAja, DANA and ShopeePay.
﻿ visit AstraPay Registration - API E-Wallet﻿
  to know about   of  AstraPay registration.
﻿ visit  AstraPay Payment - API E-Wallet﻿  to know about   of  AstraPay .
﻿
Request Parameter for e-Wallet Registration 
﻿
The following is a list of s for requesting registration of   . This  uses in    platform as one of  stages so that  's  can connect with s from .
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required﻿
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20210315112359
iMid
﻿Required﻿
AN
10
﻿ ID	
﻿
IONPAYTEST
payMethod
﻿Required﻿
N
2
﻿Payment Method Code﻿﻿
05
currency
﻿Required﻿
A
3
Currency
﻿
IDR
amt 
﻿Required﻿
N
12
Amount
﻿
1000
referenceNo
 Required﻿
ANS
40
﻿'s Reference Number
﻿
ORD54321
goodsNm ﻿
﻿Required﻿
AN
100
Goods Name	
﻿
Test Transaction 
billingNm
﻿Required﻿
A
100
Buyer Name	
﻿
John Doe
billingPhone
 Required﻿
N
15
Buyer Phone Number
﻿
08123456789
billingEmail
﻿Required﻿
ANS
40
Buyer E-Mail	
﻿
[email protected]
billingAddr
﻿Required﻿
AN
100
Buyer Address	
﻿
Jalan Bukit Berbunga 22
billingCity
﻿Required﻿
A
50
Buyer City	
﻿
Jakarta
billingState
﻿Required﻿
A
50
Billing State
DKI Jakarta
billingPostCd
﻿Required﻿
N
10
Billing Post Number
12345
billingCountry
 Required﻿
A
10
Billing Country	
﻿
﻿ 
cartData 
JSONstring
4000
Cart Data
{ }
mitraCd
﻿Required﻿
A
4
﻿Mitra Code﻿﻿
OVOE
userIP 
﻿Required﻿
AN
15
User IP
﻿
127.0.0.1

dbProcessUrl
 Required﻿
ANS
255
Notification URL	
﻿
https://merchant.com/dbProcessUrl
merchantToken
﻿Required﻿
AN
255
﻿ Token	
﻿
a45e163042746131307bad89ef6cc0c517c136895a6cfe6cb77c4a62ce1ee5b3
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	
﻿ 
vat
N
12
﻿﻿
0
fee
N
12
Service Fee	
0
description
AN
100
Transaction Description	
Test Transaction

reqDomain
ANS
100
Request Domain	
merchant.com
reqServerIP
ANS
15
Request Server IP	
127.0.0.1
userIP
﻿Required﻿
AN
15
User IP Address
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
userAgent
﻿Required﻿
ANS
100
User Agent Information	
Mozilla
NotaxAmt
N
12
Tax-Free Amount
﻿
reqDt
N
8
Request Date (YYYYMMDD)
﻿
reqTm
N
6
Request Time (HH24MISS)	
﻿
﻿ visit E-Wallet﻿ to learn general  regarding  s. 
﻿
Response Parameter for E-Wallet Registration 
﻿
The following is  response  from  result of  request  to register on   .
Parameter
Type
Size
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿ 
SUCCESS
tXid
AN
30
Transaction ID
IONPAYTEST05202103151123583200
referenceNo
ANS
40
﻿ Reference Number
ORD54321
payMethod
N
2
﻿Payment Method Code﻿ 
05
amt
N
12
﻿ Amount
1000
transDt
N
8
Transaction Date (YYYYMMDD)
20210315
transTm
N
6
Transaction Time (HH24MISS)
112358
description
AN
100
Transaction Description
null
bankCd
A
4
﻿Bank Code﻿ 
null
vacctNo
N
20
﻿ 
null
mitraCd
A
4
﻿Mitra Code﻿ 
OVOE
payNo
N
12
CVS  Number
null
currency
A
3
Currency
IDR
goodsNm
AN
100
Goods Name
Test Transaction  
billingNm
A
100
Buyer Name
John Doe
payValidDt
N
8
CVS Expiry Date (YYYYMMDD) (CVS)
null
payValidTm
N
6
CVS Expiry Time (HH24MISS) (CVS)
null
vacctValidDt
N
8
Expiry Date (YYYYMMDD)
null
vacctValidTm
N
6
Expiry Time (HH24MISS)
null
requestURL
ANS
360
Request URL
null
paymentExpDt
N
6
QR  Expiry Date (YYYYMMDD)
null
paymentExpTm
N
6
QR  Expiry Time (HH24MISS)
null
qrContent
ANS
360
QR String in Plain Text
null
qrUrl
ANS
360
URL for QR Image, Valid for 5 minutes
null
﻿
Sample JSON for E-Wallet Registration 
﻿
JSON Request
JSON Response
Java 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"
}
{
  "timeStamp":"20210315112359",
  "iMid":"IONPAYTEST",
  "payMethod":"05",
  "currency":"IDR",
  "amt":"1000",
  "referenceNo":"ORD54321",
  "goodsNm":"Test Transaction Nicepay",
  "billingNm":"John Doe",
  "billingPhone":"08123456789",
  "billingEmail":"email@merchant.com",
  "billingAddr":"Jalan Bukit Berbunga 22",
  "billingCity":"Jakarta",
  "billingState":"DKI Jakarta",
  "billingPostCd":"12345",
  "billingCountry":"Indonesia",
  "deliveryNm":"email@merchant.com",
  "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"
}
﻿
﻿
Cart Data E-Wallet Registration
﻿
CartData in  Registration contains   items including their details and  price for each item.
Parameter
Description
Example
Count
The total number of all card data
2
Item
It is divided into 4 kinds of s, namely img_url, goods_name, goods_detail and goods_amt
-
﻿
Detailed explanation on Item  s.
Parameter
Description
Example
img_url
URL Goods Picture (Size 50px x 50px)
htttps://www.merchant.com/image_goods1.jpg
goods_name
Goods Name
Nama Item-1
goods_detail
Goods Detail Description
Detail Item-1
goods_amt
Goods Price
1000
goods_quantity
Goods Quantity
1
﻿
cartData E-Wallet Registration
{
    "count": "2",  
    "item": [  
        {
            "img_url": "http://www.merchant.com/image_goods1.jpg",  
            "goods_name": "Item 1 Name",
            "goods_detail": "Item 1 Detail",
            "goods_amt": "1000",
            "goods_quantity": "1"
        },  
        {
            "img_url": "http://www.merchant.com/image_goods2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "1000"
            "goods_quantity": "1"
        }  
    ] 
}
{
    "count": "2",  
    "item": [  
        {
            "img_url": "http://www.merchant.com/image_goods1.jpg",  
            "goods_name": "Item 1 Name",
            "goods_detail": "Item 1 Detail",
            "goods_amt": "1000",
            "goods_quantity": "1"
        },  
        {
            "img_url": "http://www.merchant.com/image_goods2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "1000"
            "goods_quantity": "1"
        }  
    ] 
}
﻿
﻿

API Endpoint	/nicepay/direct/v2/registration
Request Method	POST
Description	Performs Transaction Regist to
Merchant Token	SHA256(timeStamp+iMid+tXid+amt+merchantKey)
Request Format	application/json

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20210315112359
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	05
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount	1000
referenceNo Required	ANS	40	's Reference Number	ORD54321
goodsNm Required	AN	100	Goods Name	Test Transaction
billingNm Required	A	100	Buyer Name	John Doe
billingPhone Required	N	15	Buyer Phone Number	08123456789
billingEmail Required	ANS	40	Buyer E-Mail	[email protected]
billingAddr Required	AN	100	Buyer Address	Jalan Bukit Berbunga 22
billingCity Required	A	50	Buyer City	Jakarta
billingState Required	A	50	Billing State	DKI Jakarta
billingPostCd Required	N	10	Billing Post Number	12345
billingCountry Required	A	10	Billing Country
cartData	JSONstring	4000	Cart Data	{ }
mitraCd Required	A	4	Mitra Code	OVOE
userIP Required	AN	15	User IP	127.0.0.1
dbProcessUrl Required	ANS	255	Notification URL	https://merchant.com/dbProcessUrl
merchantToken Required	AN	255	Token	a45e163042746131307bad89ef6cc0c517c136895a6cfe6cb77c4a62ce1ee5b3
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
vat	N	12		0
fee	N	12	Service Fee	0
description	AN	100	Transaction Description	Test Transaction
reqDomain	ANS	100	Request Domain	merchant.com
reqServerIP	ANS	15	Request Server IP	127.0.0.1
userIP Required	AN	15	User IP Address	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
userAgent Required	ANS	100	User Agent Information	Mozilla
NotaxAmt	N	12	Tax-Free Amount
reqDt	N	8	Request Date (YYYYMMDD)
reqTm	N	6	Request Time (HH24MISS)

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST05202103151123583200
referenceNo	ANS	40	Reference Number	ORD54321
payMethod	N	2	Payment Method Code	05
amt	N	12	Amount	1000
transDt	N	8	Transaction Date (YYYYMMDD)	20210315
transTm	N	6	Transaction Time (HH24MISS)	112358
description	AN	100	Transaction Description	null
bankCd	A	4	Bank Code	null
vacctNo	N	20		null
mitraCd	A	4	Mitra Code	OVOE
payNo	N	12	CVS Number	null
currency	A	3	Currency	IDR
goodsNm	AN	100	Goods Name	Test Transaction
billingNm	A	100	Buyer Name	John Doe
payValidDt	N	8	CVS Expiry Date (YYYYMMDD) (CVS)	null
payValidTm	N	6	CVS Expiry Time (HH24MISS) (CVS)	null
vacctValidDt	N	8	Expiry Date (YYYYMMDD)	null
vacctValidTm	N	6	Expiry Time (HH24MISS)	null
requestURL	ANS	360	Request URL	null
paymentExpDt	N	6	QR Expiry Date (YYYYMMDD)	null
paymentExpTm	N	6	QR Expiry Time (HH24MISS)	null
qrContent	ANS	360	QR String in Plain Text	null
qrUrl	ANS	360	URL for QR Image, Valid for 5 minutes	null

Parameter	Description	Example
Count	The total number of all card data	2
Item	It is divided into 4 kinds of s, namely img_url, goods_name, goods_detail and goods_amt	-

Parameter	Description	Example
img_url	URL Goods Picture (Size 50px x 50px)	htttps://www.merchant.com/image_goods1.jpg
goods_name	Goods Name	Nama Item-1
goods_detail	Goods Detail Description	Detail Item-1
goods_amt	Goods Price	1000
goods_quantity	Goods Quantity	1

Updated 18 Sep 2024

Did this page help you?

API E-Wallet

Payment - API E-Wallet

Registration - API E-Wallet

About API for E-Wallet Registration

API for E-Wallet Registration

Request Parameter for e-Wallet Registration

Response Parameter for E-Wallet Registration

Sample JSON for E-Wallet Registration

Cart Data E-Wallet Registration

Welcome to NICEPAY DOCS