Registration - API QRIS

15min

Tentang API for QRIS Registration  
﻿
Pada  ,  dapat menggunakan kode QR  sama untuk  berulang oleh . Kode QR juga dapat digunakan oleh  lintas channel, seperti penerbitan kode QR oleh  bekerja sama dengan ShopeePay. 
﻿ dapat menggunakan aplikasi  lain (OVO, Gopay, dan DANA) atau mobile banking selain ShopeePay untuk melakukan  dengan kode QR. Notifikasi real-time akan dikirimkan setelah  menyelesaikan .
Kode QR disarankan menggunakan background putih agar mudah dipindai.
﻿ kunjungi  QRIS﻿ untuk mempelajari  umum mengenai  . 
﻿
API for QRIS Registration   
﻿
﻿ Registrasi  bertujuan supaya  dapat mendaftarkan   pada sisi  agar ter dengan  dari . Tahapan ini dilakukan pertama kali untuk melakukan pemeriksaan apakah  sudah terdaftar secara resmi dan bisa terhubung dengan   pada  .
API URL
/nicepay/direct/v2/registration
Request Method 
﻿POST﻿
Description
﻿  
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/x-www-form-urlencoded
﻿
Request Parameter for QRIS Registration   
﻿
Berikut ini adalah daftar  untuk melakukan request registrasi  . Parameter ini digunakan melalui platform pengujian  sebagai salah satu tahapan supaya  milik  dapat terhubung dengan  dari .  
Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
timeStamp
﻿Required﻿
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20230423100505
iMid
﻿Required﻿
AN
10
﻿ ID	
﻿
IONPAYTEST
payMethod
﻿Required﻿
N
2
﻿Payment Method Code﻿ 
﻿
08
currency
﻿Required﻿
A
3
Currency
﻿
IDR
amt 
﻿Required﻿
N
12
Amount
﻿
5
referenceNo
﻿Required﻿
ANS
40
﻿'s Reference Number
﻿
ORD54321
goodsNm 
﻿Required﻿ ﻿
AN
100
Goods Name	
﻿
Test Transaction 
billingNm 
﻿Required﻿
A
100
Buyer Name	
﻿
Andi Pamungkas
billingPhone
﻿Required﻿
N
15
Buyer Phone Number
﻿
081234567890
billingEmail
﻿Required﻿
ANS
40
Buyer E-Mail	
﻿
[email protected]
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	
﻿
﻿ 
paymentExpDt
N
6
QR  Expiry Date (YYYYMMDD)	
﻿
paymentExpTm
N
N
QR  Expiry Time (HH24MISS)	
﻿
cartData 
JSONstring

4000
Cart Data
﻿
{"count":1,"item":[{"img_url":"http:\/\/www.jamgora.com\/media\/avatar\/noimage.png","goods_name":"Hoodie","goods_detail":"Hoodie","goods_amt":"5"}]}
mitraCd
﻿Required for CVS, E-Wallet, Payloan,QRIS﻿
A
4
﻿Mitra Code﻿ 
QSHP
userIP 
﻿Required for CC, E-Wallet, Payloan,QRIS﻿
AN
15
User IP
﻿
127.0.0.1

