Registration - API Convenience Store

10 min

About API Convenience Store Registration

NICEPAY provides department stores (Indomaret and Alfamart Group) as a payment method so Customers can proceed with payments through Department Store Partners outlets throughout Indonesia. Real-time notifications will send directly when the payment is successful.

NICEPAY Department Store Partners:

Alfamart
Indomaret
Lawson
Alfamidi
Dan+Dan Store

API Convenience Store Registration

This API uses to activate the Convenience Store payment methods for Merchants, so the Customer can proceed with payment transactions using the Convenience Store with Merchants. This stage uses to integrate the Merchant system with the NICEPAY system.

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

Please visit NICEPAY Code page to find out a list of code terms related to the API system.

Request Parameter for Convenience Store Registration

The following is a list of parameters for requesting registration of the Convenience Store payment method. This parameter uses in the API testing platform as one of the stages so that the Merchant's system can connect with NICEPAY services.

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20221202152801
iMid Required	AN	10	Merchant ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	03
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount	5000
referenceNo Required	ANS	40	Merchant's Reference Number	Order12345
goodsNm Required	AN	100	Goods Name	Test Transaction NICEPAY
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	Indonesia
cartData	JSONstring	4000	Cart Data
mitraCd Required	A	4	Mitra Code	ALMA
userIP	AN	15	User IP	127.0.0.1
dbProcessUrl Required	ANS	255	Notification URL	https://ptsv2.com/t/test-nicepay-v2
merchantToken Required	AN	255	Merchant Token	fa79a58a73bf9f6d07ce84daaabb8f23da6ca61d478d4e917d2e259d5c7e1106
deliveryNm	A	30	Delivery Name	Customer@merchant.com
deliveryPhone	N	15	Delivery Phone	12345678
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	Indonesia
description	AN	100	Transaction Description	-
reqDomain	ANS	100	Request Domain	merchant.com
reqServerIP	ANS	15	Request Server IP	127.0.0.1
reqClientVer	ANS	50	Client Version	-
userSessionID	AN	100	User Session ID	697D6922C961070967D3BA1BA5699C2C

Please visit Convenience Store (CVS) section to learn general information about Convenience Store payment methods.

Additional Information Request for Convenience Store Registration

The parameters below contain additional information regarding Convenience Store Registration information.

Parameter	Type	Size	Description	Example / Notes
payMethod Required	N	2	Convenience Store	03
mitraCd Required	A	4	Merchant ID	IONPAYTEST
payValidDt Required	N	8	CVS Expiry Date (YYYYMMDD)	20221212
payValidTm Required	N	6	CVS Expiry Time (HH24MISS)	201012

Response Parameter for Convenience Store Registration

The following is a list of responses to requests for status inquiry in the Convenience Store transaction process.

Parameter	Type	Size	Description	Example / Notes
resultCd	N	14	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST03202212021529034686
referenceNo	ANS	40	Merchant Reference Number	Order12345
payMethod	N	2	Payment Method Code	03
amt	N	12	Payment Amount	5000
transDt	N	8	Transaction Date (YYYYMMDD)	20221202
transTm	N	6	Transaction Time (HH24MISS)	152903
description	AN	100	Description	null
bankCd	AN	4	Bank Code	null
vacctNo	N	20	VA Number	null
mitraCd	AN	4	Mitra Code	ALMA
payNo	N	12	Payment Number	9041021529034686
currency	AN	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 Payment Expiry Date (YYYYMMDD)	null
paymentExpTm	N	6	QR Payment 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 Convenience Store Registration

{
	"timeStamp":"20221202152801",
	"iMid":"IONPAYTEST",
	"payMethod":"03",
	"currency":"IDR",
	"amt":"5000",
	"referenceNo":"Order12345",
	"goodsNm":"Test Transaction Nicepay",
	"billingNm":"John Doe",
	"billingPhone":"081214714045",
	"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://ptsv2.com/t/test-nicepay-v2",
	"description":"",
	"merchantToken":"fa79a58a73bf9f6d07ce84daaabb8f23da6ca61d478d4e917d2e259d5c7e1106",
	"reqDt":"",
	"reqTm":"",
	"reqDomain":"merchant.com",
	"reqServerIP":"127.0.0.1",
	"reqClientVer":"",
	"userIP":"127.0.0.1",
	"userSessionID":"697D6922C961070967D3BA1BA5699C2C",
	"mitraCd":"ALMA"
}