--- title: QRIS - API Checkout slug: nicepay-api-qris-payment-api-checkout description: Informasi tentang API Checkout - Payment untuk metode pembayaran QRIS yang disediakan oleh NICEPAY image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/9gpDMHgfOg8JnO_oESNmJ_microsoftteams-image.png icon: {"faIcon":"fa-solid fa-credit-card"} docTags: createdAt: 2022-12-19T10:11:50.000Z --- # Tentang QRIS - API Checkout *** API ini digunakan oleh Merchant untuk melakukan pengajuan pembayaran QRIS kepada NICEPAY. # Alur Proses *** ![Alur Proses QRIS](https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/_wtkHu0TMt0wTFc0TglEl_nicepay-archbee-payment-qris-redirect-v2.png "Alur Proses QRIS") Deskripsi langkah: 1. Pelanggan melakukan *checkout.* 2. Pelanggan mengirimkan data checkout kepada Merchant . 3. Merchant mengirim pengajuan *checkout *menggunakan API Registration kepada NICEPAY. 4. NICEPAY melakukan proses pendaftaran *checkout*. 5. NICEPAY mengalihkan Merchant menuju halaman pembayaran NICEPAY. 6. Merchant menampilkan halaman NICEPAY kepada Pelanggan. 7. Pelanggan memilih metode pembayaran. 8. Pelanggan memindai QR dan mengirim hasil proses kepada Mitra QRIS. 9. Mitra QRIS melakukan proses pembayaran. 10. Mitra QRIS mengirimkan hasil transaksi *payment note *kepada Pelanggan. 11. Mitra QRIS mengirimkan notifikasi atau pesan pembayaran kepada NICEPAY 12. NICEPAY memperbaharui status pembayaran. 13. NICEPAY mengirimkan notifikasi `dbProcessUrl` kepada Merchant. 14. Merchant menerima notifikasi. 15. Merchant mengajukan status inquiry kepada NICEPAY. 16. NICEPAY menerima pengajuan. 17. NICEPAY mengirim *response *status inquiry kepada Merchant. 18. Merchant menerima status akhir. 19. Merchant mengirimkan halaman hasil transaksi kepada Pelanggan. # NICEPAY Secure Payment Page *** ![Secure Payment Page](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/ohh_r6otn4iPQSs_4RfL1_image-id-nicepay-secure-payment-page-main-dashboard.jpg "Secure Payment Page") Gambar di atas adalah contoh pembayaran *Checkout *dengan metode QRIS menggunakan NICEPAY Secure Payment Page. :::hint{type="warning"} 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](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/HUJ4NCKTWLW0MPqQzgPme_image-id-qris-secure-payment-page.jpg "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](docId\:og8vGEkiCoG9mupWHrrJ0) atau mengunduh gambar terlebih dahulu melalui tombol `Download Gambar QR`. ![Success - Secure Payment ](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/Fw_8zMbhp1O8Rzd-IL7mC_image-id-qris-success-secure-payment-page.jpg "Success - Secure Payment ") :::hint{type="warning"} 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](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](docId\:gvAdBBr0SQ92N1zHplSFM) | 0000 | | `resultMsg` | AN | 255 | Result Message: [Error Code](docId\:yEh1VA9k2y6sL1kQF2aWD) | 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](docId:1U7QOax_wrzXMoCG-Mqad) | BMRI

When success – Only CC | | `issuBankCd` | A | - | [Issuing Bank Code](docId:1U7QOax_wrzXMoCG-Mqad) | 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](docId:1U7QOax_wrzXMoCG-Mqad) | BMRI | | `mitraCd` | A | 4 | [Mitra Code](docId\:DwzaQDD7DXZMECz80A6o8) | 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](docId\:g7inRV70XcSA9lP7bpmok) | 03

When success – E-Wallet, Paylater | :::hint{type="info"} 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) *** :::hint{type="success"} Pada pembayaran saat *Checkout*, *response* dari *request* yang di-*hit* adalah Callback URL. ::: ### Request Parameter :::CodeblockTabs cURL ```curl curl -X GET "https://www.merchant.com/callbackUrl?ccTransType=1&fee=0&tXid=IONPAYTEST00202212201540174369&amt=1000¬axAmt=0&cardNo=46161111****1111&issuBankCd=BMRI&matchCl=1&preauthToken=null&cardExpYymm=2603&acquBankNm=Mandiri&payMethod=01¤cy=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 :::CodeblockTabs Response Callback ```curl 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 *** :::hint{type="success"} Saat *Callback *diterima `callbackUrl` Anda, kami merekomendasikan Merchant untuk melakukan verifikasi Status dengan menggunakan [Status Inquiry - API Checkout](docId\:K9vBS87ev9_w5oJAU0et3). ::: :::hint{type="warning"} `Callback Handling` sangat penting untuk membantu meminimalisir tindakan *Fraud*. Kami sangat merekomendasikan Merchant untuk melakukan verifikasi menggunakan `Callback parameter`. ::: ::Image[]{src="https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/OUMptNJjJPMmefkBqRpQS_nicepay-api-checkout-api-callback-handling-flow-1.png" size="50" width="370" height="361" position="center" caption="Alur Callback Handling" alt="Alur Callback Handling" showCaption="true"} :::CodeblockTabs URL Callback ```none 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 ``` Response Callback ```json 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 ``` :::