Api VietQR - POST & GET

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

Creating a new POST

Tạo Mã QR Code.

POST https://api.viqr.net/generate/post-v1/

Creates a new pet.

Headers

Name	Type	Description
ip-domain*	String	Mã định danh của bạn, khuyến cáo sử dụng tên domain của website của bạn
api-token*	String	API Key. Sử dụng key: We-l0v3-viqr.net

Request Body

Name	Type	Description
FullName*	string	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.
NDck*	string	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
bin*	string	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.. Xem API /banks để lấy mã
short_url*	string	Tên viết tắt BANKS, Xem API /banks để lấy mã
template*	String	Định dạng QR trả về. Xem thêm bên dưới.
amount*	String	Số tiền chuyển. Chỉ nhập số, tối đa 13 kí tự
AccountNumber*	String	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ự

200 Quy định về result code:

"01" : Tạo mã thành công thành công. 

"03" : Thiếu tham số 
"04" : Thiếu tham số Mã tài khoản 
"05" : Thiếu tham số Mã ngân hàng
"06" : Thiếu tham số Tên tài khoản

"08" : Mã tài khoản không hợp lệ
"09" : Mã ngân hàng không hợp lệ
"10" : Tên tài khoản không hợp lệ
"11" : Số tiền không hợp lệ
"12" : Nội dung chuyển tiền không hợp lệ.

401 Permission denied

curl --location --request POST 'https://api.viqr.nrt/generate/pots-v1/' \
--header 'Content-Type: application/json' \
--header 'ip-domain: xxxxxx.com' \
--header 'api-token: api-toxx1234' \
--data-raw '{
    "AccountNumber": "113366668888",
    "FullName": "QUY VAC XIN PHONG CHONG COVID",
    "bin": "970415",
    "NDck": "Ung Ho Quy Vac Xin",
    "amount": "79000",
    "template": "compact"
}'

Good to know: This API method was created using the API Method block, it's how you can build out an API method documentation from scratch. Have a play with the block and you'll see you can do some nifty things like add and reorder parameters, document responses, and give your methods detailed descriptions.

Creating a new GET

https://api.viqr.net/generate/get-v1/?ip-domain=xxx&api-token=xxx&bin=xx$AccountNumber=xx$amount=xx&FullName=xx&NDck=xx&template=xx

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ị	Size	Ghi chú
full	540x640	Bao gồm Viền : Mã QR, các logo , thông tin chuyển khoản
compact	540x640	Bao gồm : Mã QR, các logo , thông tin chuyển khoản
compact2	540x640	QR kèm logo VietQR, Napas, ngân hàng
qr_only	480x480	Trả về ảnh QR đơn giản, chỉ bao gồm QR

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

qrCode

qrCode: Mã QR dạng văn bản

qrDataURL

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 URIs]