dbProcessUrl
﻿Required﻿
ANS
255
Notification URL	
﻿
https://merchant.com/dbProcessUrl
merchantToken
﻿Required﻿
AN
255
﻿ Token	
﻿
14b2d810fd2c2725bde0e747392bdd6353b5dcfd3807ccc7a0b5106bdd4af099
userIP
AN
15
User IP Address
127.0.0.1
shopId
﻿Required for QRIS	
AN
32
Shop ID
﻿
﻿﻿
﻿
Additional Information Request for QRIS Registration 
﻿


Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
mitraCd 
﻿Required﻿
A
4
﻿Mitra Code﻿ 
QSHP
shopId 
﻿Required﻿
N
12
Shop ID
﻿
paymenExpDt
N
6
QR Expiry
QR  Expiry Date (YYYYMMDD)
paymenExpTm
N
6
QR Expiry
QR  Expiry Time (HH24MISS)
Parameter paymenExpDt dan paymenExpTm dapat di-set pada sisi  dengan lama waktu 5 - 20 menit.
﻿
Response Parameter for QRIS Registration  
﻿
Berikut adalah response parameter dari hasil request parameter untuk mendaftarkan  .
Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿ 
SUCCESS
tXid
AN
30
Transaction ID
IONPAYTEST08202212071126251707
referenceNo
ANS
40
﻿ Reference Number
ORD54321
payMethod
N
2
﻿Payment Method Code﻿ 
08
amt
N
12
﻿ Amount
5
transDt
N
8
Transaction Date (YYYYMMDD)
20230423
transTm
N
6
Transction Time (HH24MISS)
112625
description
AN
100
Transaction Description
null
bankCd
A
4
﻿Bank Code﻿
null
vacctNo
N
20
VA Number
null
currency
A
3
Currency
IDR
goodsNm
AN
100
Goods Name
Test Transaction ﻿
billingNm
A
100
Buyer Name
John Doe
vacctValidDt
N
8
VA Expiry Date (YYYYMMDD)
null
vacctValidTm
N
6
VA Expiry Time (HH24MISS)
null
payNo
N
12
Payment Number
null
mitraCd
AN
4
﻿Mitra Code﻿ 
QSHP
payValidDt
N
8
Expiry Date (YYYYMMDD)
null
payValidTm
N
6
Expiry Time (HH24MISS)
null
requestURL
ANS
360
Request URL
null
paymentExpDt
N
6
QR  Expiry Date (YYYYMMDD)
20221207
paymentExpTm
N
6
QR  Expiry Time (HH24MISS)
144135
qrContent
ANS
360
QR String in Plain Text
00020101021226590016ID.CO.SHOPEE.WWW011893600918000041566602064156660303UME52045399530336054045.005802ID5913NICEPAY dummy6015KOTA JAKARTA SE61051287062360520082022120711262558370708T00000016304740D
qrUrl
ANS
360
URL for QR Image, Valid for 5 Minutes
https://mapi.gw.airpay.co.id/v3/merchant-host/qr/download?qr=un74au2lzvWXiv9LpBQGPG21CaTMhNgP0rvBeb9V6h
﻿
Additional Response Parameters - QRIS
﻿
Parameter
Tipe
Ukuran
Deskripsi
mitraCd
A
4
﻿Mitra Code﻿﻿
cancelAmt
N
12
Cancel Amount
paymentTrxSn
AN
32
QR  Expiry Date (YYYYMMDD)
paymenExpDt
N
6
QR  Expiry Date (YYYYMMDD)
shopId
AN
32
Shop ID
paymenExpTm
N
6
QR  Expiry Time (HH24MISS)
cancelTrxSn
AN
32
Cancel Transaction Number
userId
AN
128
﻿ User ID Hash
﻿

