Generate VietQR Code

Đối tác tạo ra mã QR Code thanh toán để người dùng có thể quét và thực hiện thanh toán trực tiếp. Tùy theo loại mã thanh toán VietQR mà cần phải truyền một vài tham số khác nhau.

POST

https://<vietqr-host>/<basepath>/api/qr/generate-customer

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Required	Description
bankCode	String	Yes	Mã ngân hàng của tài khoản.
bankAccount	String	Yes	Tài khoản ngân hàng tạo mã thanh toán VietQR.
userBankName	String	Yes	Họ tên chủ tài khoản. Không dấu tiếng Việt.
content	String	Yes	Nội dung chuyển tiền. Tối đa 19 ký tự, tiếng Việt không dấu, không ký tự đặc biệt.
qrType	Integer	Yes	Tùy loại mã thanh toán cần tạo, nhập giá trị tương ứng: - VietQR tĩnh: 1 - VietQR bán động: 3 - VietQR động: 0
amount	Long	Optional	Số tiền cần thanh toán. <Bắt buộc nếu "qrType" = 0 hoặc 3>
orderId	String	Optional	Mã ID giao dịch bên đối tác cần quản lý. “orderId” sẽ được trả về khi hệ thống nhận biến động số dư (có thông tin giao dịch trùng với giao dịch được tạo bằng mã QR). <Bắt buộc nếu "qrType" = 0>
transType	String	Optional	Phân loại giao dịch là ghi nợ/ghi có (giá trị: D/C). Mặc định là “C”. <Bắt buộc nếu "qrType" = 0>
terminalCode	String	Optional	Mã cửa hàng/điểm bán. <Bắt buộc nếu "qrType" = 1 hoặc 3>
serviceCode	String	Optional	Mã sản phẩm, dịch vụ được thanh toán. <Bắt buộc nếu "qrType" = 3>
sign	String	Optional	Chữ ký.
urlLink	String	Optional	Trang chuyển đến sau khi quét mã thanh toán.

Response

200

{
    "bankCode": "mã_ngân_hàng",
    "bankName": "tên_ngân_hàng",
    "bankAccount": "tài_khoản_ngân_hàng_nhận",
    "userBankName": "TEN_CHU_TAI_KHOAN",
    "amount": số_tiền_cần_thanh_toán,
    "content": "nội_dung_thanh_toán",
    "qrCode": "mã_QR_dạng_string",
    "transactionRefId": "mã_định_danh_của_QR",
    "qrLink": "mã_QR_dạng_link",
    "terminalCode": "mã_điểm_bán"
}

400

{
    "status": "FAILED",
    "message": "mã_lỗi_và_mô_tả_lỗi"
}