@cobo/cobo-waas2 1.22.0 → 1.24.0

package/docs/PaymentApi.md

@@ -13,9 +13,9 @@ Method | HTTP request | Description
 [**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
 [**deleteCryptoAddress**](PaymentApi.md#deleteCryptoAddress) | **POST** /payments/crypto_addresses/{crypto_address_id}/delete | Delete crypto address
 [**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
-[**getPayerBalanceByAddress**](PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance by address
+[**getPayerBalanceByAddress**](PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance
 [**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
-[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get psp balance
+[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get developer balance
 [**getRefundDetailById**](PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
 [**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
 [**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
@@ -31,7 +31,10 @@ Method | HTTP request | Description
 [**listPaymentWalletBalances**](PaymentApi.md#listPaymentWalletBalances) | **GET** /payments/balance/payment_wallets | List payment wallet balances
 [**listSettlementDetails**](PaymentApi.md#listSettlementDetails) | **GET** /payments/settlement_details | List all settlement details
 [**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
+[**listTopUpPayerAccounts**](PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
 [**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
+[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Payment estimate fee
+[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
 [**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
 [**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
 [**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
@@ -95,7 +98,7 @@ Name | Type | Description  | Notes
 
 Create crypto address
 
-This operation registers a crypto address for crypto withdrawal.  The registered address can later be referenced by its ID when creating settlement requests. 
+This operation registers a crypto address for crypto payouts.  The registered address can later be referenced by its ID when creating settlement requests. 
 
 ### Example
 
@@ -147,7 +150,7 @@ Name | Type | Description  | Notes
 
 Create forced sweep
 
-This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address. 
+<Warning>This operation has been deprecated.</Warning> This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address. 
 
 ### Example
 
@@ -199,7 +202,7 @@ Name | Type | Description  | Notes
 
 Create merchant
 
-This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet.  Upon successful creation, a merchant ID is generated and returned along with the merchant's information. 
+This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet.  Upon successful creation, a merchant ID is generated and returned along with the merchant's information.  If you are a merchant (directly serving the payer), you only need to create one merchant and do not need to configure the developer fee rate. The developer fee rate only applies to platforms such as payment service providers (PSPs) that charge fees to their downstream merchants. 
 
 ### Example
 
@@ -505,11 +508,11 @@ Name | Type | Description  | Notes
 
 ## getPayerBalanceByAddress
 
-> [ReceivedAmountPerAddress] getPayerBalanceByAddress(merchant_id, payer_id, token_id)
+> [ReceivedAmountPerAddress] getPayerBalanceByAddress(payer_id, token_id, opts)
 
-Get payer balance by address
+Get payer balance
 
-This operation retrieves aggregated balance details for a specific token and payer, with amounts grouped by address. 
+This operation retrieves the total amount received for a specific payer. The information is grouped by token and receiving address. 
 
 ### Example
 
@@ -523,10 +526,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
 apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
 // Call the API
 const apiInstance = new CoboWaas2.PaymentApi();
-const merchant_id = "M1001";
 const payer_id = "P20250619T0310056d7aa";
 const token_id = "ETH_USDT";
-apiInstance.getPayerBalanceByAddress(merchant_id, payer_id, token_id).then((data) => {
+const opts = {
+  'merchant_id': "M1001"
+};
+apiInstance.getPayerBalanceByAddress(payer_id, token_id, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
   console.error(error);
@@ -539,9 +544,9 @@ apiInstance.getPayerBalanceByAddress(merchant_id, payer_id, token_id).then((data
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **merchant_id** | **String**| The merchant ID. | 
  **payer_id** | **String**| Unique payer identifier on the Cobo side, auto-generated by the system. | 
  **token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format &#x60;{CHAIN}_{TOKEN}&#x60;. Supported values include:   - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60;   - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60;  | 
+ **merchant_id** | **String**| The merchant ID. | [optional] 
 
 ### Return type
 
@@ -611,9 +616,9 @@ Name | Type | Description  | Notes
 
 > PspBalance getPspBalance(token_id)
 
-Get psp balance
+Get developer balance
 
-This operation retrieves the information of psp balance. 
+This operation retrieves the balance information for you as the developer. The balance information is grouped by token.  For more information, please refer to [Amounts and Balances](/v2/payments/amounts-and-balances) 
 
 ### Example
 
@@ -825,7 +830,7 @@ Name | Type | Description  | Notes
 
 Get withdrawable balances
 
-This operation retrieves the balances of specified merchants or the developer. 
+&lt;Warning&gt;This operation has been deprecated.&lt;/Warning&gt; This operation retrieves the balances of specified merchants or the developer. 
 
 ### Example
 
@@ -877,7 +882,7 @@ Name | Type | Description  | Notes
 
 ## getTopUpAddress
 
-> TopUpAddress getTopUpAddress(merchant_id, token_id, custom_payer_id)
+> TopUpAddress getTopUpAddress(token_id, custom_payer_id, opts)
 
 Get top-up address
 
@@ -895,10 +900,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
 apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
 // Call the API
 const apiInstance = new CoboWaas2.PaymentApi();
-const merchant_id = "M1001";
 const token_id = "ETH_USDT";
 const custom_payer_id = "payer_0001";
-apiInstance.getTopUpAddress(merchant_id, token_id, custom_payer_id).then((data) => {
+const opts = {
+  'merchant_id': "M1001"
+};
+apiInstance.getTopUpAddress(token_id, custom_payer_id, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
   console.error(error);
@@ -911,9 +918,9 @@ apiInstance.getTopUpAddress(merchant_id, token_id, custom_payer_id).then((data)
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **merchant_id** | **String**| The merchant ID. | 
  **token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format &#x60;{CHAIN}_{TOKEN}&#x60;. Supported values include:   - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60;   - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60;  | 
  **custom_payer_id** | **String**| A unique identifier assigned by the developer to track and identify individual payers in their system. | 
+ **merchant_id** | **String**| The merchant ID. | [optional] 
 
 ### Return type
 
@@ -981,7 +988,7 @@ This endpoint does not need any parameter.
 
 List crypto addresses
 
-This operation retrieves a list of crypto addresses registered for crypto withdrawal.   Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new crypto address. 
+This operation retrieves a list of crypto addresses registered for crypto payouts.   Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new crypto address. 
 
 ### Example
 
@@ -1033,7 +1040,7 @@ Name | Type | Description  | Notes
 
 List forced sweeps
 
-This operation retrieves the information of all forced sweeps. 
+&lt;Warning&gt;This operation has been deprecated.&lt;/Warning&gt; This operation retrieves the information of all forced sweeps. 
 
 ### Example
 
@@ -1091,7 +1098,7 @@ Name | Type | Description  | Notes
 
 List merchant balances
 
-This operation retrieves the information of merchant balances. 
+ This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the &#x60;merchant_ids&#x60; parameter, the balance information for all merchants will be returned.  For more information, please refer to [Amounts and Balances](/v2/payments/amounts-and-balances) 
 
 ### Example
 
@@ -1124,7 +1131,7 @@ apiInstance.listMerchantBalances(token_id, acquiring_type, opts).then((data) =>
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format &#x60;{CHAIN}_{TOKEN}&#x60;. Supported values include:   - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60;   - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60;  | 
- **acquiring_type** | [**AcquiringType**](.md)| AcquiringType defines the acquisition logic used in the payment flow: - &#x60;Order&#x60;: Each order is created with a specific amount and associated payment request. Funds are settled on a per-order basis. - &#x60;TopUp&#x60;: Recharge-style flow where funds are topped up to a payer balance or account. Useful for flexible or usage-based payment models.  | 
+ **acquiring_type** | [**AcquiringType**](.md)| The payment acquisition type. - &#x60;Order&#x60;: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions. - &#x60;TopUp&#x60;: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models.  | 
  **merchant_ids** | **String**| A list of merchant IDs to query. | [optional] 
 
 ### Return type
@@ -1166,7 +1173,8 @@ const opts = {
   'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
   'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
   'keyword': "keyword",
-  'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479"
+  'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+  'wallet_setup': new CoboWaas2.WalletSetup()
 };
 apiInstance.listMerchants(opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -1186,6 +1194,7 @@ Name | Type | Description  | Notes
  **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.  | [optional] 
  **keyword** | **String**| A search term used for fuzzy matching of merchant names. | [optional] 
  **wallet_id** | **String**| The wallet ID. | [optional] 
+ **wallet_setup** | [**WalletSetup**](.md)| WalletSetup defines the type of funds used in the merchant account, either \&quot;Shared\&quot; or \&quot;Separate\&quot; is allowed when creating a merchant: - &#x60;Default&#x60;: Wallet of psp owned default merchant. - &#x60;Shared&#x60;: Shared wallet of non-psp owned merchants. - &#x60;Separate&#x60;: Separate wallet of non-psp owned merchants.  | [optional] 
 
 ### Return type
 
@@ -1315,7 +1324,7 @@ This endpoint does not need any parameter.
 
 List payment wallet balances
 
-This operation retrieves the information of payment wallet balances. 
+&lt;Warning&gt;This operation has been deprecated.&lt;/Warning&gt; This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the &#x60;wallet_ids&#x60; parameter, the balance information for all payment wallets will be returned. 
 
 ### Example
 
@@ -1481,9 +1490,69 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## listTopUpPayerAccounts
+
+> ListTopUpPayerAccounts200Response listTopUpPayerAccounts(opts)
+
+List top-up payer accounts
+
+This operation retrieves the accounts of all payers. You can filter the result by merchant ID and payer_id. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PaymentApi();
+const opts = {
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
+  'merchant_id': "M1001",
+  'payer_id': "P20250619T0310056d7aa"
+};
+apiInstance.listTopUpPayerAccounts(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
+ **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.  | [optional] 
+ **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.  | [optional] 
+ **merchant_id** | **String**| The merchant ID. | [optional] 
+ **payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional] 
+
+### Return type
+
+[**ListTopUpPayerAccounts200Response**](ListTopUpPayerAccounts200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## listTopUpPayers
 
-> ListTopUpPayers200Response listTopUpPayers(merchant_id, opts)
+> ListTopUpPayers200Response listTopUpPayers(opts)
 
 List payers
 
@@ -1501,14 +1570,14 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
 apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
 // Call the API
 const apiInstance = new CoboWaas2.PaymentApi();
-const merchant_id = "M1001";
 const opts = {
   'limit': 10,
   'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
   'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
+  'merchant_id': "M1001",
   'payer_id': "P20250619T0310056d7aa"
 };
-apiInstance.listTopUpPayers(merchant_id, opts).then((data) => {
+apiInstance.listTopUpPayers(opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
   console.error(error);
@@ -1521,10 +1590,10 @@ apiInstance.listTopUpPayers(merchant_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **merchant_id** | **String**| The merchant ID. | 
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
  **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.  | [optional] 
  **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.  | [optional] 
+ **merchant_id** | **String**| The merchant ID. | [optional] 
  **payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional] 
 
 ### Return type
@@ -1541,6 +1610,112 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## paymentEstimateFee
+
+> PaymentEstimateFee201Response paymentEstimateFee(opts)
+
+Payment estimate fee
+
+This operation to payment estimate fee. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PaymentApi();
+const opts = {
+  'PaymentEstimateFeeRequest': new CoboWaas2.PaymentEstimateFeeRequest()
+};
+apiInstance.paymentEstimateFee(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **PaymentEstimateFeeRequest** | [**PaymentEstimateFeeRequest**](PaymentEstimateFeeRequest.md)| The request body to create a estimated fee request. | [optional] 
+
+### Return type
+
+[**PaymentEstimateFee201Response**](PaymentEstimateFee201Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## updateBankAccountById
+
+> BankAccount updateBankAccountById(bank_account_id, opts)
+
+Update bank account
+
+This operation updates the information of an existing bank account. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PaymentApi();
+const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+const opts = {
+  'UpdateBankAccountByIdRequest': new CoboWaas2.UpdateBankAccountByIdRequest()
+};
+apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **bank_account_id** | **String**| The bank account ID. | 
+ **UpdateBankAccountByIdRequest** | [**UpdateBankAccountByIdRequest**](UpdateBankAccountByIdRequest.md)| The request body for updating an existing bank account. | [optional] 
+
+### Return type
+
+[**BankAccount**](BankAccount.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## updateMerchantById
 
 > Merchant updateMerchantById(merchant_id, opts)

package/docs/PaymentEstimateFee.md

@@ -0,0 +1,10 @@
+# CoboWaas2.PaymentEstimateFee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The ID of the cryptocurrency you want to OffRamp settle. | 
+**amount** | **String** | The OffRamp settlement amount.  | 
+
+

package/docs/PaymentEstimateFee201Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.PaymentEstimateFee201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[PaymentEstimatedFee]**](PaymentEstimatedFee.md) |  | [optional] 
+
+

package/docs/PaymentEstimateFeeRequest.md

@@ -0,0 +1,10 @@
+# CoboWaas2.PaymentEstimateFeeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fee_type** | [**PaymentFeeType**](PaymentFeeType.md) |  | [optional] 
+**estimate_fees** | [**[PaymentEstimateFee]**](PaymentEstimateFee.md) |  | 
+
+

package/docs/PaymentEstimatedFee.md

@@ -0,0 +1,13 @@
+# CoboWaas2.PaymentEstimatedFee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The ID of the cryptocurrency you want to payment. | 
+**amount** | **String** | The payment amount.  | 
+**commission_fee** | [**CommissionFee**](CommissionFee.md) |  | [optional] 
+**bridging_fee** | [**BridgingFee**](BridgingFee.md) |  | [optional] 
+**otc_fee** | [**OtcFee**](OtcFee.md) |  | [optional] 
+
+

package/docs/PaymentFeeType.md

@@ -0,0 +1,16 @@
+# CoboWaas2.PaymentFeeType
+
+## Enum
+
+
+* `Order` (value: `"Order"`)
+
+* `Refund` (value: `"Refund"`)
+
+* `CryptoSettlement` (value: `"CryptoSettlement"`)
+
+* `OffRampSettlement` (value: `"OffRampSettlement"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/PaymentOrderEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
 **order_id** | **String** | The order ID. | 
 **merchant_id** | **String** | The merchant ID. | [optional] 
 **token_id** | **String** |  The ID of the cryptocurrency used for payment. Supported tokens:  - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
@@ -60,6 +60,8 @@ Name | Type | Description | Notes
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
 
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentRefundEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
 **request_id** | **String** | The request ID provided by you when creating the refund request. | [optional] 
 **refund_id** | **String** | The refund order ID. | 
 **order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional] 
@@ -17,11 +17,12 @@ Name | Type | Description | Notes
 **refund_type** | [**RefundType**](RefundType.md) |  | [optional] 
 **created_timestamp** | **Number** | The creation time of the refund order, represented as a UNIX timestamp in seconds. | [optional] 
 **updated_timestamp** | **Number** | The last update time of the refund order, represented as a UNIX timestamp in seconds. | [optional] 
-**initiator** | **String** |  The initiator of this settlement request. Can return either an API key or the Payment Management App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID.  | [optional] 
+**initiator** | **String** |  The initiator of this settlement request. Can return either an API key or the Payments App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID.  | [optional] 
 **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional] 
 **charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund.    - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance    - `false`: The merchant is not charged any developer fee.  | [optional] 
 **merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional] 
 **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional] 
+**commission_fee** | [**CommissionFee**](CommissionFee.md) |  | [optional] 
 
 
 
@@ -58,6 +59,8 @@ Name | Type | Description | Notes
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
 
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentSettlementEvent.md

@@ -4,17 +4,20 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
 **settlement_request_id** | **String** | The settlement request ID generated by Cobo. | 
 **request_id** | **String** | The request ID provided by you when creating the settlement request. | 
 **status** | [**SettleRequestStatus**](SettleRequestStatus.md) |  | 
 **settlements** | [**[SettlementDetail]**](SettlementDetail.md) |  | 
-**created_timestamp** | **Number** | The creation time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The last update time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
-**initiator** | **String** |  The initiator of this settlement request. Can return either an API key or the Payment Management App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID.  | [optional] 
+**created_timestamp** | **Number** | The created time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The updated time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
+**initiator** | **String** |  The initiator of this settlement request. Can return either an API key or the Payments App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID.  | [optional] 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
 **settlement_type** | [**SettlementType**](SettlementType.md) |  | [optional] 
+**currency** | **String** | The fiat currency for the settlement request. | [optional] 
+**received_amount_fiat** | **String** | The received fiat amount of this settlement request.  | [optional] 
+**bank_account** | [**BankAccount**](BankAccount.md) |  | [optional] 
 
 
 
@@ -51,6 +54,8 @@ Name | Type | Description | Notes
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
 
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentTransactionEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
 **transaction_id** | **String** | The transaction ID. | 
 **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional] 
 **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional] 
@@ -77,6 +77,8 @@ Name | Type | Description | Notes
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
 
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentWalletBalance.md

@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **wallet_id** | **String** | The unique identifier of the wallet. | 
-**token_id** | **String** | The ID of the cryptocurrency. | 
-**swept_balance** | **String** | The payment wallet swept balance. | [optional] 
-**available_balance** | **String** | The payment wallet available balance. | [optional] 
-**total_balance** | **String** | The payment wallet total balance. | [optional] 
-**above_sweep_threshold_balance** | **String** | The payment wallet above sweep threshold balance. | [optional] 
+**token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. | 
+**swept_balance** | **String** | The total amount of the token on the sweep-to address of the payment wallet. | [optional] 
+**available_balance** | **String** | The balance available for settlement or refund, in the specified cryptocurrency. | [optional] 
+**total_balance** | **String** | The total balance of the token for the payment wallet. | [optional] 
+**above_sweep_threshold_balance** | **String** | The total amount of funds that exceed the sweep threshold across all receiving addresses in the payment wallet. When the balance on a receiving address exceeds the sweep threshold, those funds become eligible for automatic sweeping and are included in this balance. | [optional] 
 
 

package/docs/PspBalance.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token_id** | **String** | The ID of the cryptocurrency. | 
-**developer_fee_amount** | **String** | The psp developer fee amount. | [optional] 
-**settled_amount** | **String** | The psp settled amount. | [optional] 
-**refunded_amount** | **String** | The psp total refunded amount. | [optional] 
-**total_balance** | **String** | The psp total balance. | [optional] 
-**available_balance** | **String** | The psp available balance. | [optional] 
+**token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. | 
+**developer_fee_amount** | **String** | The total amount of the token that has been received as developer fee. | [optional] 
+**settled_amount** | **String** | The total amount of the token that has been paid out from the developer's balance. | [optional] 
+**refunded_amount** | **String** | The total amount of the token that has been refunded from the developer's balance. | [optional] 
+**total_balance** | **String** |  The total balance of the token available for payout or refund for the developer.  `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount`  For more information, please refer to [Amounts and Balances](/v2_cn/payments/amounts-and-balances)  | [optional] 
+**available_balance** | **String** | This field has been deprecated. | [optional]