Sample JSON for QRIS Registration
﻿
JSON Request
JSON Response
Java Request
{
    "timeStamp": "20230423100505",
    "iMid": "IONPAYTEST",
    "payMethod": "08",
    "currency": "IDR",
    "amt": "5",
    "referenceNo": "ORD54321",
    "goodsNm": "Test Transaction Nicepay",
    "billingNm": "Andi pamungkas",
    "billingPhone": "081234567890",
    "billingEmail": "[email protected]",
    "billingCity": "Jakarta",
    "billingState": "DKI Jakarta",
    "billingPostCd": "12345",
    "billingCountry":"Indonesia",
    "dbProcessUrl": "https://merchant.com/dbProcessUrl",
    "merchantToken": "14b2d810fd2c2725bde0e747392bdd6353b5dcfd3807ccc7a0b5106bdd4af099",
    "paymentExpDt" : "",
    "paymentExpTm" : "",
    "userIP":"127.0.0.1",
    "cartData":"{\"count\":1,\"item\":[{\"img_url\":\"http:\\\/\\\/www.jamgora.com\\\/media\\\/avatar\\\/noimage.png\",\"goods_name\":\"Hoodie\",\"goods_detail\":\"Hoodie\",\"goods_amt\":\"5\"}]}",
    "mitraCd":"QSHP",
    "shopId": "NICEPAY"
}
{
    "timeStamp": "20230423100505",
    "iMid": "IONPAYTEST",
    "payMethod": "08",
    "currency": "IDR",
    "amt": "5",
    "referenceNo": "ORD54321",
    "goodsNm": "Test Transaction Nicepay",
    "billingNm": "Andi pamungkas",
    "billingPhone": "081234567890",
    "billingEmail": "email@merchant.com",
    "billingCity": "Jakarta",
    "billingState": "DKI Jakarta",
    "billingPostCd": "12345",
    "billingCountry":"Indonesia",
    "dbProcessUrl": "https://merchant.com/dbProcessUrl",
    "merchantToken": "14b2d810fd2c2725bde0e747392bdd6353b5dcfd3807ccc7a0b5106bdd4af099",
    "paymentExpDt" : "",
    "paymentExpTm" : "",
    "userIP":"127.0.0.1",
    "cartData":"{\"count\":1,\"item\":[{\"img_url\":\"http:\\\/\\\/www.jamgora.com\\\/media\\\/avatar\\\/noimage.png\",\"goods_name\":\"Hoodie\",\"goods_detail\":\"Hoodie\",\"goods_amt\":\"5\"}]}",
    "mitraCd":"QSHP",
    "shopId": "NICEPAY"
}
﻿
﻿
Cart Data QRIS Registration
﻿
CartData pada Registrasi  berguna untuk mendeklarasikan item  akan melalui  checkout beserta rincian dan harga per item. 
Parameter
Deskripsi
Contoh / Catatan
Count
Total jumlah dari keseluruhan cart data
2
Item
Terbagi menjadi 4 macam , yaitu img_url, goods_name, goods_detail, dan goods_amt
-
Penjelasan rincian pada  Item.
Parameter
Deskripsi
Contoh / Catatan
img_url
URL Gambar Barang (Ukuran 50px x 50px)
htttps://www.merchant.com/image_goods1.jpg
goods_name
Nama Barang
Nama Item-1
goods_detail
Deskripsi Detail Barang
Detail Item-1
goods_amt
Harga Barang
1000
﻿
cartData QRIS 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"
        },  
        {
            "img_url": "http://www.merchant.com/image_goods2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "1000"
        }  
        ] 
}
{
    "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"
        },  
        {
            "img_url": "http://www.merchant.com/image_goods2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "1000"
        }  
        ] 
}
﻿
﻿

