Checkout SDK
Được sử dụng để thao tác với phương thức thanh toán của Mini App.
1. Thiết lập thanh toán
Cho phép thiết lập callback url và sandbox callback url thanh toán của Mini App.
Parameters
| Property | Type | Required | Description |
|---|---|---|---|
| miniAppId | long | true | ID của Mini App |
| callbackUrl | long | false | callback url |
| sandboxCallbackUrl | long | false | sandbox callback url |
Return Values
| Property | Type | Description |
|---|---|---|
| error | int | Mã lỗi của kết quả trả về, bằng 0 nếu request thành công |
| message | String | Lời nhắn chi tiết tương ứng với mã lỗi |
| paymentSetting | PaymentSetting | Cấu hình thanh toán của Mini App |
PaymentSetting
| Property | Type | Description |
|---|---|---|
| securityMethod | String | Phương thức bảo mật |
| privateKey | String | Dùng để tạo thông tin chứng thực của callback từ Checkout SDK Server |
| status | String | Trạng thái hiện tại của thanh toán, mang một trong các giá trị: ACTIVE, INACTIVE |
| callbackUrl | String | Đường dẫn nhận callback từ Checkout SDK Server |
| sandboxCallbackUrl | String | Đường dẫn nhận callback cho phương thức sandbox từ Checkout SDK Server |
Code demo fallback when rendering server side!
2. Lấy danh sách phương thức thanh toán
Parameters
| Property | Type | Required | Description |
|---|---|---|---|
| miniAppId | long | true | ID của Mini App |
Return Values
| Property | Type | Description |
|---|---|---|
| error | int | Mã lỗi của kết quả trả về, bằng 0 nếu request thành công |
| message | String | Lời nhắn chi tiết tương ứng với mã lỗi |
| paymentChannels | List PaymentChannel | Danh sách phương thức thanh toán của Mini App |
PaymentChannel
| Property | Type | Description |
|---|---|---|
| id | int | ID của phương thức thanh toán |
| method | String | Mã phương thức thanh toán, xem chi tiết tại đây |
| isCustom | boolean | Xác định có phải là loại phương thức thanh toán riêng hay không |
| status | String | Trạng thái hiện tại của phương thức thanh toán, mang một trong các giá trị: ACTIVE, INACTIVE |
| thumbnail | String | Thumbnail của phương thức thanh toán riêng |
| isSandbox | boolean | Xác định có phải môi phường Sandbox hay không |
| name | String | Tên của của phương thức thanh toán riêng |
Sample Code
Code demo fallback when rendering server side!
3. Tạo phương thức thanh toán mới
Request Body
| Property | Type | Required | Description |
|---|---|---|---|
| paymentChannel | Class extends PaymentChannel | true | Phương thức thanh toán |
PaymentChannel là một abstract class, có các thuộc tính chung như: method, redirectPath, status, miniAppId, và channelId (cần truyền vào khi cập nhật).
Mọi phương thức thanh toán đều được extends từ class này và có từng thuộc tính riêng của nó. Khi tạo thì truyền object của một các trong class sau
Danh sách các class được extends từ PaymentChannel
| Class | Các thuộc tính riêng | Method |
|---|---|---|
| ZaloPayPaymentChannel | key1, key2, merchantId | ZALOPAY, ZALOPAY_SANDBOX, CC, CC_SANBOX, ATM, ATM_SANDBOX |
| MoMoPaymentChannel | partnerCode, accessKey, secretKey, publicKey | MOMO, MOMO_SANDBOX |
| VNPayPaymentChannel | terminalId, version, secretKey | VNPAY, VNPAY_SANDBOX |
| PayMePaymentChannel | merchantId, xApiClient, secretKey | PAYME_CC, PAYME_CC_SANDBOX, PAYME_ATM , PAYME_ATM_SANDBOX |
| BankPaymentChannel | accountName, notifyUrl, content, accountNumber, bankName | BANK, BANK_SANDBOX |
| CODPaymentChannel | notifyUrl | COD, COD_SANDBOX |
| CustomPaymentChannel | customMethod, displayName, isSandbox, thumbnail | Sử dụng để tạo phương thức thanh toán riêng |
thông tin
Đối với phương thanh thanh toán là chyển khoản ngân hàng, 'bankName' là mã của ngân hàng, xem tại đây
Return Values
| Property | Type | Description |
|---|---|---|
| error | int | Mã lỗi của kết quả trả về, bằng 0 nếu request thành công |
| message | String | Lời nhắn chi tiết tương ứng với mã lỗi |
| channelId | int | Id của phương thức thanh toán vừa tạo |
Sample code
Code demo fallback when rendering server side!
4. Cập nhật phương thức thanh toán
Request Body
Tương tự như lúc tạo phương thức thanh toán, bạn cũng phải truyền 1 object của class extends từ PaymentChannel.
thông tin
- Chỉ cần truyền những field cần cập nhật.
- Với phương thức thanh toán riêng, chỉ hỗ trợ cập nhật tên hiển thị, thumbnail và trạng thái.
Return Values
| Property | Type | Description |
|---|---|---|
| error | int | Mã lỗi của kết quả trả về, bằng 0 nếu request thành công |
| message | String | Lời nhắn chi tiết tương ứng với mã lỗi |
| channelId | int | Id của phương thức thanh toán vừa cập nhật |
Sample code
Code demo fallback when rendering server side!