Registration - API Direct Debit

11min

About API Direct Debit Registration
﻿

﻿
﻿ provides 
﻿ as a 
﻿ feature. 
﻿ supported 
﻿ are:
Jenius Pay
However, there are some specific differences for Jenius, which locates in 
﻿ addition of 
﻿ Request Parameters, and also for request staging in Jenius, which is done via HTTPS.
﻿

API for Direct Debit Registration 
﻿

API Endpoint
/nicepay/direct/v2/registration
Request Method
﻿POST﻿
Description
Performs Transaction Regist to 
﻿
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/json
﻿
Request Parameter for Direct Debit Registration
﻿
The following is a list of 
﻿s for requesting registration of 
﻿ 
﻿ 
﻿. This 
﻿ uses through 
﻿ 
﻿ 
﻿ 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)
20221212155200
iMid  
﻿Required﻿
AN
10
﻿
﻿ ID	
﻿
IONPAYTEST
payMethod 
﻿Required﻿
N
2
﻿Payment Method Code﻿ 
﻿
04
currency  ﻿
﻿Required﻿
A
3
Currency
﻿
IDR
amt  
﻿Required﻿
N
12
Amount
﻿
5000
referenceNo
 Required﻿
ANS
40
﻿
﻿'s Reference Number	
﻿
order20221212155200
goodsNm ﻿
﻿Required﻿
AN
100
Goods Name	
﻿
Test Transaction 
﻿
billingNm 
﻿Required﻿
A
100
Buyer Name	
﻿
John Doe
billingPhone
﻿Required﻿
N
15
Buyer Phone Number
﻿
081214714045
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
﻿Required﻿
JSONstring

4000
Cart Data
﻿
{}
sellers
JSON String
4000
Seller Data
﻿
instmntType
N
2
﻿Installment Type Code﻿ 
2
instmntMon
N
2
Installment Month 
Required for CC	
1
recurrOpt 
N
2
0: Automatic Cancel
1: Do not cancel
2: Do not make token
0
bankCd
A
4
﻿Bank Code﻿ 
-
vacctValidDt
N
8
VA Expiry Date (YYYYMMDD)
20200303
vacctValidTm
N
6
VA Expiry Time (HH24MISS)
-
merFixAcctId
AN
40
﻿
﻿ Reserved VA ID
-
mitraCd
A
4
﻿Mitra Code﻿ 
JENC
userIP 
AN
15
User IP
127.0.0.1
dbProcessUrl
﻿Required﻿
ANS
255
Notification URL	
﻿
https://merchant.com/dbProcessUrl
merchantToken
﻿Required﻿
AN
255
﻿
﻿ Token	
6cfccfc0046773c1b589d8e 98f8b596c284f3c70a4ecf8 6eba14c18944b74bcd
deliveryNm
A
30
Delivery Name	
[email protected]
deliveryPhone
N
15
Delivery Phone	
081214714045
deliveryAddr
AN
100
Delviery Address	
Jalan Bukit Berbunga 22
deliveryCity
A
50
Delivery City	
Jakarta
deliveryState
A
50
Delivery State	
DKI Jakarta
deliveryPostCd
N
10
Delivery Post Code	
12345
deliveryCountry
A
10
Delivery Country	
﻿
﻿﻿
vat
N
12
﻿
﻿﻿
0
fee
N
12
Service Fee	
0
 notaxAmt
N
12
Tax Free Amount
-
description
AN
100
Transaction Description	
Testing
merchantToken
AN
255
﻿
﻿ Token
0dd1393f41bccbc33ed82cb514138aa5a46c24a6e55730868d264f3d80fb4fc1
reqDt
N
8
Request Date (YYYYMMDD)
-
reqTm
N
6
Request Time (HH24MISS)
-
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

shopId
AN
32
Shop ID
NICEPAY
userAgent
﻿Required﻿
ANS
100
User Agent Information	
Mozilla
recurrOpt
﻿
N
2
0: Automatic Cancel
1: Do not cancel
2: Do not make token
2
﻿
﻿ visit Direct Debit﻿ 
﻿ to learn general 
﻿ about 
﻿ 
﻿ 
﻿. 
﻿
Additional Information Request for Direct Debit Registration
﻿
The 
﻿s below contain additional 
﻿ regarding 
﻿ Registration 
﻿.

Parameter
Type
Size
Description
Example / Notes
payMethod
﻿Required﻿
N
2
﻿Payment Method Code﻿ 
﻿
04
mitraCd
﻿Required﻿
A
4
﻿Mitra Code﻿ 
﻿
JENC
mRefNo
﻿Required﻿
AN
18
﻿
﻿ Jenius Reference Number
﻿
﻿
Response Parameter for Direct Debit Registration
﻿
The following is a list of response 
﻿s from registration requests in 
﻿ 
﻿ 
﻿ 
﻿.
Parameter
Type
Size
Decription
Example / Notes
resultCd
N
14
﻿Result Code﻿ 
0000
resultMsg
﻿
AN
255
Result Message: Error Code﻿ 
SUCCESS
tXid
﻿
AN
30
Transaction ID
IONPAYTEST04202212121554299694
referenceNo
ANS
40
﻿
﻿ Reference Number
order20221212155200
payMethod 
N
2
﻿Payment Method Code﻿ 
04
amt
N
12
﻿
﻿ Amount
5000
transDt ﻿
N
8
Transaction Date (YYYYMMDD)
20221212
transTm
N
6
Transaction Time (HH24MISS)
155431
description
AN
100
Description
Testing
bankCd
AN
4
﻿Bank Code﻿ 
null
vacctNo
N
20
VA Number
null
mitraCd
AN
4
﻿Mitra Code﻿ 
JENC
payNo
N
12
﻿
﻿ Number
null
currency
A
3
Currency
null
goodsNm
AN
100
Goods Name
null
billingNm
A
100
Buyer Name
null
vacctValidDt
N
8
VA Expiry Date (YYYYMMDD)
null
vacctValidTm
N
6
VA Expiry Time (HH24MISS)
null
payValidDt
N
8
Expiry Date (YYYYMMDD)
 null