API URL	/nicepay/direct/v2/registration
Request Method	POST
Description
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format	application/x-www-form-urlencoded

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20230423100505
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	08
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount	5
referenceNo Required	ANS	40	's Reference Number	ORD54321
goodsNm Required	AN	100	Goods Name	Test Transaction
billingNm Required	A	100	Buyer Name	Andi Pamungkas
billingPhone Required	N	15	Buyer Phone Number	081234567890
billingEmail Required	ANS	40	Buyer E-Mail	[email protected]
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
paymentExpDt	N	6	QR Expiry Date (YYYYMMDD)
paymentExpTm	N	N	QR Expiry Time (HH24MISS)
cartData	JSONstring	4000	Cart Data	{"count":1,"item":[{"img_url":"http:\/\/www.jamgora.com\/media\/avatar\/noimage.png","goods_name":"Hoodie","goods_detail":"Hoodie","goods_amt":"5"}]}
mitraCd Required for CVS, E-Wallet, Payloan,QRIS	A	4	Mitra Code	QSHP
userIP Required for CC, E-Wallet, Payloan,QRIS	AN	15	User IP	127.0.0.1
dbProcessUrl Required	ANS	255	Notification URL	https://merchant.com/dbProcessUrl
merchantToken Required	AN	255	Token	14b2d810fd2c2725bde0e747392bdd6353b5dcfd3807ccc7a0b5106bdd4af099
userIP	AN	15	User IP Address	127.0.0.1
shopId Required for QRIS	AN	32	Shop ID

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
mitraCd Required	A	4	Mitra Code	QSHP
shopId Required	N	12	Shop ID
paymenExpDt	N	6	QR Expiry	QR Expiry Date (YYYYMMDD)
paymenExpTm	N	6	QR Expiry	QR Expiry Time (HH24MISS)

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST08202212071126251707
referenceNo	ANS	40	Reference Number	ORD54321
payMethod	N	2	Payment Method Code	08
amt	N	12	Amount	5
transDt	N	8	Transaction Date (YYYYMMDD)	20230423
transTm	N	6	Transction Time (HH24MISS)	112625
description	AN	100	Transaction Description	null
bankCd	A	4	Bank Code	null
vacctNo	N	20	VA Number	null
currency	A	3	Currency	IDR
goodsNm	AN	100	Goods Name	Test Transaction
billingNm	A	100	Buyer Name	John Doe
vacctValidDt	N	8	VA Expiry Date (YYYYMMDD)	null
vacctValidTm	N	6	VA Expiry Time (HH24MISS)	null
payNo	N	12	Payment Number	null
mitraCd	AN	4	Mitra Code	QSHP
payValidDt	N	8	Expiry Date (YYYYMMDD)	null
payValidTm	N	6	Expiry Time (HH24MISS)	null
requestURL	ANS	360	Request URL	null
paymentExpDt	N	6	QR Expiry Date (YYYYMMDD)	20221207
paymentExpTm	N	6	QR Expiry Time (HH24MISS)	144135
qrContent	ANS	360	QR String in Plain Text	00020101021226590016ID.CO.SHOPEE.WWW011893600918000041566602064156660303UME52045399530336054045.005802ID5913NICEPAY dummy6015KOTA JAKARTA SE61051287062360520082022120711262558370708T00000016304740D
qrUrl	ANS	360	URL for QR Image, Valid for 5 Minutes	https://mapi.gw.airpay.co.id/v3/merchant-host/qr/download?qr=un74au2lzvWXiv9LpBQGPG21CaTMhNgP0rvBeb9V6h

Parameter	Tipe	Ukuran	Deskripsi
mitraCd	A	4	Mitra Code
cancelAmt	N	12	Cancel Amount
paymentTrxSn	AN	32	QR Expiry Date (YYYYMMDD)
paymenExpDt	N	6	QR Expiry Date (YYYYMMDD)
shopId	AN	32	Shop ID
paymenExpTm	N	6	QR Expiry Time (HH24MISS)
cancelTrxSn	AN	32	Cancel Transaction Number
userId	AN	128	User ID Hash

Parameter	Deskripsi	Contoh / Catatan
Count	Total jumlah dari keseluruhan cart data	2
Item	Terbagi menjadi 4 macam , yaitu img_url, goods_name, goods_detail, dan goods_amt	-

Parameter	Deskripsi	Contoh / Catatan
img_url	URL Gambar Barang (Ukuran 50px x 50px)	htttps://www.merchant.com/image_goods1.jpg
goods_name	Nama Barang	Nama Item-1
goods_detail	Deskripsi Detail Barang	Detail Item-1
goods_amt	Harga Barang	1000

Updated 18 Sep 2024

Did this page help you?

API QRIS

Status Inquiry - API QRIS

Registration - API QRIS

Tentang API for QRIS Registration

API for QRIS Registration

Request Parameter for QRIS Registration

Additional Information Request for QRIS Registration

Response Parameter for QRIS Registration

Additional Response Parameters - QRIS

Sample JSON for QRIS Registration

Cart Data QRIS Registration

Selamat Datang di NICEPAY DOCS