📢Cloud Sound Box Push

API GỬI SỐ TIỀN XUỐNG THIẾT BỊ VOICEBOX ĐỂ PHÁT ÂM THANH

1 - API GỬI SỐ TIỀN XUỐNG THIẾT BỊ VOICEBOX

1.1 TỔNG QUAN

Tài liệu mô tả quy trình và cách thức sử dụng API của VietQR để gửi thông tin số tiền thanh toán xuống thiết bị Voicebox.

Tài liệu bao gồm:

• Các thức lấy token xác thực (GET TOKEN)

• Gọi API chính để truyền dữ liệu (thông tin số tiền thanh toán).

1.2 - LUỒNG KẾT NỐI

Luồng gửi thông báo đọc âm thanh BĐSD

2 - MÔ TẢ APIs

2.1 GET TOKEN

Mục đích: API này dùng để tạo Bearer Token cần thiết cho việc xác thực các yêu cầu API tiếp theo (API gửi số tiền thanh toán 2.2).

Method: POST:

URL: https://api.vietqr.org/vqr/api/token_generate

Request Header:

Name	Value
Content-Type	application/json
Authorization	Basic Authentication: Base64[username:password]

Lưu ý: username, password sẽ do VietQR cung cấp

Response Body:

Name	Type	Desc
access_token	String	Là Bearer Token được VietQR cung cấp sau khi hoàn thành bước 4. Dùng để truy cập tạo mã thanh toán VietQR.
token_type	String	Là token dạng “Bearer”
expires_in	int	Thời gian hết hạn của token. Mặc định là 300 giây

cURL:

curl --location --request POST 'https://api.vietqr.org/vqr/api/token_generate' \

--header 'Authorization: Basic Y3VzdG9tZXItdmlldHFydGVzdC11c2VyMjQ2ODpZM1Z6ZEc5dFpYSXRkbWxsZEhGeWRHVnpkQzExYzJWeU1qUTJPQT09'

Response:

{

"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJhdXRob3JpdGllcyI6WyJST0xFX1VTRVIiXSwidXNlciI6IlkzVnpkRzl0WlhJdGRtbGxkSEZ5ZEdWemRDMTFjMlZ5TWpRMk9BPT0iLCJpYXQiOjE3MjEzNzI2MzQsImV4cCI6MTcyMTM3MjkzNH0.D19qvrpYHUgcGjDCXuXXAv3j6lZr6tfmIB0VzdCzAXMJAElGok04sNLysS6PRLdRb0hSgEX5_9KpLjB-xErn-A",

"token_type": "Bearer",

"expires_in": 300

}

2.2 GỬI THÔNG TIN SỐ TIỀN XUỐNG THIẾT BỊ

Mục đích: API này dùng để truyền thông tin số tiền cần thanh toán xuống thiết bị Voicebox để thiết bị đọc thông báo bằng giọng nói.

Method: POST

https://api.vietqr.org/vqr/api/vnpt-epay/callback

Request Header:

Request Body:

Name	Type	Desc
amount	long	Số tiền
language	String	Ngôn ngữ (Mặc định: VN)
currency	String	Đơn vị tiền tệ (Mặc định: VND)
serialNumber	String	Mã serial Number của máy
referenceNumber	String	Mã giao dịch duy nhất
checkSum	String	mã hóa checkSum MD5(username + amount + referenceNumber + serialNumber)

Response Body:

Name	Type	Desc
status	String	“SUCCESS”: Thành công “FAILED”: Thất bại
message	String	Mã lỗi

cURL:

curl --location 'https://api.vietqr.org/vqr/api/vnpt-epay/callback' \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9' \

--header 'Cookie: JSESSIONID=349BED123B39E6FF3D30630E85E46C85' \

--data '{

"amount": 10000,

"language": "vn",

"currency": "dong",

"referenceNumber": "683753405sgfwdsg",

"serialNumber": "12345",

"checkSum": "28bb4cf00dc1deb0f6e1f009dcd2c6ea"

}'

Response:

{

"status": "SUCCESS",

"message": ""

}

(Link tài liệu tại đây)