NICEPAY API Convenience Store (CVS) - V1 Enterprise

Convenience Store (CVS) - V1 Enterprise

8min

Convenience Store
﻿

﻿
﻿ menawarkan 
﻿ melalui 
﻿ (
﻿), seperti Alfamart dan Indomaret, 
﻿ akan mempermudah pengalaman berbelanja bagi 
﻿ 
﻿.
Supported CVS by NICEPAY:

Alfamart.
Indomaret.
Lawson.
Alfamidi.
Dan+Dan Store.
CVS Flow V1 
Alur CVS V1 Enterprise
﻿
Alur CVS:
﻿
﻿ melakukan request checkout.
﻿
﻿ mengirimkan data kepada 
﻿.
﻿
﻿ melakukan pendaftaran menggunakan API Regist kepada 
﻿.
﻿
﻿ melakukan validasi dan generate nomor 
﻿.
﻿
﻿ mengirimkan nomor 
﻿ kepada 
﻿.
﻿
﻿ mengirimkan nomor 
﻿ kepada 
﻿.
﻿
﻿ memberikan nomor 
﻿ CVS kepada 
﻿.
﻿
﻿ mengirimkan data nomor CVS kepada 
﻿.
CVS mengirimkan data inquiry kepada 
﻿.
﻿
﻿ melakukan 
﻿ inquiry.
﻿
﻿ mengirimkan 
﻿ inquiry kepada CVS.
﻿
﻿ melakukan 
﻿.
﻿
﻿ mengirimkan 
﻿ 
﻿ kepada CVS.
CVS membuat bukti 
﻿.
CVS mengirimkan bukti 
﻿ kepada 
﻿.
CVS mengirim notifikasi 
﻿ kepada 
﻿.
﻿
﻿ memperbarui 
﻿.
﻿
﻿ mengirim 
﻿ kepada 
﻿.
﻿
﻿ request pemeriksaan 
﻿ menggunakan 
﻿ kepada 
﻿.
﻿
﻿ menerima request 
﻿ dikirimkan oleh 
﻿.
﻿
﻿ mengirimkan response kepada 
﻿.
﻿
﻿ menerima 
﻿ akhir.
﻿
﻿ mengirimkan hasil pesanan kepada 
﻿.
﻿
CVS Registration
﻿
API Specifications - CVS Registration
API Endpoint
/nicepay/api/onePass.do
Request Method  ﻿application/x-www-form-urlencoded﻿
﻿POST﻿
Description
Request payNo  untuk melakukan 
﻿ CVS di 
﻿﻿
Merchant Token
SHA256(iMid+referenceNo+amt+merchantKey)
Payment Method
03 Convenience Store
﻿
Request Parameter - CVS Registration
Convenience Store Registrasi - Request Parameter
// Payment Mandatory Field
nicePay.setPayMethod("03");
nicePay.setCurrency("IDR");
nicePay.setAmt("1000");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setMitraCd("ALMA");
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");
nicePay.setDeliveryPhone("081234567890");
nicePay.setDeliveryAddr("Billing Address ");
nicePay.setDeliveryCity("Jakarta ");
nicePay.setDeliveryState("Jakarta ");
nicePay.setDeliveryPostCd("12345");
nicePay.setDeliveryCountry("Indonesia ");
nicePay.setCallBackUrl(merchantDomain + "callback");
nicePay.setDbProcessUrl(merchantDomain + "dbprocess");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("Description");
nicePay.setUserIP("127.0.0.1");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");

