Tạo đơn hàng
End-user cho phép Thu ngân của Merchant quét mã QR thanh toán trong app Zalopay để trừ đi số tiền cần thanh toán ngay tại điểm bán hàng.
- application/json
- application/x-www-form-urlencoded
- application/xml
Request Body required
- app_id int required
Định danh cho ứng dụng đã được cấp bởi Zalopay.
- app_user string(50) required
Thông tin người dùng như id/username... Dùng tên ứng dụng nếu không định danh được.
- app_time int64 required
Thời điểm tạo đơn hàng (current unix timestamp in milisecond).
- amount int64 required
Giá trị của đơn hàng theo VND
- app_trans_id string(40) required
Mã giao dịch của đơn hàng bắt đầu theo format yymmdd-Mã đơn hàng thanh toán.
- embed_data string(1024) required
Dữ liệu riêng của đơn hàng. Dùng
"{}"
nếu rỗng.
Một số trường đặc biệt của embed_data:
redirecturl
+ Kiểu dữ liệu: string
+ Định dạng: URL
+ Mô tả: Redirect về url này sau khi thanh toán trên cổng Zalopay (override redirect url lúc đăng ký app với Zalopay). Ví dụ:{"redirecturl": "https://docs.zalopay.vn/result"}
columninfo
+ Kiểu dữ liệu: json string
+ Định dạng:{"column_name": "value"}
+ Mô tả: Thêm thông tin hiển thị ở phần Quản lý giao dịch chi tiết trên Merchant site, nếu cột chưa tồn tại cần vào phần Cài đặt hiển thị dữ liệu để cấu hình. Ví dụ:{"columninfo": "{\"branch_id\": \"HCM\",\"store_id\": \"CH123\",\"store_name\": \"Saigon Centre\",\"mc_campaign_id\": \"FREESHIP\"}"}
promotioninfo
+ Kiểu dữ liệu: json string
+ Định dạng:{"campaigncode":"code"}
+ Mô tả: Dùng để triển khai chương trình khuyến mãi. Ví dụ:{"promotioninfo": "{\"campaigncode\":\"blackfriday\"}"}
zlppaymentid
+ Kiểu dữ liệu: string
+ Mô tả: Mã thông tin thanh toán. Chỉ truyền khi đối tác cần nhận tiền đối soát về nhiều tài khoản khác nhau. Hệ thống Zalopay sẽ tạo ra một mã Thanh toán (tương ứng với mỗi Tài khoản ngân hàng đối tác cung cấp) và gởi lại cho đối tác thiết lập. Ví dụ:{"zlppaymentid": "P4201372"}
- item string(1024) required
Item của đơn hàng, do Merchant tự định nghĩa. Dùng
"[]"
nếu rỗng. - mac string required
Thông tin chứng thực của đơn hàng.
mac = HMAC(hmac_algorithm, key1, hmac_input)
hmac_input: app_id +
”|”
+ app_trans_id +”|”
+ app_user +”|”
+ amount +"|"
+ app_time +”|”
+ embed_data +"|"
+ item +"|"
+ paymentCodeRaw
key1: Mac Key provided by Zalopay at registration
hmac_algorithm: is a security method registered by Merchant with Zalopay, the default isHmacSHA256
- payment_code string required
Được scan từ ứng dụng Zalopay, được mã hóa bằng Public Key do Zalopay cấp = RSA(paymentCodeRaw, publicKey)
- description string(100)
Thông tin mô tả về đơn hàng. Sẽ hiển thị lúc thanh toán Zalopay.
- callback_url string
Zalopay sẽ thông báo trạng thái thanh toán của đơn hàng khi thanh toán hoàn tất; callback_url được gọi để thông báo kết quả thanh toán thất bại hoặc thành công. Nếu không được cung cấp, callback_url mặc định của ứng dụng sẽ được sử dụng.
- redirect_url string
Redirect về url này sau khi thanh toán (override redirect url lúc đăng ký app với Zalopay).
- device_info string(256)
Chuỗi JSON mô tả thông tin của thiết bị.
- currency string
Đơn vị tiền tệ. Mặc định là VND.
- title string
Tiêu đề đơn hàng.
- userIP string
Địa chỉ IP của user.
Request Body required
- app_id int required
Định danh cho ứng dụng đã được cấp bởi Zalopay.
- app_user string(50) required
Thông tin người dùng như id/username... Dùng tên ứng dụng nếu không định danh được.
- app_time int64 required
Thời điểm tạo đơn hàng (current unix timestamp in milisecond).
- amount int64 required
Giá trị của đơn hàng theo VND
- app_trans_id string(40) required
Mã giao dịch của đơn hàng bắt đầu theo format yymmdd-Mã đơn hàng thanh toán.
- embed_data string(1024) required
Dữ liệu riêng của đơn hàng. Dùng
"{}"
nếu rỗng.
Một số trường đặc biệt của embed_data:
redirecturl
+ Kiểu dữ liệu: string
+ Định dạng: URL
+ Mô tả: Redirect về url này sau khi thanh toán trên cổng Zalopay (override redirect url lúc đăng ký app với Zalopay). Ví dụ:{"redirecturl": "https://docs.zalopay.vn/result"}
columninfo
+ Kiểu dữ liệu: json string
+ Định dạng:{"column_name": "value"}
+ Mô tả: Thêm thông tin hiển thị ở phần Quản lý giao dịch chi tiết trên Merchant site, nếu cột chưa tồn tại cần vào phần Cài đặt hiển thị dữ liệu để cấu hình. Ví dụ:{"columninfo": "{\"branch_id\": \"HCM\",\"store_id\": \"CH123\",\"store_name\": \"Saigon Centre\",\"mc_campaign_id\": \"FREESHIP\"}"}
promotioninfo
+ Kiểu dữ liệu: json string
+ Định dạng:{"campaigncode":"code"}
+ Mô tả: Dùng để triển khai chương trình khuyến mãi. Ví dụ:{"promotioninfo": "{\"campaigncode\":\"blackfriday\"}"}
zlppaymentid
+ Kiểu dữ liệu: string
+ Mô tả: Mã thông tin thanh toán. Chỉ truyền khi đối tác cần nhận tiền đối soát về nhiều tài khoản khác nhau. Hệ thống Zalopay sẽ tạo ra một mã Thanh toán (tương ứng với mỗi Tài khoản ngân hàng đối tác cung cấp) và gởi lại cho đối tác thiết lập. Ví dụ:{"zlppaymentid": "P4201372"}
- item string(1024) required
Item của đơn hàng, do Merchant tự định nghĩa. Dùng
"[]"
nếu rỗng. - mac string required
Thông tin chứng thực của đơn hàng.
mac = HMAC(hmac_algorithm, key1, hmac_input)
hmac_input: app_id +
”|”
+ app_trans_id +”|”
+ app_user +”|”
+ amount +"|"
+ app_time +”|”
+ embed_data +"|"
+ item +"|"
+ paymentCodeRaw
key1: Mac Key provided by Zalopay at registration
hmac_algorithm: is a security method registered by Merchant with Zalopay, the default isHmacSHA256
- payment_code string required
Được scan từ ứng dụng Zalopay, được mã hóa bằng Public Key do Zalopay cấp = RSA(paymentCodeRaw, publicKey)
- description string(100)
Thông tin mô tả về đơn hàng. Sẽ hiển thị lúc thanh toán Zalopay.
- callback_url string
Zalopay sẽ thông báo trạng thái thanh toán của đơn hàng khi thanh toán hoàn tất; callback_url được gọi để thông báo kết quả thanh toán thất bại hoặc thành công. Nếu không được cung cấp, callback_url mặc định của ứng dụng sẽ được sử dụng.
- redirect_url string
Redirect về url này sau khi thanh toán (override redirect url lúc đăng ký app với Zalopay).
- device_info string(256)
Chuỗi JSON mô tả thông tin của thiết bị.
- currency string
Đơn vị tiền tệ. Mặc định là VND.
- title string
Tiêu đề đơn hàng.
- userIP string
Địa chỉ IP của user.
Request Body required
- app_id int required
Định danh cho ứng dụng đã được cấp bởi Zalopay.
- app_user string(50) required
Thông tin người dùng như id/username... Dùng tên ứng dụng nếu không định danh được.
- app_time int64 required
Thời điểm tạo đơn hàng (current unix timestamp in milisecond).
- amount int64 required
Giá trị của đơn hàng theo VND
- app_trans_id string(40) required
Mã giao dịch của đơn hàng bắt đầu theo format yymmdd-Mã đơn hàng thanh toán.
- embed_data string(1024) required
Dữ liệu riêng của đơn hàng. Dùng
"{}"
nếu rỗng.
Một số trường đặc biệt của embed_data:
redirecturl
+ Kiểu dữ liệu: string
+ Định dạng: URL
+ Mô tả: Redirect về url này sau khi thanh toán trên cổng Zalopay (override redirect url lúc đăng ký app với Zalopay). Ví dụ:{"redirecturl": "https://docs.zalopay.vn/result"}
columninfo
+ Kiểu dữ liệu: json string
+ Định dạng:{"column_name": "value"}
+ Mô tả: Thêm thông tin hiển thị ở phần Quản lý giao dịch chi tiết trên Merchant site, nếu cột chưa tồn tại cần vào phần Cài đặt hiển thị dữ liệu để cấu hình. Ví dụ:{"columninfo": "{\"branch_id\": \"HCM\",\"store_id\": \"CH123\",\"store_name\": \"Saigon Centre\",\"mc_campaign_id\": \"FREESHIP\"}"}
promotioninfo
+ Kiểu dữ liệu: json string
+ Định dạng:{"campaigncode":"code"}
+ Mô tả: Dùng để triển khai chương trình khuyến mãi. Ví dụ:{"promotioninfo": "{\"campaigncode\":\"blackfriday\"}"}
zlppaymentid
+ Kiểu dữ liệu: string
+ Mô tả: Mã thông tin thanh toán. Chỉ truyền khi đối tác cần nhận tiền đối soát về nhiều tài khoản khác nhau. Hệ thống Zalopay sẽ tạo ra một mã Thanh toán (tương ứng với mỗi Tài khoản ngân hàng đối tác cung cấp) và gởi lại cho đối tác thiết lập. Ví dụ:{"zlppaymentid": "P4201372"}
- item string(1024) required
Item của đơn hàng, do Merchant tự định nghĩa. Dùng
"[]"
nếu rỗng. - mac string required
Thông tin chứng thực của đơn hàng.
mac = HMAC(hmac_algorithm, key1, hmac_input)
hmac_input: app_id +
”|”
+ app_trans_id +”|”
+ app_user +”|”
+ amount +"|"
+ app_time +”|”
+ embed_data +"|"
+ item +"|"
+ paymentCodeRaw
key1: Mac Key provided by Zalopay at registration
hmac_algorithm: is a security method registered by Merchant with Zalopay, the default isHmacSHA256
- payment_code string required
Được scan từ ứng dụng Zalopay, được mã hóa bằng Public Key do Zalopay cấp = RSA(paymentCodeRaw, publicKey)
- description string(100)
Thông tin mô tả về đơn hàng. Sẽ hiển thị lúc thanh toán Zalopay.
- callback_url string
Zalopay sẽ thông báo trạng thái thanh toán của đơn hàng khi thanh toán hoàn tất; callback_url được gọi để thông báo kết quả thanh toán thất bại hoặc thành công. Nếu không được cung cấp, callback_url mặc định của ứng dụng sẽ được sử dụng.
- redirect_url string
Redirect về url này sau khi thanh toán (override redirect url lúc đăng ký app với Zalopay).
- device_info string(256)
Chuỗi JSON mô tả thông tin của thiết bị.
- currency string
Đơn vị tiền tệ. Mặc định là VND.
- title string
Tiêu đề đơn hàng.
- userIP string
Địa chỉ IP của user.
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
- return_code int
1
: Giao dịch thành công
2
: Lỗi
3
: Đang xử lý, kiểm tra trạng thái đơn hàng bằng API truy vấn trạng thái đơn hàng - return_message string
Thông tin lỗi
- sub_return_code int
Mã lỗi từ đối tác
- sub_return_message string
Mô tả chi tiết mã trạng thái từ đối tác
- is_processing boolean
true
: Đang xử lý
false
: Kết thúc giao dịch - zp_trans_id int64
Mã giao dịch của Zalopay
{
"return_code": 0,
"return_message": "string",
"sub_return_code": 0,
"sub_return_message": "string",
"is_processing": true,
"zp_trans_id": 0
}