QRIS - API Checkout
API ini digunakan oleh Merchant untuk melakukan pengajuan pembayaran QRIS kepada NICEPAY.
![Alur Proses QRIS Alur Proses QRIS](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/_wtkHu0TMt0wTFc0TglEl_nicepay-archbee-payment-qris-redirect-v2.png?format=webp)
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.
![Secure Payment Page Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/k216FJEeCwfXNa6XQA2vq_id-new-secure-payment-page-gpn.png?format=webp)
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 QRIS - Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/v2ipNRAfrwSLcrRX4N_Cc_id-new-qris-secure-payment-page-.png?format=webp)
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 QR Image.
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 url | /nicepay/redirect/v2/payment |
Request Method | Redirect-GET |
Header | Content-Type: application/Form-UrlEncoded |
Berikut adalah daftar Request Parameter untuk API Payment QRIS pada Checkout API.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
paymentURL Required | URL | 14 | Payment URL | |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST00202103191252519205 |
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
resultCd | N | 4 | 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 No With Masking | 420192******2327
When success – Only CC |
acquBankCd | A | - | BMRI When success – Only CC | |
issuBankCd | A | - | 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 | OVOE When success Direct Debit, E-Wallet, Payloan | |
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, Payloan |
goodsNm | AN | 100 | Goods name | Testing Transaction Nicepay When success – E-wallet, Payloan |
billingNm | A | 100 | Billing Name | IONPAY NETWORK TESTING When success – E-wallet, Payloan |
payMethod | N | 2 | 03 When success – E-wallet, Payloan |
Catatan: Response parameter akan dikirimkan melalui callBackurl dengan Content-type: application/x-www-form-urlencoded dan metode: POST Parameter.
Pada pembayaran saat Checkout, response dari request yang di-hit adalah Callback URL.
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 Alur CallBack Handling](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/OUMptNJjJPMmefkBqRpQS_nicepay-api-checkout-api-callback-handling-flow-1.png?format=webp)