@cobo/cobo-waas2 1.22.0 → 1.23.0

package/docs/ComplianceApi.md

@@ -0,0 +1,218 @@
+# CoboWaas2.ComplianceApi
+
+All URIs are relative to *https://api.dev.cobo.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getDispositionStatus**](ComplianceApi.md#getDispositionStatus) | **GET** /compliance/funds/disposition | Get disposition status
+[**isolateFunds**](ComplianceApi.md#isolateFunds) | **POST** /compliance/funds/disposition/isolate | Isolate funds
+[**refundFunds**](ComplianceApi.md#refundFunds) | **POST** /compliance/funds/disposition/refund | Refund funds
+[**unfreezeFunds**](ComplianceApi.md#unfreezeFunds) | **POST** /compliance/funds/disposition/unfreeze | Unfreeze frozen funds
+
+
+
+## getDispositionStatus
+
+> DispositionQueryResponse getDispositionStatus(transaction_id)
+
+Get disposition status
+
+This operation retrieves the current status of a disposition request for a specific transaction.  You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze)  that has been initiated for a transaction. The response includes the disposition type, current status,  and the disposition transaction ID if applicable.  <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note> 
+
+### 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.ComplianceApi();
+const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+apiInstance.getDispositionStatus(transaction_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **String**| The UUID of the transaction to query for disposition status. | 
+
+### Return type
+
+[**DispositionQueryResponse**](DispositionQueryResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## isolateFunds
+
+> DispositionResponse isolateFunds(opts)
+
+Isolate funds
+
+This operation creates a request to isolate funds for a specific transaction. The funds will be sent to a designated isolation address for compliance purposes.  You need to specify the transaction ID to be isolated and the destination address.  Optional parameters include custom categories for tracking purposes.  &lt;Note&gt;The isolation will initiate a withdrawal transaction from the compliance-managed address to the specified isolation address.&lt;/Note&gt; 
+
+### 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.ComplianceApi();
+const opts = {
+  'IsolateDisposition': new CoboWaas2.IsolateDisposition()
+};
+apiInstance.isolateFunds(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **IsolateDisposition** | [**IsolateDisposition**](IsolateDisposition.md)| The request body to isolate funds. | [optional] 
+
+### Return type
+
+[**DispositionResponse**](DispositionResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## refundFunds
+
+> DispositionResponse refundFunds(opts)
+
+Refund funds
+
+This operation creates a request to refund funds for a specific transaction. The funds will be sent to the specified destination address.  You need to specify the transaction ID to be refunded and the destination address.  Optional parameters include custom categories for tracking purposes.  &lt;Note&gt;The refund will initiate a withdrawal transaction from the compliance-managed address to the specified destination.&lt;/Note&gt; 
+
+### 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.ComplianceApi();
+const opts = {
+  'RefundDisposition': new CoboWaas2.RefundDisposition()
+};
+apiInstance.refundFunds(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **RefundDisposition** | [**RefundDisposition**](RefundDisposition.md)| The request body to refund funds. | [optional] 
+
+### Return type
+
+[**DispositionResponse**](DispositionResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## unfreezeFunds
+
+> DispositionResponse unfreezeFunds(opts)
+
+Unfreeze frozen funds
+
+This operation creates a request to unfreeze funds for a previously frozen transaction. It releases the frozen funds back to their original state.  You only need to specify the transaction ID to be unfrozen. Once unfrozen, the funds will be available for normal operations.  &lt;Note&gt;The unfreeze process will release the compliance hold on the transaction, allowing it to proceed normally.&lt;/Note&gt; 
+
+### 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.ComplianceApi();
+const opts = {
+  'UnfreezeDisposition': new CoboWaas2.UnfreezeDisposition()
+};
+apiInstance.unfreezeFunds(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **UnfreezeDisposition** | [**UnfreezeDisposition**](UnfreezeDisposition.md)| The request body to unfreeze funds. | [optional] 
+
+### Return type
+
+[**DispositionResponse**](DispositionResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

package/docs/ComplianceDispositionUpdateEventData.md

@@ -0,0 +1,56 @@
+# CoboWaas2.ComplianceDispositionUpdateEventData
+
+## Properties
+
+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. - `ComplianceDisposition`: The compliance disposition event data. | 
+**transaction_id** | **String** | The transaction ID. | 
+**disposition_type** | [**DispositionType**](DispositionType.md) |  | 
+**disposition_status** | [**DispositionStatus**](DispositionStatus.md) |  | 
+**destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional] 
+**disposition_amount** | **String** | The amount to be refunded/isolated from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction.  | [optional] 
+**updated_timestamp** | **Number** | The time when the disposition was updated, in Unix timestamp format, measured in milliseconds. | 
+
+
+
+## Enum: DataTypeEnum
+
+
+* `Transaction` (value: `"Transaction"`)
+
+* `TSSRequest` (value: `"TSSRequest"`)
+
+* `Addresses` (value: `"Addresses"`)
+
+* `WalletInfo` (value: `"WalletInfo"`)
+
+* `MPCVault` (value: `"MPCVault"`)
+
+* `Chains` (value: `"Chains"`)
+
+* `Tokens` (value: `"Tokens"`)
+
+* `TokenListing` (value: `"TokenListing"`)
+
+* `PaymentOrder` (value: `"PaymentOrder"`)
+
+* `PaymentRefund` (value: `"PaymentRefund"`)
+
+* `PaymentSettlement` (value: `"PaymentSettlement"`)
+
+* `PaymentTransaction` (value: `"PaymentTransaction"`)
+
+* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
+
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
+* `SuspendedToken` (value: `"SuspendedToken"`)
+
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/CreateAddressBookParam.md

@@ -0,0 +1,13 @@
+# CoboWaas2.CreateAddressBookParam
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chain_ids** | **[String]** | A list of chain IDs. | 
+**address** | **String** | The wallet address. | 
+**memo** | **String** | Optional memo or tag required by some chains. | [optional] 
+**label** | **String** | A user-defined label for the address. | [optional] 
+**email** | **String** | The email of the address owner. | [optional] 
+
+

package/docs/CreateAddressBooks201Response.md

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

package/docs/CreateAddressBooksParam.md

@@ -0,0 +1,9 @@
+# CoboWaas2.CreateAddressBooksParam
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_books** | [**[CreateAddressBookParam]**](CreateAddressBookParam.md) |  | 
+
+

package/docs/CreateAutoSweepTask.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**wallet_id** | **String** | The wallet ID. | 
-**token_id** | **String** | The token ID of the swept token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | 
+**wallet_id** | **String** | ID of the wallet where the token will be swept. | 
+**token_id** | **String** | ID of the token to be swept. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | 
 
 

package/docs/CreateCustodialWalletParams.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional] 
 
 

package/docs/CreateExchangeWalletParams.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional] 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | 
 **apikey** | **String** | The API key of your exchange account. | 
 **secret** | **String** | The API secret of your exchange account. | 

package/docs/CreateMerchantRequest.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The merchant name. | 
 **wallet_id** | **String** | The ID of the wallet linked to the merchant. | 
-**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. | [optional] 
+**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. If you are a merchant (directly serving the payer), you do not need to configure the developer fee rate. | [optional] 
 
 

package/docs/CreateMpcWalletParams.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional] 
 **vault_id** | **String** | The ID of the owning vault. You can call [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults) to retrieve all vault IDs under your organization. | 
 
 

package/docs/CreatePaymentOrderRequest.md

@@ -8,10 +8,10 @@ Name | Type | Description | Notes
 **token_id** | **String** | The ID of the cryptocurrency used for payment. Supported values:    - 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`  | 
 **currency** | **String** | The fiat currency for the base order amount and the developer fee. Currently, only `USD` is supported.  If left empty, both `order_amount` and `fee_amount` will be denominated in the cryptocurrency specified by `token_id`  | [optional] [default to '']
 **order_amount** | **String** |  The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`. If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`.   Values must be greater than `0` and contain two decimal places.   | 
-**fee_amount** | **String** |  The developer fee for the order, in the currency specified by `currency`. If `currency` is not specified, the fee is in the cryptocurrency specified by `token_id`.  The developer fee is added to the base amount (`order_amount`) to determine the final charge. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\"  - Total charged to customer: \"102.00\"  Values must be greater than 0 and contain two decimal places.  | 
+**fee_amount** | **String** |  The developer fee for the order, in the currency specified by `currency`. If `currency` is not specified, the fee is in the cryptocurrency specified by `token_id`.  If you are a merchant directly serving payers, set this field to `0`. Developer fees are only relevant for platforms like payment service providers (PSPs) that charge fees to their downstream merchants.  The developer fee is added to the base amount (`order_amount`) to determine the final charge. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\"  - Total charged to customer: \"102.00\"  Values can contain up to two decimal places.  | 
 **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters. | [optional] 
 **psp_order_code** | **String** | A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters.  | 
-**expired_in** | **Number** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. After expiration: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event.  | [optional] [default to 1800]
+**expired_in** | **Number** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration:  - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event.  | [optional] [default to 1800]
 **use_dedicated_address** | **Boolean** | Whether to allocate a dedicated address for this order.  - `true`: A dedicated address will be allocated for this order. - `false`: A shared address from the address pool will be used.  | [optional] 
 
 

package/docs/CreateRefundRequest.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **request_id** | **String** | The request ID that is used to track a refund request. The request ID is provided by you and must be unique. | 
 **merchant_id** | **String** | The merchant ID. | [optional] 
-**payable_amount** | **String** | The amount to refund in cryptocurrency. The amount must be a positive integer with up to two decimal places. | 
+**payable_amount** | **String** | The amount to refund in cryptocurrency. The amount must be a positive number and can have up to two decimal places | 
 **to_address** | **String** | The address where the refunded cryptocurrency will be sent. | [optional] 
 **token_id** | **String** | The ID of the cryptocurrency used for refund. Supported values:    - 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`  | 
 **refund_type** | [**RefundType**](RefundType.md) |  | 

package/docs/CreateSafeWalletParams.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional] 
 **chain_id** | **String** | The ID of the chain that the wallet operates on. | 
 **smart_contract_wallet_type** | [**SmartContractWalletType**](SmartContractWalletType.md) |  | 
 **safe_address** | **String** | The address of the Smart Contract Wallet. If this is not provided, Cobo will create a new Safe{Wallet} and set up Cobo Safe for you. In that case, the `threshold` and `signers` properties are required. | [optional] 

package/docs/CreateSettlement.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **merchant_id** | **String** | The merchant ID. Specify this field when `settlement_type` is set to `Merchant`. | [optional] 
 **token_id** | **String** | The ID of the cryptocurrency you want to settle. Specify this field when `payout_channel` is set to `Crypto`. Supported values:  - 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`  | 
 **currency** | **String** | The fiat currency for settling the cryptocurrency. Currently, only `USD` is supported. Specify this field when `payout_channel` is set to `OffRamp`. | [optional] 
-**amount** | **String** | The settlement amount. When settling merchant balance from orders (`acquiring_type` is `Order` and `settlement_type` is `Merchant`), do not specify this field as the settlement amount will be automatically calculated based on the order amounts. - If `payout_channel` is set to `Crypto`, this represents the settlement amount in the specified cryptocurrency. - If `payout_channel` is set to `OffRamp`, this represents the settlement amount in the specified fiat currency.  | [optional] 
+**amount** | **String** | The amount of cryptocurrency to be settled. When settling merchant balance from orders (`acquiring_type` is `Order` and `settlement_type` is `Merchant`), do not specify this field as the amount will be automatically calculated based on the order amounts.  | [optional] 
 **bank_account_id** | **String** | The ID of the bank account where the settled funds will be deposited. This field is only applicable when `payout_channel` is set to `OffRamp`. Call [List all bank accounts](/v2/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts.  | [optional] 
 **crypto_address_id** | **String** | The ID of the crypto address used for crypto withdrawal. Specify this field when `payout_channel` is set to `Crypto`.  Call [List all crypto addresses](/v2/api-references/payments/list-all-crypto-addresses) to retrieve registered crypto addresses.  | [optional] 
 **order_ids** | **[String]** |  | [optional] 

package/docs/CreateSmartContractWalletParams.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional] 
 **chain_id** | **String** | The ID of the chain that the wallet operates on. | 
 **smart_contract_wallet_type** | [**SmartContractWalletType**](SmartContractWalletType.md) |  | 
 **safe_address** | **String** | The address of the Smart Contract Wallet. If this is not provided, Cobo will create a new Safe{Wallet} and set up Cobo Safe for you. In that case, the `threshold` and `signers` properties are required. | [optional] 

package/docs/CreateWalletParams.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional] 
 **vault_id** | **String** | The ID of the owning vault. You can call [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults) to retrieve all vault IDs under your organization. | 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | 
 **apikey** | **String** | The API key of your exchange account. | 

package/docs/DeleteAddressBookById201Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.DeleteAddressBookById201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submitted** | **Boolean** | Whether the request to delete the Address Book entry (record) has been successfully submitted. - `true`: The request has been successfully submitted. - `false`: The request has not been submitted.  | 
+
+

package/docs/DispositionEventData.md

@@ -0,0 +1,14 @@
+# CoboWaas2.DispositionEventData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The transaction ID. | 
+**disposition_type** | [**DispositionType**](DispositionType.md) |  | 
+**disposition_status** | [**DispositionStatus**](DispositionStatus.md) |  | 
+**destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional] 
+**disposition_amount** | **String** | The amount to be refunded/isolated from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction.  | [optional] 
+**updated_timestamp** | **Number** | The time when the disposition was updated, in Unix timestamp format, measured in milliseconds. | 
+
+

package/docs/DispositionQueryResponse.md

@@ -0,0 +1,12 @@
+# CoboWaas2.DispositionQueryResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The UUID of the transaction that the disposition applies to. | 
+**disposition_type** | [**DispositionType**](DispositionType.md) |  | 
+**disposition_status** | [**DispositionStatus**](DispositionStatus.md) |  | 
+**disposition_transaction_id** | **String** | The UUID of the generated disposition transaction (if available). | [optional] 
+
+

package/docs/DispositionResponse.md

@@ -0,0 +1,10 @@
+# CoboWaas2.DispositionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The UUID of the transaction being processed for disposition. | 
+**status** | [**DispositionStatus**](DispositionStatus.md) |  | 
+
+

package/docs/DispositionStatus.md

@@ -0,0 +1,34 @@
+# CoboWaas2.DispositionStatus
+
+## Enum
+
+
+* `Submitted` (value: `"Submitted"`)
+
+* `Refunding` (value: `"Refunding"`)
+
+* `Refunded` (value: `"Refunded"`)
+
+* `RefundFailed` (value: `"RefundFailed"`)
+
+* `Frozen` (value: `"Frozen"`)
+
+* `Unfreezing` (value: `"Unfreezing"`)
+
+* `Unfrozen` (value: `"Unfrozen"`)
+
+* `UnfreezeFailed` (value: `"UnfreezeFailed"`)
+
+* `Isolating` (value: `"Isolating"`)
+
+* `Isolated` (value: `"Isolated"`)
+
+* `IsolateFailed` (value: `"IsolateFailed"`)
+
+* `CoboDisposition` (value: `"CoboDisposition"`)
+
+* `Normal` (value: `"Normal"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/DispositionType.md

@@ -0,0 +1,14 @@
+# CoboWaas2.DispositionType
+
+## Enum
+
+
+* `Unfreeze` (value: `"Unfreeze"`)
+
+* `Refund` (value: `"Refund"`)
+
+* `Isolate` (value: `"Isolate"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/IsolateDisposition.md

@@ -0,0 +1,13 @@
+# CoboWaas2.IsolateDisposition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The UUID of the transaction whose funds are to be isolated. This identifies the original transaction that requires fund isolation. | 
+**destination_address** | **String** | The blockchain address to receive the isolated funds. | 
+**disposition_amount** | **String** | The amount to be isolated from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction.  | 
+**category_names** | **[String]** | Custom categories to identify and track this isolation transaction. Used for transaction classification and reporting. | [optional] 
+**description** | **String** | Additional notes or description for the isolation. | [optional] 
+
+

package/docs/MPCVaultEventData.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. | 
 **vault_id** | **String** | The vault ID. | [optional] 
 **project_id** | **String** | The project ID. | [optional] 
 **name** | **String** | The vault name. | [optional] 
@@ -47,6 +47,8 @@ Name | Type | Description | Notes
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
 
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/Merchant.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **merchant_id** | **String** | The merchant ID. | 
 **name** | **String** | The merchant name. | 
 **wallet_id** | **String** | The ID of the linked wallet. | 
-**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. | [optional] 
+**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. If you are a merchant (directly serving the payer), you do not need to configure the developer fee rate. | [optional] 
 **created_timestamp** | **Number** | The creation time of the merchant, represented as a UNIX timestamp in seconds. | [optional] 
 **updated_timestamp** | **Number** | The last update time of the merchant, represented as a UNIX timestamp in seconds. | [optional] 
 

package/docs/MerchantBalance.md

@@ -5,12 +5,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **merchant_id** | **String** | The merchant ID. | 
-**token_id** | **String** | The ID of the cryptocurrency. | 
+**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}`. | 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | 
-**total_received_amount** | **String** | The merchant total received amount. | [optional] 
-**settled_amount** | **String** | The merchant settled amount. | [optional] 
-**refunded_amount** | **String** | The merchant total refunded amount. | [optional] 
-**total_balance** | **String** | The merchant total balance. | [optional] 
-**available_balance** | **String** | The merchant available balance. | [optional] 
+**total_received_amount** | **String** | The total amount of the token that has been received by the merchant. | [optional] 
+**settled_amount** | **String** | The total amount of the token that has been settled from the merchant's balance. | [optional] 
+**refunded_amount** | **String** | The total amount of the token that has been refunded from the merchant's balance. | [optional] 
+**total_balance** | **String** | The total balance of the token for the merchant. | [optional] 
+**available_balance** | **String** | The balance available for settlement or refund, in the specified cryptocurrency. | [optional] 
 
 

package/docs/OrgInfo.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **org_id** | **String** | The organization ID. | 
+**biz_org_id** | **Number** | An internal business ID assigned by Cobo. Used mainly by Cobo's customer support to locate the organization. | [optional] 
 **name** | **String** | The organization name. | [optional] 
 **created_timestamp** | **Number** | The organization's creation time in Unix timestamp format, measured in milliseconds. | [optional] 
 

package/docs/PaymentAddressUpdateEventData.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. | 
 **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. | 
 **payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. | 
 **chain** | **String** | The chain ID. | 
@@ -46,6 +46,8 @@ Name | Type | Description | Notes
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
 
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)