E-Wallet - V1 Enterprise

9min

E-Wallet
﻿

﻿ offer  as . This allows  to make  with OVO, LinkAja, DANA, and ShopeePay (Jump App). Real-Time Notification will be sent when  has completed  .

Supported E-Wallet by NICEPAY

OVO
LinkAja
DANA
ShopeePay
﻿
E-Wallet Flow V1:

﻿ request  Transaction Registration to .
﻿ will redirect  to   Page/ App or send Notification to   App.
﻿ make  on   Page/App.
﻿ send Notification to .
﻿ handle .
E-Wallet Flow V1
﻿
Steps description:
The  requests  to  .
﻿ regists  through Registration  (/nicepay/api/ewalletTrans.do) to .
﻿ request  to   .
The   generates .
﻿ saves   .
The   redirect   to   .
The  logins to their account.
The  s   to   .
The   receives  .
The   sends   to .
﻿ receives  .
﻿ sends   to .
﻿ receives  .
﻿ request   check to .
﻿ sends  check  response to .
﻿ receives  final .
﻿ sends  confirmation to  .
﻿
E-Wallet Registration
﻿

API Specifications - E-Wallet Registration
API Endpoint
/nicepay/api/ewalletTrans.do
Request Method application/x-www-form-urlencoded
﻿POST﻿
Description
Request  Transaction

Merchant Token
SHA256(iMid+referenceNo+amt+merchantKey)
Payment Method
05 ﻿
﻿
Request Parameter - E-Wallet Registration
E-Wallet Registrasi - Request Parameter
iMid=IONPAYTEST&payMethod=05&currency=IDR&amt=5000&referenceNo=OrdNo-20240627130699&goodsNm=Jhon%20Doe%20S&billingNm=Jhon%20Doe&billingPhone=085695655726
&billingEmail=test@email.com&callBackUrl=https://webhook.site/e1e151bc-23f5-4db9-8272-6addeea95701&dbProcessUrl=https://webhook.site/e1e151bc-23f5-4db9-8272-6addeea95701&description=This%20is%20Testing Transaction&merchantToken=c9a9a1d5910757c4eef8de68d665819adcf3e066fd961b306d2ccb53ba9edb9c&mitraCd=ESHP&userIP=::1&billingCity=Nicepay%20City&billingAddr=Nicepay%20Company&billingCountry=Jakarta&billingState=Nicepay%20State&billingPostCd=12345&cartData={\"count\":\"1\",\"item\":[{\"img_url\":\"https://d3nevzfk7ii3be.cloudfront.net/igi/vOrGHXlovukA566A.medium\",\"goods_name\":\"Nokia 3360\",\"goods_detail\":\"Old Nokia 3360\",\"goods_amt\":\"5000\",\"goods_quantity\":\"1\"}]}&returnJsonFormat=1
iMid=IONPAYTEST&payMethod=05&currency=IDR&amt=5000&referenceNo=OrdNo-20240627130699&goodsNm=Jhon%20Doe%20S&billingNm=Jhon%20Doe&billingPhone=085695655726
&billingEmail=test@email.com&callBackUrl=https://webhook.site/e1e151bc-23f5-4db9-8272-6addeea95701&dbProcessUrl=https://webhook.site/e1e151bc-23f5-4db9-8272-6addeea95701&description=This%20is%20Testing Transaction&merchantToken=c9a9a1d5910757c4eef8de68d665819adcf3e066fd961b306d2ccb53ba9edb9c&mitraCd=ESHP&userIP=::1&billingCity=Nicepay%20City&billingAddr=Nicepay%20Company&billingCountry=Jakarta&billingState=Nicepay%20State&billingPostCd=12345&cartData={\"count\":\"1\",\"item\":[{\"img_url\":\"https://d3nevzfk7ii3be.cloudfront.net/igi/vOrGHXlovukA566A.medium\",\"goods_name\":\"Nokia 3360\",\"goods_detail\":\"Old Nokia 3360\",\"goods_amt\":\"5000\",\"goods_quantity\":\"1\"}]}&returnJsonFormat=1
﻿
Parameter
Type
Size
Description
Example Value
iMid
﻿Required﻿
AN
10
﻿ ID
IONPAYTEST
payMethod
Required
﻿
N
2
﻿Payment Method﻿﻿
05
currency
Required
﻿
A

