@cobo/cobo-waas2 1.17.0 → 1.18.0

package/docs/PaymentApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**cancelRefundById**](PaymentApi.md#cancelRefundById) | **PUT** /payments/refunds/{refund_id}/cancel | Cancel refund order
 [**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
 [**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
 [**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
@@ -14,17 +15,70 @@ Method | HTTP request | Description
 [**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
 [**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
+[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Get top-up address
 [**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
 [**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
 [**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
 [**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
 [**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List all supported tokens
 [**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
+[**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
 [**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 information
 
 
 
+## cancelRefundById
+
+> Refund cancelRefundById(refund_id)
+
+Cancel refund order
+
+This operation cancels a specified refund order. 
+
+### 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 refund_id = "R20250304-M1001-1001";
+apiInstance.cancelRefundById(refund_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **refund_id** | **String**| The refund order ID. | 
+
+### Return type
+
+[**Refund**](Refund.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## createMerchant
 
 > Merchant createMerchant(opts)
@@ -187,7 +241,7 @@ Name | Type | Description  | Notes
 
 Create settlement request
 
-This operation creates a settlement request to withdraw available balances.   You can include multiple merchants and cryptocurrencies in a single settlement request. 
+This operation creates a settlement request to withdraw available balances. 
 
 ### Example
 
@@ -268,7 +322,7 @@ apiInstance.getExchangeRate(token_id, currency).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **token_id** | **String**| The token ID, which identifies the cryptocurrency. Supported values:    - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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;  | 
+ **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_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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;  | 
  **currency** | **String**| The fiat currency. Currently, only &#x60;USD&#x60; is supported. | [default to &#39;USD&#39;]
 
 ### Return type
@@ -517,7 +571,8 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
 const apiInstance = new CoboWaas2.PaymentApi();
 const opts = {
   'merchant_ids': "M1001,M1002,M1003",
-  'currency': "USD"
+  'currency': "USD",
+  'acquiring_type': new CoboWaas2.AcquiringType()
 };
 apiInstance.getSettlementInfoByIds(opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -534,6 +589,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **merchant_ids** | **String**| A list of merchant IDs to query. | [optional] 
  **currency** | **String**| The currency for the operation. Currently, only &#x60;USD&#x60; is supported. | [optional] [default to &#39;USD&#39;]
+ **acquiring_type** | [**AcquiringType**](.md)|  | [optional] 
 
 ### Return type
 
@@ -549,6 +605,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## getTopUpAddress
+
+> TopUpAddress getTopUpAddress(merchant_id, token_id, custom_payer_id)
+
+Get top-up address
+
+This operation retrieves the information of the dedicated top-up address assigned to a specific payer under a merchant on a specified chain. 
+
+### 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 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) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+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_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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. | 
+
+### Return type
+
+[**TopUpAddress**](TopUpAddress.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## listBankAccounts
 
 > [BankAccount] listBankAccounts()
@@ -601,7 +711,7 @@ This endpoint does not need any parameter.
 
 List crypto addresses
 
-Retrieve a list of cryptocurrency addresses previously created for a given &#x60;token_id&#x60;. 
+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. 
 
 ### Example
 
@@ -631,7 +741,7 @@ apiInstance.listCryptoAddresses(opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **token_id** | **String**| The token ID, which identifies the cryptocurrency. Supported values:    - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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;  | [optional] 
+ **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_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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;  | [optional] 
 
 ### Return type
 
@@ -751,7 +861,7 @@ Name | Type | Description  | Notes
  **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] 
- **psp_order_id** | **String**| The PSP order ID. | [optional] 
+ **psp_order_id** | **String**| A unique reference code assigned by the developer to identify this order in their system. | [optional] 
 
 ### Return type
 
@@ -871,6 +981,66 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## listTopUpPayers
+
+> ListTopUpPayers200Response listTopUpPayers(merchant_id, opts)
+
+List payers
+
+This operation retrieves the information of all payers under a merchant.   You can filter the result by the 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 merchant_id = "M1001";
+const opts = {
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
+  'payer_id': "P20250619T0310056d7aa"
+};
+apiInstance.listTopUpPayers(merchant_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+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] 
+ **payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional] 
+
+### Return type
+
+[**ListTopUpPayers200Response**](ListTopUpPayers200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## updateMerchantById
 
 > Merchant updateMerchantById(merchant_id, opts)
@@ -978,3 +1148,57 @@ Name | Type | Description  | Notes
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## updateRefundById
+
+> Refund updateRefundById(refund_id, opts)
+
+Update refund order information
+
+This operation updates a specified refund order. 
+
+### 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 refund_id = "R20250304-M1001-1001";
+const opts = {
+  'UpdateRefundByIdRequest': new CoboWaas2.UpdateRefundByIdRequest()
+};
+apiInstance.updateRefundById(refund_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **refund_id** | **String**| The refund order ID. | 
+ **UpdateRefundByIdRequest** | [**UpdateRefundByIdRequest**](UpdateRefundByIdRequest.md)| The request body to update a refund order. | [optional] 
+
+### Return type
+
+[**Refund**](Refund.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

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. | 
+**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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement 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_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
@@ -20,9 +20,10 @@ Name | Type | Description | Notes
 **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | 
 **status** | [**OrderStatus**](OrderStatus.md) |  | 
 **received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). | 
-**created_timestamp** | **Number** | The created time of the order, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The updated time of the order, represented as a UNIX timestamp in seconds. | [optional] 
-**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the settlement process. | [optional] 
+**created_timestamp** | **Number** | The creation time of the order, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The last update time of the order, represented as a UNIX timestamp in seconds. | [optional] 
+**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the pay-in process. | [optional] 
+**settlement_status** | [**SettleStatus**](SettleStatus.md) |  | [optional] 
 
 
 
@@ -45,6 +46,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)

package/docs/PaymentRefundEventData.md

@@ -4,10 +4,10 @@
 
 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. | 
+**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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement 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 order ID corresponding to this refund. | [optional] 
+**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional] 
 **merchant_id** | **String** | The merchant ID. | [optional] 
 **token_id** | **String** | The ID of the cryptocurrency used for refund. | 
 **chain_id** | **String** | The ID of the blockchain network on which the refund transaction occurs. | 
@@ -15,10 +15,13 @@ Name | Type | Description | Notes
 **to_address** | **String** | The recipient's wallet address where the refund will be sent. | 
 **status** | [**RefundStatus**](RefundStatus.md) |  | 
 **refund_type** | [**RefundType**](RefundType.md) |  | [optional] 
-**created_timestamp** | **Number** | The created time of the refund order, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The updated time of the refund order, represented as a UNIX timestamp in seconds. | [optional] 
-**initiator** | **String** | The initiator of this refund order, usually the user's API key. | [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] 
 **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] 
 
 
 
@@ -41,6 +44,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)

package/docs/PaymentSettlementEvent.md

@@ -4,14 +4,14 @@
 
 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. | 
+**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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement 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 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, usually the user's API key. | [optional] 
+**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] 
 
 
 
@@ -34,6 +34,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)

package/docs/RefreshPermissionTokenRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**refresh_token** | **String** | The Refresh Token of the current Org Access Token. | 
+**refresh_token** | **String** | The Refresh Token of the current Access Token. | 
 
 

package/docs/Refund.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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 order ID corresponding to this refund. | [optional] 
+**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional] 
 **merchant_id** | **String** | The merchant ID. | [optional] 
 **token_id** | **String** | The ID of the cryptocurrency used for refund. | 
 **chain_id** | **String** | The ID of the blockchain network on which the refund transaction occurs. | 
@@ -14,9 +14,12 @@ Name | Type | Description | Notes
 **to_address** | **String** | The recipient's wallet address where the refund will be sent. | 
 **status** | [**RefundStatus**](RefundStatus.md) |  | 
 **refund_type** | [**RefundType**](RefundType.md) |  | [optional] 
-**created_timestamp** | **Number** | The created time of the refund order, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The updated time of the refund order, represented as a UNIX timestamp in seconds. | [optional] 
-**initiator** | **String** | The initiator of this refund order, usually the user's API key. | [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] 
 **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] 
 
 

package/docs/RefundStatus.md

@@ -13,6 +13,8 @@
 
 * `Failed` (value: `"Failed"`)
 
+* `PendingConfirmation` (value: `"PendingConfirmation"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/SOLBase.md

@@ -0,0 +1,10 @@
+# CoboWaas2.SOLBase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_fee** | **String** | The fundamental fee required for each transaction. It is charged to prevent spam transactions and network congestion, ensuring that only meaningful transactions consume network resources. | [optional] 
+**rent_amount** | **String** | The fee charged as rent for maintaining the state of accounts on the blockchain. This rent ensures accounts are stored on-chain over the long term and that there's sufficient balance to sustain the account state. | [optional] 
+
+

package/docs/SOLComputeUnit.md

@@ -0,0 +1,10 @@
+# CoboWaas2.SOLComputeUnit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**compute_unit_price** | **String** | The cost per compute unit. Transactions consume computational resources measured in compute units, and this price helps determine the cost of executing transactions, especially complex ones involving smart contracts. | [optional] 
+**compute_unit_limit** | **String** | The maximum number of compute units allowed for a transaction. This limits the resources any single transaction can consume, preventing excessive resource usage that could impact network performance negatively. | [optional] 
+
+

package/docs/Settlement.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 **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 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, usually the user's API key. | [optional] 
+**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] 
 
 

package/docs/SettlementDetail.md

@@ -7,15 +7,16 @@ Name | Type | Description | Notes
 **currency** | **String** | The fiat currency for the settlement. | [optional] 
 **token_id** | **String** | The ID of the cryptocurrency settled. | [optional] 
 **chain_id** | **String** | The ID of the blockchain network on which the settlement occurred. | [optional] 
-**merchant_id** | **String** | The Merchant ID associated with this settlement. | [optional] 
-**amount** | **String** | The settlement amount.  - If `token_id` is specified, this represents the settlement amount in the specified cryptocurrency.  - If `token_id` is not specified, this represents the settlement amount in the specified fiat currency.  | [optional] 
-**settled_amount** | **String** | The settled amount of this settlement detail.  - If `token_id` is specified, this represents the actual settled amount in the specified cryptocurrency.  - If `token_id` is not specified, this represents the actual settled amount in the specified fiat currency.  | [optional] 
+**merchant_id** | **String** | The ID of the merchant associated with this settlement. | [optional] 
+**amount** | **String** | The settlement amount. - 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] 
+**settled_amount** | **String** | The settled amount of this settlement detail.  - If `payout_channel` is set to `Crypto`, this represents the actual settled amount in the specified cryptocurrency.  - If `payout_channel` is set to `OffRamp`, this represents the actual settled amount in the specified fiat currency.  | [optional] 
 **status** | [**SettleStatus**](SettleStatus.md) |  | [optional] 
 **bank_account** | [**BankAccount**](BankAccount.md) |  | [optional] 
 **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this settlement request. Each transaction represents a separate blockchain operation related to the settlement process. | [optional] 
-**created_timestamp** | **Number** | The created time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The updated time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
-**crypto_address_id** | **String** | Unique identifier for the pre-approved crypto address, used to reference the address securely in requests. | [optional] 
+**created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
+**crypto_address_id** | **String** | The ID of the crypto address used for crypto withdrawal. | [optional] 
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
+**acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
 
 

package/docs/SettlementInfo.md

@@ -11,7 +11,8 @@ Name | Type | Description | Notes
 **pending_amount** | **String** | The amount unavailable for settlement or refund, in the specified cryptocurrency. | [optional] 
 **pending_currency_balance** | **String** | The amount unavailable for settlement or refund, in the specified fiat currency. | [optional] 
 **settled_amount** | **String** | The amount already settled, in the specified cryptocurrency. | [optional] 
-**created_timestamp** | **Number** | The created time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The updated time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
+**acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
+**created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
 
 

package/docs/SwapActivityDetail.md

@@ -22,5 +22,6 @@ Name | Type | Description | Notes
 **updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional] 
 **timeline** | [**[SwapActivityTimeline]**](SwapActivityTimeline.md) |  | [optional] 
 **approvers** | [**[SwapActivityApprovers]**](SwapActivityApprovers.md) |  | [optional] 
+**signers** | [**[SwapActivitySigners]**](SwapActivitySigners.md) |  | [optional] 
 
 

package/docs/SwapActivitySigners.md

@@ -0,0 +1,11 @@
+# CoboWaas2.SwapActivitySigners
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signer** | **String** | The signer name. | [optional] 
+**status** | [**SwapSingingStatus**](SwapSingingStatus.md) |  | [optional] 
+**failed_reason** | **String** | Failed reason of signing process. | [optional] 
+
+

package/docs/SwapQuote.md

@@ -9,8 +9,9 @@ Name | Type | Description | Notes
 **pay_amount** | **String** | The amount of tokens to pay. | 
 **receive_token_id** | **String** | The token ID to receive. | 
 **receive_amount** | **String** | The amount of tokens to receive. | 
-**fee_token_id** | **String** | The fee token ID. | 
-**fee_amount** | **String** | The amount of tokens to pay for fee. | 
+**fee_token_id** | **String** | The token ID for the service fee. | 
+**fee_amount** | **String** | The amount of tokens for the service fee. | 
+**estimated_network_fee_amount** | **String** | The estimated amount of tokens for the network fee. | [optional] 
 **min_receive_amount** | **String** | The minimum amount of tokens to receive if the pay amount is specified. | [optional] 
 **max_pay_amount** | **String** | The maximum amount of tokens to pay if the receive amount is specified. | [optional] 
 **quote_expired_timestamp** | **Number** | The time when the quote will expire, in Unix timestamp format, measured in milliseconds. | 

package/docs/SwapSingingStatus.md

@@ -0,0 +1,16 @@
+# CoboWaas2.SwapSingingStatus
+
+## Enum
+
+
+* `Pending` (value: `"Pending"`)
+
+* `Signed` (value: `"Signed"`)
+
+* `Timeout` (value: `"Timeout"`)
+
+* `Rejected` (value: `"Rejected"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/TSSRequestWebhookEventData.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. | 
+**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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. | 
 **tss_request_id** | **String** | The TSS request ID. | [optional] 
 **source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) |  | [optional] 
 **target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional] 
@@ -34,6 +34,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)