Copy page

QR Code Dinamis

QR Code Dinamis adalah alur pembayaran QRIS Brick untuk membuat kode QR satu kali dengan jumlah yang telah ditentukan. Gunakan QR Code Dinamis ketika setiap pembayaran QRIS harus dipetakan ke pesanan, faktur, pembayaran, atau referensi transaksi tertentu.

Sebelum menggunakan Dynamic QR Code, buat dan verifikasi pedagang QR Code. Lihat Registering for QR Code, lalu ikuti proses integrasi di bawah ini.

Panduan Integrasi

1. Menghasilkan kode QR dinamis

Untuk mulai membuat kode QR Dinamis, Anda dapat menggunakan QR Dinamis API dengan detail berikut:

Code
curl --location 'https://sandbox.onebrick.io/v2/payments/gs/qris/dynamic' \
--header 'publicAccessToken: Bearer {{publicAccessToken}}' \
--header 'Content-Type: application/json' \
--data '{
    "referenceId":"test-qris-sandbox",
    "amount":10000,
    "validityPeriod":"86400"
}'

Anda akan mendapatkan respon seperti di bawah ini jika berhasil:

Code
{
    "status": 200,
    "data": {
        "message": "We have successfully generated the dynamic qris",
        "id":"QR_XXXX",
        "referenceId": "test-qris-sandbox",
        "amount": 10000,
        "createdAt": "2024-01-16T17:00:00.000+07:00",
        "expiredAt": "2024-01-17T17:00:00.000+07:00",
        "qrData": "XXXX"
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

2. Pemberitahuan Panggilan Balik

Brick memberi tahu Anda ketika pengguna telah melakukan pembayaran melalui panggilan balik.

Panggilan balik akan diterima setelah pembayaran dilakukan oleh pengguna akhir.

Code
{
  "data": {
    "id": "QR_XXXX",
    "referenceId": "XXXX",
    "amount": 11000,
    "status": "PAID",
    "createdAt": "2024-03-13T16:58:37.000+07:00",
    "paidAt": "2024-03-13T23:58:58.000+07:00",
    "qrisType": "DYNAMIC",
    "merchant": "merchant_name",
    "merchantNmid": "merchant_Nmid"
  }
}

📘 Menyiapkan URL panggilan balik QR Code Anda

Untuk saat ini pengaturan callback QR Code perlu dilakukan secara manual. Anda dapat menghubungi tim Brick untuk menyiapkan URL panggilan balik QR Code Anda.

3. Pemeriksaan Status Kode QR

Gunakan titik akhir status untuk mengambil status Dinamis QR Code terbaru dengan meneruskan transaksi referenceId.

Code
curl --location 'https://sandbox.onebrick.io/v2/payments/gs/qris/dynamic/{{referenceId}}' \
--header 'publicAccessToken: Bearer {{publicAccessToken}}'

Anda akan mendapatkan respon seperti di bawah ini

Code
{
    "status": 200,
    "data": {
        "referenceId": "XXXX",
        "id": "QR_XXXX",
        "amount": 10000,
        "status": "completed",
        "qrData": "XXXX",
        "paidAt": "2024-03-09T00:53:07.000+07:00",
        "type": "DYNAMIC",
        "merchant": "merchant_name",
        "merchantNmid": "merchant_Nmid"
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

Status QR Code yang tersedia adalah diproses, dibayar, kadaluwarsa, dan dibatalkan.

4. Batalkan Kode QR

Gunakan titik akhir ini untuk membatalkan QR Code Dinamis sehingga tidak dapat digunakan lagi.

Code
curl --location --request POST 'https://sandbox.onebrick.io/v2/payments/gs/qris/dynamic/{{referenceId}}/cancel' \
--header 'publicAccessToken: Bearer {{publicAccessToken}}'

Anda akan mendapatkan respon seperti di bawah ini.

Code
{
    "status": 200,
    "data": {
        "message": "We have successfully cancel the qris",
        "id": "QR_XXXX",
        "referenceId": "test-qris-sandbox",
        "cancelledAt": "2024-01-20T17:00:00.000+07:00",
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}