3
Currency
IDR
amt
Required
﻿
N

12
Goods Amount
15000
referenceNo
Required﻿
ANS
40
﻿ Reference Number
OrdNo-20240627130699
goodsNm
Required
﻿
AN
100
Goods Name
Test Goods
billingNm
Required
﻿
A
30
Billing Name
John Doe
billingPhone
Required
﻿
N
15
Billing Phone Number
081249195
billingEmail
Required
﻿

ANS
40
Billing E-Mail
[email protected]
billingCity
Required﻿
A
50
Billing City
Jakarta
billingState
Required
﻿
A
50
Billing State
DKI Jakarta
billingPostCd
Required
﻿
N
10
Billing Post Number
14350
billingCountry
Required
﻿
A
10
Billing Country
﻿﻿
callBackUrl
Required
﻿
ANS
255
﻿ Result URL
https://merchant.com/callBackUrl
dbProcessUrl
Required
﻿
ANS
255
﻿ Notif URL
https://merchant.com/dbProcessUrl
description
Required
﻿
AN
100
Description
test item
merchantToken
Required
﻿
AN
255
﻿ Token
6cfccfc0046773c1b589d8e
98f8b596c284f3c70a4ecf8
6eba14c18944b74bcd
userIP
Required﻿
ANS
15
User IP ()
127.0.0.1
cartData
Required﻿
JSON OBJECT
4000
Cart Data (JSON Format)
{}
mitraCd
Required﻿
A
4
﻿Mitra Code﻿﻿
OVOE
billingAddr
AN
﻿255﻿
Billing Address
Jln Cendrawasih
deliveryNm
A
30
Delivery Name
John Doe
deliveryPhone
N
15
Delivery Phone
08125912342
deliveryAddr
AN
100
Delivery Address	
Jln Merak
deliveryEmail
ANS
﻿100﻿
Delivery E-Mail
[email protected]
deliveryCity
A
50
Delivery City	
Jakarta
deliveryState
A
50
Delivery State	
DKI Jakarta
deliveryPostCd
A
10
Delivery Post Code	
14350
deliveryCountry
A
10
Delivery Country	
﻿﻿
vat
N
12
﻿ 
0
fee
N
12
Service Tax	
0
notaxAmt
N
12
Tax Free Amount	
0
reqDt
N
8
Request Date (YYYYMMDD)	
20160301
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
Request Client Version	
1.0
userSessionID
AN
100
User Session ID	
userSessionID
userAgent
ANS
100
User Agent	
Mozilla
userLanguage
ANS
2
User Language	
en-US
returnJsonFormat
Optional For Shopeepay to get URL redirect Shopeepay

AN
100
If  value is 1, then it will return ShopeePay link.

If  value is empty/0, then it will redirect to other HTML  

