createBindingAgreementPay
NoteMô tả
API createBindingAgreementPay là một phương thức được cung cấp bởi JS-SDK, cho phép các mini-app của merchant một liên kết mới cho hợp đồng đồng thuận trong Zalopay
Sơ đồ tuần tự tạo một liên kết mới cho hợp đồng đồng thuận
Giải thích sơ đồ
Các tác nhân và thành phần tham gia:
- User: Khởi tạo quá trình liên kết mới cho hợp đồng đồng thuận.
- Merchant App: Mini-app được sử dụng bởi merchant.
- JS-SDK: Bộ SDK JavaScript được cung cấp bởi Zalopay.
- Binding Agreement Pay feature: Xử lý giao diện người dùng và logic của việc liên kết mới cho hợp đồng đồng thuận.
- Merchant Server: Máy chủ của merchant.
- Zalopay Server: Xử lý việc liên kết mới cho hợp đồng đồng thuận.
Các bước trình tự:
- User Interaction: Người dùng bắt đầu quá trình liên kết mới cho hợp đồng đồng thuận trong ứng dụng merchant.
- Request to Merchant Server: Ứng dụng merchant gửi yêu cầu đến Máy chủ merchant với các tham số cần thiết.
- Generate Transaction Details: Máy chủ merchant tạo các giá trị chi tiết giao dịch như app_trans_id, req_date và mac.
- Call Zalopay Server: Máy chủ merchant gọi API của máy chủ Zalopay để tạo liên kết mới.
- Process Binding Creation: Máy chủ Zalopay xử lý yêu cầu tạo liên kết mới.
- Receive Binding Info: Máy chủ Zalopay phản hồi với thông tin liên kết mới.
- Respond to Merchant App: Máy chủ merchant gửi dữ liệu liên kết mới trở lại mini-app merchant.
- Invoke JS-SDK Method: Mini-app merchant gọi createBindingAgreementPay(bindingToken) API trên JS-SDK.
- Open Binding Agreement Pay feature: Mở BottomSheetWebview với trang liên kết mới cho hợp đồng đồng thuận.
- Communicate with Zalopay Server: Tính năng Binding Agreement Pay sử dụng bindingToken để giao tiếp với Máy chủ Zalopay.
- Receive Binding Status: Máy chủ Zalopay trả về trạng thái liên kết cho tính năng Binding Agreement Pay.
- Return Status to JS-SDK: Tính năng Binding Agreement Pay trả kết quả về JS-SDK.
- Final Status to Merchant App: JS-SDK cung cấp trạng thái cuối cùng cho merchant mini-app.
Từ bước 1 đến bước 7. Vui lòng đọc thêm Tài liệu tạo một liên kết mới cho hợp đồng đồng thuận
Từ bước 8 đến bước 12, giao tiếp giữa Merchant mini-app và JS-SDK qua createBindingAgreementPay API
Những tham số
| Tên tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| bindingToken | string | Có | Một mã token duy nhất được cung cấp bởi Máy chủ Merchant, đại diện cho phiên liên kết thanh toán. Mã token này được lấy sau khi Máy chủ Merchant tạo thành công một yêu cầu liên kết với Máy chủ Zalopay. (Thời gian hết hạn khoảng 15 phút) |
Giá trị trả về
| Param | Kiểu dữ liệu | Mô Tả |
|---|---|---|
| status | string | Giá trị trả về success |
Mã lỗi
| Mã lỗi | Mô Tả |
|---|---|
| 071001 | User has canceled binding agreement pay |
| 071002 | User is not valid |
| 071003 | User has been already active |
| 071004 | Binding has expired. Please try again after 15 minutes |
Ví dụ code và kết quả trả về
Ví dụ gọi createBindingAgreementPay API:
window.zlpSdk.Payment.createBindingAgreementPay({
bindingToken: "2410210YvdL6l7ENgeVUx8dO21gGRbXj",
})
.then((response) => console.log(response))
.catch((error) => console.error(error.errorCode));
Ví dụ trả về thành công:
{
"status": "success"
}
Ví dụ trả về lỗi :
{
"status": "error",
"errorCode": "071001",
"errorMessage": "User has canceled binding agreement pay"
}