Yêu cầu thanh toán hợp đồng hoặc thanh toán một lần
Yêu cầu thanh toán hợp đồng hoặc thanh toán một lần
- application/json
- application/xml
- application/x-www-form-urlencoded
Request Body required
Hybrid Payment
- app_id int64 required
ID duy nhất của ứng dụng sẽ được cung cấp sau khi nhà cung cấp đăng ký thành công với Zalopay.
- identifier string required
Định danh của người dùng trên hệ thống của nhà cung cấp (merchant), có thể là mã người dùng, số điện thoại, địa chỉ email...
- pay_token string required
"Public token" của người thanh toán.
- app_user string required
ID nhà cung cấp.
- app_trans_id string required
ID giao dịch duy nhất của ứng dụng, định dạng: yyMMddxxxxxxxxx. Độ dài tối đa là 40 ký tự. Ví dụ: 180208181007242.
- app_time int64 required
Thời điểm (timestamp) khi đơn hàng được tạo ra, tính bằng mili giây (ms). Giới hạn khác biệt là 15 phút.
- amount int64 required
Số tiền sẽ được tính phí (thanh toán).
- description string required
Người dùng sẽ thấy văn bản này khi họ ở trong màn hình xác nhận thanh toán.
- item string required
Chuỗi JSON mô tả các mục đơn hàng. Sử dụng
"[]"
nếu rỗng - embed_data string required
Chuỗi JSON bao gồm thông tin đặc biệt của đơn hàng.
Sử dụng"{}"
nếu rỗng
Một số trường đặc biệt của embed_data:
preferred_payment_method
+ Kiểu dữ liệu: array string
+ Định dạng:["domestic_card", "vietqr", "..."]
. Tham khảo tại đây
+ Mô tả: Dùng để hiển thị phương thức thanh toán tùy chọn trên cổng Zalopay, ví dụ:{"preferred_payment_method":["vietqr"]}
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"}
- mac string required
Đây là chữ ký của đơn hàng. Nó được tính bằng cách sử dụng thông tin đầu vào như sau: hmacinput = app_id +
|
+ identifier +|
+ zp_trans_token +|
+ pay_token +|
+ req_date; và sử dụng SHA256 với khóa HMAC của ứng dụng làm khóa chữ ký.Vui lòng tham khảo truyền dữ liệu an toàn để biết thông tin chi tiết.
Request Body required
Hybrid Payment
- app_id int64 required
ID duy nhất của ứng dụng sẽ được cung cấp sau khi nhà cung cấp đăng ký thành công với Zalopay.
- identifier string required
Định danh của người dùng trên hệ thống của nhà cung cấp (merchant), có thể là mã người dùng, số điện thoại, địa chỉ email...
- pay_token string required
"Public token" của người thanh toán.
- app_user string required
ID nhà cung cấp.
- app_trans_id string required
ID giao dịch duy nhất của ứng dụng, định dạng: yyMMddxxxxxxxxx. Độ dài tối đa là 40 ký tự. Ví dụ: 180208181007242.
- app_time int64 required
Thời điểm (timestamp) khi đơn hàng được tạo ra, tính bằng mili giây (ms). Giới hạn khác biệt là 15 phút.
- amount int64 required
Số tiền sẽ được tính phí (thanh toán).
- description string required
Người dùng sẽ thấy văn bản này khi họ ở trong màn hình xác nhận thanh toán.
- item string required
Chuỗi JSON mô tả các mục đơn hàng. Sử dụng
"[]"
nếu rỗng - embed_data string required
Chuỗi JSON bao gồm thông tin đặc biệt của đơn hàng.
Sử dụng"{}"
nếu rỗng
Một số trường đặc biệt của embed_data:
preferred_payment_method
+ Kiểu dữ liệu: array string
+ Định dạng:["domestic_card", "vietqr", "..."]
. Tham khảo tại đây
+ Mô tả: Dùng để hiển thị phương thức thanh toán tùy chọn trên cổng Zalopay, ví dụ:{"preferred_payment_method":["vietqr"]}
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"}
- mac string required
Đây là chữ ký của đơn hàng. Nó được tính bằng cách sử dụng thông tin đầu vào như sau: hmacinput = app_id +
|
+ identifier +|
+ zp_trans_token +|
+ pay_token +|
+ req_date; và sử dụng SHA256 với khóa HMAC của ứng dụng làm khóa chữ ký.Vui lòng tham khảo truyền dữ liệu an toàn để biết thông tin chi tiết.
Request Body required
Hybrid Payment
- app_id int64 required
ID duy nhất của ứng dụng sẽ được cung cấp sau khi nhà cung cấp đăng ký thành công với Zalopay.
- identifier string required
Định danh của người dùng trên hệ thống của nhà cung cấp (merchant), có thể là mã người dùng, số điện thoại, địa chỉ email...
- pay_token string required
"Public token" của người thanh toán.
- app_user string required
ID nhà cung cấp.
- app_trans_id string required
ID giao dịch duy nhất của ứng dụng, định dạng: yyMMddxxxxxxxxx. Độ dài tối đa là 40 ký tự. Ví dụ: 180208181007242.
- app_time int64 required
Thời điểm (timestamp) khi đơn hàng được tạo ra, tính bằng mili giây (ms). Giới hạn khác biệt là 15 phút.
- amount int64 required
Số tiền sẽ được tính phí (thanh toán).
- description string required
Người dùng sẽ thấy văn bản này khi họ ở trong màn hình xác nhận thanh toán.
- item string required
Chuỗi JSON mô tả các mục đơn hàng. Sử dụng
"[]"
nếu rỗng - embed_data string required
Chuỗi JSON bao gồm thông tin đặc biệt của đơn hàng.
Sử dụng"{}"
nếu rỗng
Một số trường đặc biệt của embed_data:
preferred_payment_method
+ Kiểu dữ liệu: array string
+ Định dạng:["domestic_card", "vietqr", "..."]
. Tham khảo tại đây
+ Mô tả: Dùng để hiển thị phương thức thanh toán tùy chọn trên cổng Zalopay, ví dụ:{"preferred_payment_method":["vietqr"]}
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"}
- mac string required
Đây là chữ ký của đơn hàng. Nó được tính bằng cách sử dụng thông tin đầu vào như sau: hmacinput = app_id +
|
+ identifier +|
+ zp_trans_token +|
+ pay_token +|
+ req_date; và sử dụng SHA256 với khóa HMAC của ứng dụng làm khóa chữ ký.Vui lòng tham khảo truyền dữ liệu an toàn để biết thông tin chi tiết.
- 200
- 405
OK
- application/json
- Schema
- Example (from schema)
Schema
- return_code integer
1: Thành công, 2: Thất bại, 3: Đang xử lý.
- return_message string
Mô tả mã trạng thái trả về
- sub_return_code integer
Mã lỗi chi tiết
- sub_return_message string
Thông báo lỗi chi tiết
- app_trans_id string
TXID (Transaction ID) của giao dịch đơn hàng
- zp_trans_id integer
Mã giao dịch của Zalopay
- solution_url string
URL để chuyển hướng người dùng thanh toán One time payment khi thanh toán bằng token thất bại
{
"return_code": 0,
"return_message": "string",
"sub_return_code": 0,
"sub_return_message": "string",
"app_trans_id": "string",
"zp_trans_id": 0,
"solution_url": "string"
}
Đầu vào không hợp lệ