Registration - API QRIS
Pada metode pembayaran QRIS, Merchant dapat menggunakan kode QR yang sama untuk pembayaran berulang oleh Pelanggan. Kode QR juga dapat digunakan oleh metode pembayaran lintas channel, seperti penerbitan kode QR oleh NICEPAY bekerja sama dengan ShopeePay.
Pelanggan dapat menggunakan aplikasi E-Wallet lain (OVO, Gopay, dan DANA) atau mobile banking selain ShopeePay untuk melakukan pembayaran dengan kode QR. Notifikasi real-time akan dikirimkan setelah Pelanggan menyelesaikan pembayaran.
Kode QR disarankan menggunakan background putih agar mudah dipindai.
Silakan kunjungi bagian QRIS untuk mempelajari informasi umum mengenai metode pembayaran QRIS.
API Registrasi QRIS bertujuan supaya Merchant dapat mendaftarkan sistem API pada sisi Merchant agar terintegrasi dengan sistem dari NICEPAY. Tahapan ini dilakukan pertama kali untuk melakukan pemeriksaan apakah Merchant sudah terdaftar secara resmi dan bisa terhubung dengan metode pembayaran QRIS pada sistem NICEPAY.
API URL | /nicepay/direct/v2/registration |
Request Method | POST |
Description | QRIS payment API |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
Request Format | application/x-www-form-urlencoded |
Berikut ini adalah daftar parameter untuk melakukan request registrasi metode pembayaran QRIS. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20230423100505 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 08 | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount | 5 |
referenceNo Required | ANS | 40 | Merchant's Ref. No. | ORD54321 |
goodsNm Required | AN | 100 | Goods Name | Test Transaction Nicepay |
billingNm Required | A | 100 | Buyer Name | Andi pamungkas |
billingPhone Required | N | 15 | Buyer Phone No. | 081234567890 |
billingEmail Required | ANS | 40 | Buyer E-mail | |
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 |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) | |
paymentExpTm | N | N | QR Payment 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 | 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 | Merchant Token | 14b2d810fd2c2725bde0e747392bdd6353b5dcfd3807ccc7a0b5106bdd4af099 |
userIP | AN | 15 | User IP address | 127.0.0.1 |
shopId Required for QRIS | AN | 32 | Shop ID | NICEPAY |
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
mitraCd Required | A | 4 | QSHP | |
shopId Required | N | 12 | Shop ID | NICEPAY |
paymenExpDt | N | 6 | QR Expiry | QR Payment Expiry Date (YYYYMMDD) |
paymenExpTm | N | 6 | QR Expiry | QR Payment Expiry Time (HH24MISS) |
Parameter paymenExpDt dan paymenExpTm dapat di-set pada sisi Merchant dengan lama waktu 5 - 20 menit.
Berikut adalah response parameter dari hasil request parameter untuk mendaftarkan metode pembayaran QRIS.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST08202212071126251707 |
referenceNo | ANS | 40 | Merchant Ref. No. | ORD54321 |
payMethod | N | 2 | 08 | |
amt | N | 12 | Payment 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 | null | |
vacctNo | N | 20 | VA Number | null |
currency | A | 3 | Currency | IDR |
goodsNm | AN | 100 | Goods Name | Test Transaction Nicepay |
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 | 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 Payment Expiry Date (YYYYMMDD) | 20221207 |
paymentExpTm | N | 6 | QR Payment 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 Payment Expiry Date (YYYYMMDD) |
paymenExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) |
shopId | AN | 32 | Shop ID |
paymenExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) |
cancelTrxSn | AN | 32 | Cancel Transaction Number |
userId | AN | 128 | QRIS User ID Hash |
CartData pada Registrasi QRIS berguna untuk mendeklarasikan item yang akan melalui proses checkout beserta rincian dan harga per item.
Parameter | Deskripsi | Contoh / Catatan |
Count | Total jumlah dari keseluruhan cart data | 2 |
Item | Terbagi menjadi 4 macam parameter, yaitu img_url, goods_name, goods_detail, dan goods_amt | - |
Penjelasan rincian pada parameter 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 |