VietQR.IO (v2/paymentRequests)

Tạo link thanh toán

API dùng để tạo link thanh toán đơn hàng

Authorizations:

(x-client-idx-api-key)

Request Body schema: application/json

orderCode required	integer Mã đơn hàng
amount required	integer Số tiền thanh toán
description required	integer Mô tả thanh toán
buyerName	string Tên của người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.
buyerEmail	string Email của người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.
buyerPhone	string Số điện thoại người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.
buyerAddress	string Địa chỉ của người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.
template	string Mẫu VietQR, truy cập https://my.vietqr.io để tạo mẫu riêng cho DN
	Array of objects Danh sách các sản phẩm thanh toán
cancelUrl	string URL nhận dữ liệu khi người dùng chọn Huỷ đơn hàng.
successUrl	string URL nhận dữ liệu khi người dúng chọn Tôi đã thanh toán

Responses

Request samples

Payload

Content type

application/json

{"orderCode": 123,
"amount": 56000000,
"description": "VQPMK123",
"buyerName": "Nguyen Van A",
"buyerEmail": "buyer-email@gmail.com",
"buyerPhone": "090xxxxxxx",
"buyerAddress": "số nhà, đường, phường, tỉnh hoặc thành phố",
"template": "compact",
"items": [{"name": "Iphone",
"quantity": 2,
"price": 28000000
}
],
"cancelUrl": "https://your-cancel-url.com",
"successUrl": "https://your-success-url.com"
}

Response samples

200

Content type

application/json

Success - Thành công

{"code": "00",
"desc": "Success - Thành công",
"data": {"id": "a7a9454060cd48909864b3747289ff38",
"amount": 3000,
"description": "VQRIO12546 Thanh toan iphone",
"orderCode": 1254,
"buyerEmail": "buyer-email@gmail.com",
"status": "PENDING",
"checkoutUrl": "https://api.vietqr.io/web/a7a9454060cd48909864b3747289ff38"
}
}

Tích hợp webhook vào VietQR

API dùng để các website tích hợp webhook để VietQR gửi dữ liệu thanh toán

Authorizations:

(x-client-idx-api-key)

Request Body schema: application/json

webhook_url

required

string

Link dùng để làm webhook

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "https://example.com/receiveWebhook"
}

Response samples

200

Content type

application/json

Success - Thành công

{"code": "00",
"desc": "success",
"data": {"id": 105,
"user_id": 172,
"account_id": 11,
"name": "test",
"prefix_order_code": "encode",
"qr_template": "PqIalUq",
"webhook_url": "https://example.com/receiveWebhook",
"logo_url": "https://logo.png",
"account_number": "1230103032004",
"account_name": "NGUYEN TRUNG HIEU",
"short_name": "MBBank"
}
}

VietQR gửi dữ liệu thanh toán đến wehbook của cửa hàng Webhook

API của cửa hàng dùng để nhận các thông tin giao dịch từ VietQR Payment KIT gửi qua đối với các cổng liên kết TK ngân hàng bằng Casso.

Authorizations:

secure-token

Request Body schema: application/json

code required	string Mã lỗi
desc required	string Thông tin lỗi
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"desc": "string",
"data": [{"orderCode": 123,
"amount": 3000,
"description": "VQPMK123",
"accountNumber": 12345678,
"privateId": 12323,
"reference": "TF230204212323",
"transactionDatetime": "2023-02-04 18:25:00",
"paymentLinkId": 2334,
"code": "00",
"desc": "Thành công",
"counterAccountBankId": "string",
"counterAccountBankName": "string",
"counterAccountName": "string",
"counterAccountNumber": "string",
"virtualAccountName": "string",
"virtualAccountNumber": "string"
}
]
}