Nhảy tới nội dung

API tạo mã QR

VietQR.IO (v2/generate)

Tạo mã QR

API này cho phép tạo mã QR dựa vào thông tin tài khoản nhận tiền

Authorizations:
(x-client-idx-api-key)
header Parameters
x-client-id
required
string

Client Id để chứng thực. Truy cập My VietQR để lấy Client Id

x-api-key
required
string

API key để chứng thực. Truy cập My VietQR để lấy API Key

Request Body schema: application/json
accountNo
required
string [ 6 .. 19 ] characters

Số tài khoản ngân hàng thụ hưởng. Chỉ nhập số, tối thiểu 6 ký tự, tối đa 19 kí tự

accountName
string [ 5 .. 50 ] characters

Tên tài khoản ngân hàng. Nhập tiếng Việt không dấu, viết hoa, tối thiểu 5 ký tự, tối đa 50 kí tự, không chứa các ký tự đặc biệt.

acqId
required
integer

Mã định danh ngân hàng (thường gọi là BIN) 6 chữ số, quy đinh bởi ngân hàng nước

amount
integer <= 13 characters

Số tiền chuyển. Chỉ nhập số, tối đa 13 kí tự

addInfo
string <= 25 characters

Nội dung chuyển tiền. Nhập tiếng Việt không dấu, tối đa 25 ký tự. Không chứa các ký tự đặc biệt

format
string

Định dạng VietQR trả về

template
string

Mẫu VietQR trả về

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
Example

Thành công

{
}

Demo sử dụng​

curl --location --request POST 'https://api.vietqr.io/v2/generate' \
--header 'x-client-id: <CLIENT_ID_HERE>' \
--header 'x-api-key: <API_KEY_HERE>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountNo": "113366668888",
    "accountName": "QUY VAC XIN PHONG CHONG COVID",
    "acqId": "970415",
    "addInfo": "Ung Ho Quy Vac Xin",
    "amount": "79000",
    "template": "compact"
}'

Các loại định dạng trả về​

Trường template trong request body sẽ có thể chọn 1 trong các tùy chọn sau

Giá trịSizeGhi chú
compact2540x640Bao gồm : Mã QR, các logo , thông tin chuyển khoản
compact540x540QR kèm logo VietQR, Napas, ngân hàng
qr_only480x480Trả về ảnh QR đơn giản, chỉ bao gồm QR
print600x776Bao gồm : Mã QR, các logo và đầy đủ thông tin chuyển khoản
accountNoSố tài khoản
accountNameTên tài khoản
accIdMã bin được lấy từ Api bank theo từng ngân hàng
addInfoNội dung chuyển khoản

Ý nghĩa các trường trong Response​

Trường dữ liệuÝ nghĩa
qrCodeMã QR dạng văn bản
qrDataURLẢnh QR dưới định dạng Data URI, có thể dùng Data URI để nhúng hình ảnh vào website hoặc hiện thị lên trình duyệt. Tìm hiểu thêm về Data URI