NICEPAY API
...
Checkout API
Registration - API Checkout

QRIS - API Checkout

15min

Tentang QRIS - API Checkout



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



Alur Proses


Alur Proses QRIS
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
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
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 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 Checkout Transaction Payment



API url

/nicepay/redirect/v2/payment

Request Method

Redirect-GET

Header

Content-Type: application/Form-UrlEncoded



Request Parameters for Payment



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



Response Parameters (CallbackUrl) - Payment



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 Number 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

Mitra Code

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.



Sample Parameter for CallbackUrl API Checkout Payment



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

Url Request




CallBack Handling API Checkout 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
Alur CallBack Handling

Response CallBack
Url Callback