QRIS - API Checkout

16 min

Tentang QRIS - API Checkout

API ini digunakan oleh Merchant untuk melakukan pengajuan pembayaran QRIS kepada NICEPAY.

Alur Proses

Alur Proses QRIS

Deskripsi langkah:

Pelanggan melakukan checkout.

Pelanggan mengirimkan data checkout kepada Merchant .

Merchant mengirim pengajuan checkout menggunakan API Registration kepada NICEPAY.

NICEPAY melakukan proses pendaftaran checkout.

NICEPAY mengalihkan Merchant menuju halaman pembayaran NICEPAY.

Merchant menampilkan halaman NICEPAY kepada Pelanggan.

Pelanggan memilih metode pembayaran.

Pelanggan memindai QR dan mengirim hasil proses kepada Mitra QRIS.

Mitra QRIS melakukan proses pembayaran.

Mitra QRIS mengirimkan hasil transaksi payment note kepada Pelanggan.

Mitra QRIS mengirimkan notifikasi atau pesan pembayaran kepada NICEPAY

NICEPAY memperbaharui status pembayaran.

NICEPAY mengirimkan notifikasi dbProcessUrl kepada Merchant.

Merchant menerima notifikasi.

Merchant mengajukan status inquiry kepada NICEPAY.

NICEPAY menerima pengajuan.

NICEPAY mengirim response status inquiry kepada Merchant.

Merchant menerima status akhir.

Merchant mengirimkan halaman hasil transaksi kepada Pelanggan.

NICEPAY Secure Payment Page

Secure Payment Page

Gambar di atas adalah contoh pembayaran Checkout dengan metode QRIS menggunakan NICEPAY Secure Payment Page.

Pelanggan tidak dapat kembali ke halaman Secure Payment setelah memilih metode pembayaran QRIS karena kode QR transaksi sudah berhasil dibuat dan transaksi sudah berjalan.

Apabila ingin memilih metode pembayaran lain, maka Merchant wajib membuat ulang transaksi dari awal.

QRIS - Secure Payment Page

Setelah pilih metode dengan QRIS, kode QR akan muncul pada halaman berikutnya. Pelanggan dapat langsung memindai kode tersebut dengan mengikuti panduan Panduan Bayar QRIS atau mengunduh gambar terlebih dahulu melalui tombol Download Gambar QR.

Success - Secure Payment

Apabila kode QR belum berhasil dipakai untuk transaksi, akan tetapi sudah lebih dahulu kedaluwarsa, maka Pelanggan harus mengulang proses generate kode QR dengan kembali menuju halaman checkout terlebih dahulu.

API Checkout Transaction Payment

API url	/nicepay/redirect/v2/payment
Request Method	Redirect-GET
Header	Content-Type: application/Form-UrlEncoded

Request Parameter for QRIS - API Checkout (CallbackUrl)

Berikut adalah daftar Request Parameter untuk API Payment QRIS pada Checkout API.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
paymentURL Required	URL	14	Payment URL	https://www.nicepay.co.id/nicepay/redirect/v2/payment
tXid Required	AN	30	Transaction ID	IONPAYTEST00202103191252519205

Response Parameter for QRIS - API Checkout (CallbackUrl)

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 (Key from NICEPAY)	TESTTEST0300202008070951284276 When success
referenceNo	ANS	40	Order Number	ord20200807090809 When success
amount	N	12	Transaction Amount	1000 When success
transDt	N	8	Registration Date (YYYYMMDD)	20200808 When success
transTm	N	6	Registration Time (HH24MISS)	120000 When success
description	AN	100	Transaction Description	This is Testing Transaction When success
authNo	N	10	Approval Number	1234567890 When success – Only CC (Additional)
recurringToken	AN	255	Recurring Token	5b949971aea6d468bebef20fec7b067abde88e52a4520925cd28dfa840ce5abc When success – Only CC (Additional)
cardNo	ANS	20	Card Number with Masking	420192******2327 When success – Only CC
acquBankCd	A	-	Acquiring Bank Code	BMRI When success – Only CC
issuBankCd	A	-	Issuing Bank Code	OTHR When success – Only CC
vat	N	12	VAT Number	0 When success , CC
fee	N	12	Service Fee	0 When success , CC
notaxAmt	N	12	Tax-Free Amount	0 When success , CC
bankCd	A	4	Bank Code	BMRI
mitraCd	A	4	Mitra Code	OVOE When success Direct Debit, E-Wallet, Paylater
bankVacctNo	N	20	VA Number	447770956314286 When success – VA
payNo	N	20	Payment Number	9041071059504308 When success – CVS
currency	A	3	Currency	IDR When success – E-Wallet, Paylater
goodsNm	AN	100	Goods name	Testing Transaction NICEPAY When success – E-Wallet, Paylater
billingNm	A	100	Billing Name	IONPAY NETWORK TESTING When success – E-Wallet, Paylater
payMethod	N	2	Payment Method Code	03 When success – E-Wallet, Paylater

Catatan: Response parameter akan dikirimkan melalui callBackurl dengan Content-type: application/x-www-form-urlencoded dan metode: POST Parameter.

Sample Parameter for QRIS - API Checkout (CallbackUrl)

Pada pembayaran saat Checkout, response dari request yang di-hit adalah Callback URL.

Request Parameter

curl -X GET "https://www.merchant.com/callbackUrl?ccTransType=1&fee=0&tXid=IONPAYTEST00202212201540174369&amt=1000&notaxAmt=0&cardNo=46161111****1111&issuBankCd=BMRI&matchCl=1&preauthToken=null&cardExpYymm=2603&acquBankNm=Mandiri&payMethod=01&currency=IDR&instmntMon=1&cc_trans_type=1&issuBankNm=Mandiri&merchantToken=dc1dd9e57ff6c4db341654ae31e623cab4d4d8057b2d0b58bef43ccb0da3b494&goodsNm=Goods+For+Testing+Credit+Card&referenceNo=ordNo20221220151243&authNo=174300&transTm=154017&cpGuaranteeableStatus=null&recurringToken=null&vat=0&instmntType=1&billingNm=John+Doe&acquBankCd=BMRI&transDt=20221220&status=0"

Callback Parameter

resultCd=0000
resultMsg=SUCCESS
tXid=IONPAYTEST00202212211103524783
referenceNo=ORDERKU345
payMethod=09
amt=12000
billingNm=John+Doe
authNo=150367
cardNo=62210082****0590
acquBankCd=ARTJ
issuBankCd=ARTJ
acquBankNm=Artajasa
issuBankNm=Artajasa

Callback Handling API Checkout Transaction Payment

Saat Callback diterima callbackUrl Anda, kami merekomendasikan Merchant untuk melakukan verifikasi Status dengan menggunakan Status Inquiry - API Checkout.

Callback Handling sangat penting untuk membantu meminimalisir tindakan Fraud. Kami sangat merekomendasikan Merchant untuk melakukan verifikasi menggunakan Callback parameter.

Alur Callback Handling

https://merchant.com/callback-nicepay?resultCd=0000&resultMsg=SUCCESS&tXid=IONPAYTEST00202212211103524783&referenceNo=ORDERKU345&payMethod=09&amt=12000&billingNm=John+Doe&authNo=150367&cardNo=62210082****0590&acquBankCd=ARTJ&issuBankCd=ARTJ&acquBankNm=Artajasa&issuBankNm=Artajasa