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 |
import com.vng.zalo.miniapp.openapi.sdk.models.UpdatePaymentSettingRequest;
import com.vng.zalo.miniapp.openapi.sdk.models.UpdatePaymentSettingResponse;
UpdatePaymentSettingRequest request = new UpdatePaymentSettingRequest();
request.setMiniAppId({Your Mini App's Id});
request.setCallbackUrl("https://yourdomain/callback");
request.setSandboxCallbackUrl("https://yourdomain/callback-sandbox");
UpdatePaymentSettingResponse response = client.updatePaymentSetting(request);
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
import com.vng.zalo.miniapp.openapi.sdk.models.ListPaymentChannelRequest;
import com.vng.zalo.miniapp.openapi.sdk.models.ListPaymentChannelResponse;
ListPaymentChannelRequest request = new ListPaymentChannelRequest();
request.setMiniAppId({Your Mini App's Id});
ListPaymentChannelResponse response = client.listPaymentChannels(request);
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
import com.vng.zalo.miniapp.openapi.sdk.models.payment.ZaloPayPaymentChannel;
import com.vng.zalo.miniapp.openapi.sdk.models.payment.CustomPaymentChannel;
import com.vng.zalo.miniapp.openapi.sdk.models.ListPaymentChannelResponse;
// Create an ATM payment channel through ZaloPay Wallet
ZaloPayPaymentChannel request = new ZaloPayPaymentChannel();
request.setMethod(PaymentMethod.ATM);
request.setMiniAppId(Your Mini App's Id);
request.setStatus(Status.ACTIVE);
request.setRedirectPath("/result");
request.setKey1("{Your key1}");
request.setKey2("{Your key2}");
request.setMerchantAppId("{Your merchantId}");
CreatePaymentChannelResponse response = client.createPaymentChannel(request);
// Create a custom payment channel
CustomPaymentChannel request = new CustomPaymentChannel();
request.setMiniAppId(Your Mini App's Id);
request.setStatus(Status.ACTIVE);
request.setRedirectPath("/result");
request.setCustomMethod("SHOPEE_PAY");
request.setDisplayName("Ví Shopee Pay");
request.setSandbox(false);
request.setThumbnail(new File("./data/logo.png"));
CreatePaymentChannelResponse response = client.createPaymentChannel(request);
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
import com.vng.zalo.miniapp.openapi.sdk.models.payment.MoMoPaymentChannel;
import com.vng.zalo.miniapp.openapi.sdk.models.ListPaymentChannelResponse;
MoMoPaymentChannel request = new MoMoPaymentChannel();
request.setChannelId({Your Payment Channel's Id}); // The payment channel's Id needs to be updated
request.setMiniAppId(Your Mini App's Id);
request.setAccessKey("New Access Key");
CreatePaymentChannelResponse response = client.updatePaymentChannel(request);
5. Danh sách ngân hàng
Danh sách các ngân hàng được hỗ trợ khi tạo phương thức thanh toán chuyển khoản ngân hàng
| Bank | Tên ngân hàng |
|---|---|
| ABBANK | Ngân hàng TMCP An Bình |
| ACB | Ngân hàng TMCP Á Châu |
| AGRIBANK | Ngân hàng Nông nghiệp và Phát triển Nông thôn Việt Nam |
| BAC_A_BANK | Ngân hàng TMCP Bắc Á |
| BAOVIET_BANK | Ngân hàng TMCP Bảo Việt |
| BIDC | Ngân hàng TMCP Đầu tư và Phát triển Campuchia |
| BIDV | Ngân hàng TMCP Đầu tư và Phát triển Việt Nam |
| CAKE | Ngân hàng số CAKE by VPBank - Ngân hàng TMCP Việt Nam Thịnh Vượng |
| CBBANK | Ngân hàng Thương mại TNHH MTV Xây dựng Việt Nam |
| CIMB | Ngân hàng TNHH MTV CIMB Việt Nam |
| COOP_BANK | Ngân hàng Hợp tác xã Việt Nam |
| DBS_BANK | NH TNHH MTV Phát triển Singapore - Chi nhánh TP. Hồ Chí Minh |
| DONG_A_BANK | Ngân hàng TMCP Đông Á |
| EXIMBANK | Ngân hàng TMCP Xuất Nhập khẩu Việt Nam |
| GPBANK | Ngân hàng Thương mại TNHH MTV Dầu Khí Toàn Cầu |
| HDBANK | Ngân hàng TMCP Phát triển TP. Hồ Chí Minh |
| HONGLEONG_BANK | Ngân hàng TNHH MTV Hong Leong Việt Nam |
| HSBC | Ngân hàng TNHH MTV HSBC (Việt Nam) |
| IBK_HCM | Ngân hàng Công nghiệp Hàn Quốc - Chi nhánh TP. Hồ Chí Minh |
| IBK_HN | Ngân hàng Công nghiệp Hàn Quốc - Chi nhánh Hà Nội |
| INDOVINA_BANK | Ngân hàng TNHH Indovina |
| KASIKORN_BANK | Ngân hàng Đại chúng TNHH KASIKORNBANK - CN TP. Hồ Chí Minh |
| KIENLONG_BANK | Ngân hàng TMCP Kiên Long |
| KOOKMIN_BANK_HCM | Ngân hàng Kookmin - Chi nhánh TP. Hồ Chí Minh |
| KOOKMIN_BANK_HN | Ngân hàng Kookmin - Chi nhánh Hà Nội |
| LIENVIETPOST_BANK | Ngân hàng TMCP Bưu Điện Liên Việt |
| MBBANK | Ngân hàng TMCP Quân đội |
| MSB | Ngân hàng TMCP Hàng Hải |
| NAM_A_BANK | Ngân hàng TMCP Nam Á |
| NCB | Ngân hàng TMCP Quốc Dân |
| NONGHYUP_BANK_HN | Ngân hàng Nonghyup - Chi nhánh Hà Nội |
| OCB | Ngân hàng TMCP Phương Đông |
| OCEANBANK | Ngân hàng Thương mại TNHH MTV Đại Dương |
| PGBANK | Ngân hàng TMCP Xăng dầu Petrolimex |
| PUBLIC_BANK | Ngân hàng TNHH MTV Public Việt Nam |
| PVCOM_BANK | Ngân hàng TMCP Đại Chúng Việt Nam |
| SACOMBANK | Ngân hàng TMCP Sài Gòn Thương Tín |
| SAIGONBANK | Ngân hàng TMCP Sài Gòn Công Thương |
| SCB | Ngân hàng TMCP Sài Gòn |
| SEA_BANK | Ngân hàng TMCP Đông Nam Á |
| SHB | Ngân hàng TMCP Sài Gòn - Hà Nội |
| SHINHAN_BANK | Ngân hàng TNHH MTV Shinhan Việt Nam |
| STANDARD_CHARTERED_BANK | Ngân hàng TNHH MTV Standard Chartered Bank Việt Nam |
| TECHCOMBANK | Ngân hàng TMCP Kỹ thương Việt Nam |
| TIMO | Ngân hàng số Timo by Bản Việt Bank |
| TPBANK | Ngân hàng TMCP Tiên Phong |
| UBANK | Ngân hàng số Ubank by VPBank - Ngân hàng TMCP Việt Nam Thịnh Vượng |
| UNITED_OVERSEAS_BANK | Ngân hàng United Overseas Bank Việt Nam |
| VIB | Ngân hàng TMCP Quốc tế Việt Nam |
| VIETCAPITAL_BANK | Ngân hàng TMCP Bản Việt |
| VIETCOMBANK | Ngân hàng TMCP Ngoại Thương Việt Nam |
| VIETINBANK | Ngân hàng TMCP Công thương Việt Nam |
| VIET_A_BANK | Ngân hàng TMCP Việt Á |
| VIET_BANK | Ngân hàng TMCP Việt Nam Thương Tín |
| VPBANK | Ngân hàng TMCP Việt Nam Thịnh Vượng |
| VRB | Ngân hàng Liên doanh Việt - Nga |
| WOORI_BANK | Ngân hàng TNHH MTV Woori Việt Nam |