QR Code Reader API

Read the QR code in a PNG or JPEG image; VietQR payment codes are decoded into bank, account number, amount and transfer note.

Parameters

Example

curl -X POST "https://apibox.io.vn/v1/qr-decode" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "0=@./my-file"

const form = new FormData();
form.append('0', fileInput.files[0]);

const res = await fetch('https://apibox.io.vn/v1/qr-decode', {
  method: 'POST',
  headers: { Authorization: 'Bearer YOUR_API_KEY' },
  body: form,
});
console.log(await res.json());

import requests

res = requests.post(
    "https://apibox.io.vn/v1/qr-decode",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    files={"0": open("my-file", "rb")},
    timeout=30,
)
print(res.json())

<?php
$ch = curl_init('https://apibox.io.vn/v1/qr-decode');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
    CURLOPT_POSTFIELDS => ['0' => new CURLFile('my-file')],
]);
$response = curl_exec($ch);
print_r(json_decode($response, true));

Response

{
  "found": true,
  "data": "00020101021238540010A00000072701240006970436011001234567890208QRIBFTTA530370454061500005802VN62260822Thanh toan don ABX12346304FFCC",
  "type": "vietqr",
  "version": 5,
  "image": {
    "format": "png",
    "width": 360,
    "height": 360
  },
  "vietqr": {
    "valid": true,
    "crc_valid": true,
    "bank": {
      "code": "VCB",
      "bin": "970436",
      "short_name": "Vietcombank",
      "name": "Ngân hàng TMCP Ngoại thương Việt Nam"
    },
    "account": "0123456789",
    "amount": 150000,
    "content": "Thanh toan don ABX1234",
    "…": "…"
  }
}

Use cases

• Read VietQR codes uploaded by merchants and check the bank details
• Import Wi-Fi or contact QR codes into apps
• Moderate images that contain QR codes (links)
• Test generated QR codes in CI

FAQ

Related APIs