API - Check Invoice QRIS Payment

Definisi

API ini digunakan untuk memeriksa status QRIS Dinamis yang telah di-scan/dipindai/dibayarkan oleh pengguna menggunakan metode QRIS.

Aplikasi Anda harus mengirimkan Invoice ID sebagai salah satu parameter.

Response status sukses atau gagal didapat saat Aplikasi Anda melakukan request ke server kami (dalam keadaan traffic normal proses mendapatkan response membutuhkan waktu antara 6 hingga 30 detik).

Ketentuan

Penggunaan API ini disarankan menggunakan tombol yang ditekan oleh pengguna aplikasi (TIDAK DIIZINKAN melakukan auto check status secara terus menerus dalam waktu yang dekat, karena beresiko APIKEY Anda akan terblokir dan tidak dapat digunakan).

Gunakan timeout 15 detik untuk mendapatkan response, lakukan selama 3 kali (3 kali per 15 detik) jika status dari response masih "failed".

atau Anda juga dapat menggunakan CronJob 1 menit sekali (per 60 detik) untuk mendapatkan response, lakukan maksimal 30 kali (30 menit) jika status dari inv-id tersebut masih "failed".

Jika 3-30 kali Response status pengecekan masih terus failed, maka dapat dimunculkan form untuk upload bukti pembayaran atau tombol bantuan ke CS software Anda dengan menyertakan bukti pembayaran sukses pada detail transaksi (tanggal, jam, nominal, nomor transaksi) dari aplikasi e-wallet / bank yang digunakan si pembayar yang menunjukkan sukses tersebut.
Note : Jangan lupa untuk mencatat juga nomor telpon si pembayar tadi untuk jaga-jaga jika pembayaran terjadi refund ke akun si pembayar;
Bukti pembayaran tersebut dapat dikirimkan (pada hari dan jam kerja) ke tim CS kami untuk dapat dilakukan pengecekan dan klaim

Request Type

    GET
    
GET URL

    https://qris.online/restapi/qris/checkpaid_qris.php
    
GET Parameters
Variable Tipe Nilai contoh required Deskripsi
do string checkStatus required Harus bernilai checkStatus
apikey string a789789 required APIKEY diperoleh dari email aktivasi APIKEY
mID integer 123456 required mID diperoleh dari email aktivasi APIKEY
invid integer 9 required Adalah nilai dari qris_invoiceid hasil dari response Create Invoice
trxvalue integer 10000 required Nilai Transaksi QRIS dari aplikasi Anda yang akan dibayarkan Customer (Nilai Akhir sesudah diskon atau pajak atau biaya lainnya)
trxdate date format :
YYYY-mm-dd
2020-12-31 required Tanggal Pembayaran scan QRIS
success Responses example in json

    {
        "status": "success",
        "data": {
            "qris_status": "paid",
            "qris_payment_customername": "Zainal Arief",
            "qris_payment_methodby": "Sakuku"
        },
        "qris_api_version_code": "2206091709"
    }
    
failed Responses example in json

    {
        "status": "failed",
        "data": {
            "qris_status": "unpaid"
        }
    }