1 : return redirect_Url_App and redirect_Url_Http or 
empty/0 : return HTML to redirect
Note for ShopeePay: in  to better user experience to  , please give a warning message for   to open  mobile device.
﻿
Registration Response - E-Wallet Registration
Sample Response
{
  "resultCd": "0000",
  "resultMsg": "SUCCESS",
  "tXid": "IONPAYTEST05202406271415477199",
  "referenceNo": "OrdNo-20240627130699",
  "payMethod": "05",
  "amt": "5000",
  "transDt": "20240627",
  "transTm": "141547",
  "mitraCd": "ESHP",
  "paymentExpDt": "20240627",
  "paymentExpTm": "142047",
  "redirectUrlHttp": "https://pay.uat.airpay.co.id/h5pay/pay?type=start&medium_index=dFhkbmR1bTBIamhWkgfJbkz2qaOZ37tSA2Hlx2cGFpMbFT0O99axPjtePPGvC4Ir&order_key=EMxd8m9exLwBDR2VJ9GXrEh_95aC3EU1jDonGQ4S_cN_CTswgjfwTIGhNwx7gmr3ttbbZl7AtkXwqw&order_sn=119250619060979433&return_url=aHR0cHM6Ly9kZXYubmljZXBheS5jby5pZC9uaWNlcGF5L2FwaS9zaG9wZWVQYXlDYWxsYmFjay5kbz9hbW91bnQ9NTAwMDAwJmNsaWVudF9pZD1OSUNFUEFZJnJlZmVyZW5jZV9pZD0wNTIwMjQwNjI3MTQxNTQ3Nzg1MCZyZXN1bHRfY29kZT0yMDMmc2lnbmF0dXJlPXRueG9kVE8xUTJhMHZIZnlDTlEtcjBBWDFhdGo4dzlJUklvSG9CMlVpMHclM0QmdFhpZD1JT05QQVlURVNUMDUyMDI0MDYyNzE0MTU0NzcxOTk%3D&source=web&token=dFhkbmR1bTBIamhWkgfJbkz2qaOZ37tSA2Hlx2cGFpMbFT0O99axPjtePPGvC4Ir",
  "redirectUrlApp": "",
  "redirectToken": null
}
{
  "resultCd": "0000",
  "resultMsg": "SUCCESS",
  "tXid": "IONPAYTEST05202406271415477199",
  "referenceNo": "OrdNo-20240627130699",
  "payMethod": "05",
  "amt": "5000",
  "transDt": "20240627",
  "transTm": "141547",
  "mitraCd": "ESHP",
  "paymentExpDt": "20240627",
  "paymentExpTm": "142047",
  "redirectUrlHttp": "https://pay.uat.airpay.co.id/h5pay/pay?type=start&medium_index=dFhkbmR1bTBIamhWkgfJbkz2qaOZ37tSA2Hlx2cGFpMbFT0O99axPjtePPGvC4Ir&order_key=EMxd8m9exLwBDR2VJ9GXrEh_95aC3EU1jDonGQ4S_cN_CTswgjfwTIGhNwx7gmr3ttbbZl7AtkXwqw&order_sn=119250619060979433&return_url=aHR0cHM6Ly9kZXYubmljZXBheS5jby5pZC9uaWNlcGF5L2FwaS9zaG9wZWVQYXlDYWxsYmFjay5kbz9hbW91bnQ9NTAwMDAwJmNsaWVudF9pZD1OSUNFUEFZJnJlZmVyZW5jZV9pZD0wNTIwMjQwNjI3MTQxNTQ3Nzg1MCZyZXN1bHRfY29kZT0yMDMmc2lnbmF0dXJlPXRueG9kVE8xUTJhMHZIZnlDTlEtcjBBWDFhdGo4dzlJUklvSG9CMlVpMHclM0QmdFhpZD1JT05QQVlURVNUMDUyMDI0MDYyNzE0MTU0NzcxOTk%3D&source=web&token=dFhkbmR1bTBIamhWkgfJbkz2qaOZ37tSA2Hlx2cGFpMbFT0O99axPjtePPGvC4Ir",
  "redirectUrlApp": "",
  "redirectToken": null
}
﻿

Parameter
Type
Size
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
Result M
essage: E-Wallet Error Code﻿﻿
Success
tXid
AN
30
Transaction ID

IONPAYTEST05202406260930529202
referenceNo
ANS
40
﻿'s Reference Number
20240626093051
payMethod
﻿
N
2
﻿Payment Method Code﻿﻿
05
amt
N
12
Amount
10000
transDt
N
8
Transaction Date ( YYYYMMDD )
20240626
transTm
N
6
Transaction Date ( HH24MISS )
093052
mitraCd
AN
4
﻿Mitra Code﻿﻿
ESHP
paymentExpDt
N
8
﻿ Expiry Date ( YYYYMMDD )
When success , ShopeePay
paymentExpTm
N
6
﻿ Expiry Time ( HH24MISS )
When success , ShopeePay
redirectUrlHttp
AN
100
Jump App to ShopeePay
https://pay.uat.airpay.co.id/h5pay/example
redirectUrlApp
AN
100
﻿
For ShopeePay (ESHP), this value will be empty
redirectToken
﻿
AN
2000
Used only for LinkAja
﻿
﻿