payValidTm 
N
6
Expiry Time (HH24MISS)
null
requestURL
ANS
360
Request URL
null
paymentExpDt
N
8
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 Direct Debit Registration
﻿
JSON Request
JSON Response
Java Request
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST04202212121554299694",
    "referenceNo": "order20221212155200",
    "payMethod": "04",
    "amt": "5000",
    "transDt": "20221212",
    "transTm": "155431",
    "description": "Testing",
    "bankCd": null,
    "vacctNo": null,
    "mitraCd": "JENC",
    "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
}
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST04202212121554299694",
    "referenceNo": "order20221212155200",
    "payMethod": "04",
    "amt": "5000",
    "transDt": "20221212",
    "transTm": "155431",
    "description": "Testing",
    "bankCd": null,
    "vacctNo": null,
    "mitraCd": "JENC",
    "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
}
﻿
﻿

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

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20221212155200
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	04
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount	5000
referenceNo Required	ANS	40	's Reference Number	order20221212155200
goodsNm Required	AN	100	Goods Name	Test Transaction
billingNm Required	A	100	Buyer Name	John Doe
billingPhone Required	N	15	Buyer Phone Number	081214714045
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 Required	JSONstring	4000	Cart Data	{}
sellers	JSON String	4000	Seller Data
instmntType	N	2	Installment Type Code	2
instmntMon	N	2	Installment Month Required for CC	1
recurrOpt	N	2	0: Automatic Cancel 1: Do not cancel 2: Do not make token	0
bankCd	A	4	Bank Code	-
vacctValidDt	N	8	VA Expiry Date (YYYYMMDD)	20200303
vacctValidTm	N	6	VA Expiry Time (HH24MISS)	-
merFixAcctId	AN	40	Reserved VA ID	-
mitraCd	A	4	Mitra Code	JENC
userIP	AN	15	User IP	127.0.0.1
dbProcessUrl Required	ANS	255	Notification URL	https://merchant.com/dbProcessUrl
merchantToken Required	AN	255	Token	6cfccfc0046773c1b589d8e 98f8b596c284f3c70a4ecf8 6eba14c18944b74bcd
deliveryNm	A	30	Delivery Name	[email protected]
deliveryPhone	N	15	Delivery Phone	081214714045
deliveryAddr	AN	100	Delviery Address	Jalan Bukit Berbunga 22
deliveryCity	A	50	Delivery City	Jakarta
deliveryState	A	50	Delivery State	DKI Jakarta
deliveryPostCd	N	10	Delivery Post Code	12345
deliveryCountry	A	10	Delivery Country
vat	N	12		0
fee	N	12	Service Fee	0
notaxAmt	N	12	Tax Free Amount	-
description	AN	100	Transaction Description	Testing
merchantToken	AN	255	Token	0dd1393f41bccbc33ed82cb514138aa5a46c24a6e55730868d264f3d80fb4fc1
reqDt	N	8	Request Date (YYYYMMDD)	-
reqTm	N	6	Request Time (HH24MISS)	-
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
shopId	AN	32	Shop ID	NICEPAY
userAgent Required	ANS	100	User Agent Information	Mozilla
recurrOpt	N	2	0: Automatic Cancel 1: Do not cancel 2: Do not make token	2

Parameter	Type	Size	Description	Example / Notes
payMethod Required	N	2	Payment Method Code	04
mitraCd Required	A	4	Mitra Code	JENC
mRefNo Required	AN	18	Jenius Reference Number

Parameter	Type	Size	Decription	Example / Notes
resultCd	N	14	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST04202212121554299694
referenceNo	ANS	40	Reference Number	order20221212155200
payMethod	N	2	Payment Method Code	04
amt	N	12	Amount	5000
transDt	N	8	Transaction Date (YYYYMMDD)	20221212
transTm	N	6	Transaction Time (HH24MISS)	155431
description	AN	100	Description	Testing
bankCd	AN	4	Bank Code	null
vacctNo	N	20	VA Number	null
mitraCd	AN	4	Mitra Code	JENC
payNo	N	12	Number	null
currency	A	3	Currency	null
goodsNm	AN	100	Goods Name	null
billingNm	A	100	Buyer Name	null
vacctValidDt	N	8	VA Expiry Date (YYYYMMDD)	null
vacctValidTm	N	6	VA Expiry Time (HH24MISS)	null
payValidDt	N	8	Expiry Date (YYYYMMDD)	null
payValidTm	N	6	Expiry Time (HH24MISS)	null
requestURL	ANS	360	Request URL	null
paymentExpDt	N	8	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

Updated 05 Sep 2024

Did this page help you?

API Direct Debit

Status Inquiry - API Direct Debit

Registration - API Direct Debit

About API Direct Debit Registration

API for Direct Debit Registration

Request Parameter for Direct Debit Registration

Additional Information Request for Direct Debit Registration

Response Parameter for Direct Debit Registration

Sample JSON for Direct Debit Registration

Welcome to NICEPAY DOCS