API - Generate Invoice QRIS Payment

Definisi

API ini digunakan untuk menampilkan Nominal Transaksi QRIS pada aplikasi Anda agar dapat digunakan oleh pengguna aplikasi untuk membayar/scan transaksi menggunakan metode QRIS.

Nominal Transaksi berupa Total Transaksi yang akan dibayar dan harus ditentukan dari aplikasi Anda.

Aplikasi Anda akan mendapatkan Konten QRIS (qris_content) yang dapat dimanfaatkan untuk menampilkan QR Code sesuai dengan library yang digunakan pada Bahasa Pemrograman yang Anda gunakan.

Disarankan untuk menyimpan Konten QRIS (qris_content), tanggal generate (qris_request_date) dan Invoice ID (qris_invoiceid) ke database Anda yang nanti dapat dimanfaatkan untuk menampilkan ulang sebelum Konten teks QRIS tersebut Expired dan Invoice ID (qris_invoiceid) dapat digunakan untuk memeriksa status pembayaran QRIS.

Batas waktu kadaluarsa (expired) 30 menit semenjak QRIS ditampilkan. Saat Expired maka QRIS akan gagal saat di-scan oleh pengguna.

Nominal Transaksi yang dapat digunakan untuk scan QRIS berbeda-beda minimal dan maksimalnya.

  • GOPAY minimal Rp.1
  • DANA minimal Rp.1
  • ShopeePay minimal Rp.1
  • LinkAja minimal Rp.100
  • OVO minimal Rp.1000

Maksimal jumlah transaksi biasanya adalah Rp 2.000.000 atau juga bisa lebih tergantung dari Jenis Akun pengguna disetiap aplikasi e-wallet.

Request Type

    GET
GET URL

    https://qris.id/restapi/qris/show_qris.php
GET Parameters
Variable Tipe Nilai contoh required Deskripsi
do string create-invoice required Harus bernilai create-invoice
apikey string a789789 required APIKEY diperoleh dari email aktivasi APIKEY
mID integer 123456 required mID diperoleh dari email aktivasi APIKEY
cliTrxNumber string PJ0099 required Nomor Nota Transaksi QRIS dari aplikasi Anda
cliTrxAmount integer 10000 required Nilai Transaksi QRIS dari aplikasi Anda yang akan dibayarkan Customer (Nilai Akhir sesudah diskon atau pajak atau biaya lainnya)
success Responses example in json

    {
        "status": "success",
        "data": {
            "qris_content": "00020101021226680016ID.CO.TELKOM.WWW011893600898025599662702150001952559966270303UMI51440014ID.CO.QRIS.WWW0215ID10200211817450303UMI520457325303360540825578.005502015802ID5916InterActive Corp6013KOTA SURABAYA61056013662130509413255111630439B7",
            "qris_request_date": "2020-08-07 11:13:42",
            "qris_invoiceid": "413255111",
            "qris_nmid": "ID1020021181745"
        }
    }

Dalam Response diatas Anda akan mendapatkan Response Konten QRIS (qris_content) yang dapat dimanfaatkan untuk menampilkan QR Code sesuai dengan library yang digunakan pada Bahasa Pemrograman yang Anda gunakan.

Invoice ID (qris_invoiceid) adalah Nomor Transaksi QRIS yang berupa integer yang dapat digunakan untuk memeriksa status pembayaran QRIS.

QRIS NMID (qris_nmid) adalah National Merchant ID untuk QRIS harus ditampilkan dibawah QR pada layar atau cetakan QRIS jika menggunakan aplikasi / software / web. Contoh Format yang disarankan sesuai ketentuan sebagai berikut :

Batas waktu kadaluarsa (expired) 30 menit (dalam WIB atau GMT+7) semenjak QRIS ditampilkan, Anda dapat memanfaatkan (qris_request_date) untuk acuan menghitung expired. Saat Expired maka QRIS akan gagal saat di-scan oleh pengguna.

failed Responses example in json

    {
        "status": "failed",
        "data": {
            "qris_status": "invalid amount / invalid APIKEY / invalid mID / transcation number is empty / mandatory parameter is not valid / what we do for you?"
        }
    }