API Endpoint	/nicepay/api/ewalletTrans.do
Request Method application/x-www-form-urlencoded	POST
Description	Request Transaction
Merchant Token	SHA256(iMid+referenceNo+amt+merchantKey)
Payment Method	05

Parameter	Type	Size	Description	Example Value
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method	05
currency Required	A	3	Currency	IDR
amt Required	N	12	Goods Amount	15000
referenceNo Required	ANS	40	Reference Number	OrdNo-20240627130699
goodsNm Required	AN	100	Goods Name	Test Goods
billingNm Required	A	30	Billing Name	John Doe
billingPhone Required	N	15	Billing Phone Number	081249195
billingEmail Required	ANS	40	Billing E-Mail	[email protected]
billingCity Required	A	50	Billing City	Jakarta
billingState Required	A	50	Billing State	DKI Jakarta
billingPostCd Required	N	10	Billing Post Number	14350
billingCountry Required	A	10	Billing Country
callBackUrl Required	ANS	255	Result URL	https://merchant.com/callBackUrl
dbProcessUrl Required	ANS	255	Notif URL	https://merchant.com/dbProcessUrl
description Required	AN	100	Description	test item
merchantToken Required	AN	255	Token	6cfccfc0046773c1b589d8e 98f8b596c284f3c70a4ecf8 6eba14c18944b74bcd
userIP Required	ANS	15	User IP ()	127.0.0.1
cartData Required	JSON OBJECT	4000	Cart Data (JSON Format)	{}
mitraCd Required	A	4	Mitra Code	OVOE
billingAddr	AN	255	Billing Address	Jln Cendrawasih
deliveryNm	A	30	Delivery Name	John Doe
deliveryPhone	N	15	Delivery Phone	08125912342
deliveryAddr	AN	100	Delivery Address	Jln Merak
deliveryEmail	ANS	100	Delivery E-Mail	[email protected]
deliveryCity	A	50	Delivery City	Jakarta
deliveryState	A	50	Delivery State	DKI Jakarta
deliveryPostCd	A	10	Delivery Post Code	14350
deliveryCountry	A	10	Delivery Country
vat	N	12		0
fee	N	12	Service Tax	0
notaxAmt	N	12	Tax Free Amount	0
reqDt	N	8	Request Date (YYYYMMDD)	20160301
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	Request Client Version	1.0
userSessionID	AN	100	User Session ID	userSessionID
userAgent	ANS	100	User Agent	Mozilla
userLanguage	ANS	2	User Language	en-US
returnJsonFormat Optional For Shopeepay to get URL redirect Shopeepay	AN	100	If value is 1, then it will return ShopeePay link. If value is empty/0, then it will redirect to other HTML	1 : return redirect_Url_App and redirect_Url_Http or empty/0 : return HTML to redirect

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result M essage: E-Wallet Error Code	Success
tXid	AN	30	Transaction ID	IONPAYTEST05202406260930529202
referenceNo	ANS	40	's Reference Number	20240626093051
payMethod	N	2	Payment Method Code	05
amt	N	12	Amount	10000
transDt	N	8	Transaction Date ( YYYYMMDD )	20240626
transTm	N	6	Transaction Date ( HH24MISS )	093052
mitraCd	AN	4	Mitra Code	ESHP
paymentExpDt	N	8	Expiry Date ( YYYYMMDD )	When success , ShopeePay
paymentExpTm	N	6	Expiry Time ( HH24MISS )	When success , ShopeePay
redirectUrlHttp	AN	100	Jump App to ShopeePay	https://pay.uat.airpay.co.id/h5pay/example
redirectUrlApp	AN	100		For ShopeePay (ESHP), this value will be empty
redirectToken	AN	2000	Used only for LinkAja

Updated 08 Oct 2024

Did this page help you?

Direct Debit - V1 Enterprise

QRIS - V1 Enterprise

E-Wallet - V1 Enterprise

E-Wallet

Supported E-Wallet by NICEPAY

E-Wallet Flow V1:

Transaction Flow

E-Wallet Registration

API Specifications - E-Wallet Registration

Request Parameter - E-Wallet Registration

Registration Response - E-Wallet Registration

Welcome to NICEPAY DOCS