// Payment Optional Field
nicePay.setReqDt("20160301");
nicePay.setReqTm("135959");
nicePay.setReqDomain("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.setPaymentExpiryDt("20160303");
nicePay.setPaymentExpiryTm("135959");
nicePay.setPayValidDt("20160303");
nicePay.setPayValidTm("135959");


// Payment Request
nicePay.payment();

// 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 referenceNo= nicePay.Get("referenceNo");
String payNo= nicePay.Get("payNo");
String payMethod= nicePay.Get("payMethod");
String amount= nicePay.Get("amount");
String transDt = nicePay.Get("transDt ");
String transTm = nicePay.Get("transTm ");
String description= nicePay.Get("description");
String callbackUrl= nicePay.Get("callbackUrl");
String mitraCd= nicePay.Get("mitraCd");
// Payment Mandatory Field
nicePay.setPayMethod("03");
nicePay.setCurrency("IDR");
nicePay.setAmt("1000");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setMitraCd("ALMA");
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");
nicePay.setDeliveryPhone("081234567890");
nicePay.setDeliveryAddr("Billing Address ");
nicePay.setDeliveryCity("Jakarta ");
nicePay.setDeliveryState("Jakarta ");
nicePay.setDeliveryPostCd("12345");
nicePay.setDeliveryCountry("Indonesia ");
nicePay.setCallBackUrl(merchantDomain + "callback");
nicePay.setDbProcessUrl(merchantDomain + "dbprocess");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("Description");
nicePay.setUserIP("127.0.0.1");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");

// Payment Optional Field
nicePay.setReqDt("20160301");
nicePay.setReqTm("135959");
nicePay.setReqDomain("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.setPaymentExpiryDt("20160303");
nicePay.setPaymentExpiryTm("135959");
nicePay.setPayValidDt("20160303");
nicePay.setPayValidTm("135959");


// Payment Request
nicePay.payment();

// 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 referenceNo= nicePay.Get("referenceNo");
String payNo= nicePay.Get("payNo");
String payMethod= nicePay.Get("payMethod");
String amount= nicePay.Get("amount");
String transDt = nicePay.Get("transDt ");
String transTm = nicePay.Get("transTm ");
String description= nicePay.Get("description");
String callbackUrl= nicePay.Get("callbackUrl");
String mitraCd= nicePay.Get("mitraCd");
﻿

Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
iMid
﻿Required﻿
AN
10
﻿
﻿ ID
IONPAYTEST
payMethod
Required
﻿
N
2
﻿Payment Method﻿﻿
03
currency
Required
﻿
A

3
Currency
IDR
amt
Required
﻿
N

12
Goods Amount
1000
referenceNo
Required﻿
ANS
40
﻿
﻿ Order No.
MerchantReferenceNumber001
goodsNm
Required
﻿
AN
100
Goods Name
Merchant Goods 1
billingNm
Required
﻿
A
A
Billing Name
John Doe
billingPhone
Required
﻿
N
15
Billing Phone Number
081234567890
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
12345
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
6cfccfc0046773c1b589d8e98f8b596c284f3c70a4ecf86eba14c18944b74bcd
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﻿﻿
ALMA
billingAddr
AN
﻿255﻿
Billing Address
Jln Cendrawasih
deliveryNm
A
30
Delivery Name
John Doe
deliveryPhone
N
15
Delivery Phone
081234567890
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
Vat
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
payValidDt
N
8
CVS Expiry date (YYYYMMDD)	
20160303
payValidTm
N
6
CVS Expiry time (HH24MISS)	
135959
﻿
Response Parameter - CVS Registration
JSON
{
    "resultCd": "0000",
    "amount": "10000",
    "goodsNm": "Test Transaction Nicepay",
    "referenceNo": "99997",
    "transTm": "110847",
    "mitraCd": "ALMA",
    "tXid": "TESTIDTEST03201803011108471311",
    "description": "Payment of referenceNo 99997,This Description",
    "resultMsg": "SUCCESS",
    "billingNm": "Thomas Alfa Edison",
    "payNo": "011108471311",
    "payValidTm": "235959",
    "payMethod": "03",
    "callbackUrl": "http://www.merchant.com/callbackUrl",
    "payValidDt": "20180308",
    "currency": "IDR",
    "transDt": "20180301"
}
{
    "resultCd": "0000",
    "amount": "10000",
    "goodsNm": "Test Transaction Nicepay",
    "referenceNo": "99997",
    "transTm": "110847",
    "mitraCd": "ALMA",
    "tXid": "TESTIDTEST03201803011108471311",
    "description": "Payment of referenceNo 99997,This Description",
    "resultMsg": "SUCCESS",
    "billingNm": "Thomas Alfa Edison",
    "payNo": "011108471311",
    "payValidTm": "235959",
    "payMethod": "03",
    "callbackUrl": "http://www.merchant.com/callbackUrl",
    "payValidDt": "20180308",
    "currency": "IDR",
    "transDt": "20180301"
}
﻿

Parameter
Tipe
Ukuran
Deksripsi
Contoh / Catatan
resultCd
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
﻿Result Message﻿﻿
10000
goodsNm
AN
100
Goods Name
Test Transaction Nicepay
tXid
AN
30
Transaction ID
TESTIDTEST03201803011108471311
referenceNo
ANS
40
﻿
﻿ Order Number
99997
payMethod
N
2
﻿Payment Method﻿﻿
03
amount
N
12
﻿
﻿ Amount
10000
transDt
N
8
Transaction Date (YYYYMMDD)
20180301
transTm
N
6
Transction Time (HH24MISS)
110847
mitraCd
A
4
﻿Mitra Code﻿﻿
ALMA
payNo
N
12
CVS 
﻿ Number

011108471311
﻿

Bank Indonesia telah menerbitkan Standar API terkait Pembayaran yang tercantum dalam Peraturan Anggota Dewan Gubernur No 23/15/PADG/2021 tentang Implementasi Standar Nasional Open Application Interface Pembayaran (SNAP).

Sebagai bentuk dukungan dan kepatuhan terhadap Peraturan Bank Indonesia, NICEPAY mendorong seluruh merchant untuk melakukan migrasi ke API SNAP BI.

Seluruh Merchant ditargetkan untuk dapat menyelesaikan migrasi API SNAP BI pada Juni 2024.

API Endpoint	/nicepay/api/onePass.do
Request Method application/x-www-form-urlencoded	POST
Description	Request payNo untuk melakukan CVS di
Merchant Token	SHA256(iMid+referenceNo+amt+merchantKey)
Payment Method	03 Convenience Store

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method	03
currency Required	A	3	Currency	IDR
amt Required	N	12	Goods Amount	1000
referenceNo Required	ANS	40	Order No.	MerchantReferenceNumber001
goodsNm Required	AN	100	Goods Name	Merchant Goods 1
billingNm Required	A	A	Billing Name	John Doe
billingPhone Required	N	15	Billing Phone Number	081234567890
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	12345
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	6cfccfc0046773c1b589d8e98f8b596c284f3c70a4ecf86eba14c18944b74bcd
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	ALMA
billingAddr	AN	255	Billing Address	Jln Cendrawasih
deliveryNm	A	30	Delivery Name	John Doe
deliveryPhone	N	15	Delivery Phone	081234567890
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	Vat	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
payValidDt	N	8	CVS Expiry date (YYYYMMDD)	20160303
payValidTm	N	6	CVS Expiry time (HH24MISS)	135959

Convenience Store (CVS) - V1 Enterprise

Convenience Store

Supported CVS by NICEPAY:

CVS Flow V1

CVS Registration

API Specifications - CVS Registration

Request Parameter - CVS Registration

Response Parameter - CVS Registration

Selamat Datang di NICEPAY DOCS