@cobo/cobo-waas2 1.23.0 → 1.24.0

package/docs/AddressesEventDataAllOfAddresses.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **root_pubkey** | **String** | The root public key of the address. This property applies to MPC Wallets only. | [optional] 
 **taproot_script_tree_hash** | **String** | The information about the new address. | [optional] 
 **taproot_internal_address** | **String** | The Taproot address before tweaking. | [optional] 
+**stellar_trusted_token_ids** | **[String]** | The list of token IDs for which this address has already established trustlines on the Stellar network. | [optional] 
 **wallet_id** | **String** | The wallet ID. | 
 
 

package/docs/BridgingFee.md

@@ -0,0 +1,11 @@
+# CoboWaas2.BridgingFee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fee_amount** | **String** | The bridging fee amount. | 
+**received_token_id** | **String** | The received token id after bridge. | [optional] 
+**received_amount** | **String** | The received amount after bridge. | [optional] 
+
+

package/docs/CommissionFee.md

@@ -0,0 +1,9 @@
+# CoboWaas2.CommissionFee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fee_amount** | **String** | The commission fee amount. | 
+
+

package/docs/ContractCallDestination.md

@@ -9,5 +9,7 @@ Name | Type | Description | Notes
 **value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
 **calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters.  | 
 **instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) |  | 
+**address_lookup_table_accounts** | [**[SolContractCallAddressLookupTableAccount]**](SolContractCallAddressLookupTableAccount.md) |  | [optional] 
+**contract_param** | [**StellarContractCallContractParam**](StellarContractCallContractParam.md) |  | 
 
 

package/docs/ContractCallDestinationType.md

@@ -7,6 +7,8 @@
 
 * `SOL_Contract` (value: `"SOL_Contract"`)
 
+* `STELLAR_Contract` (value: `"STELLAR_Contract"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/CreateMerchantRequest.md

@@ -5,7 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The merchant name. | 
-**wallet_id** | **String** | The ID of the wallet linked to the merchant. | 
+**wallet_id** | **String** | The ID of the wallet linked to the merchant. | [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] 
+**wallet_setup** | [**WalletSetup**](WalletSetup.md) |  | [optional] 
 
 

package/docs/CreatePaymentOrderRequest.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **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. 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] 
+**use_dedicated_address** | **Boolean** | This field has been deprecated.  | [optional] 
+**custom_exchange_rate** | **String** | A custom exchange rate specified by the merchant.   - Only effective when `currency` is `\"USD\"`.   - Expressed as the amount of USD per 1 unit of the specified cryptocurrency.   - If not provided, the system will use the default internal rate.   Example: If the cryptocurrency is USDT and `custom_exchange_rate` = `\"0.99\"`, it means 1 USDT = 0.99 USD.  | [optional] 
 
 

package/docs/CreateSettlement.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 **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 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] 
+**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](https://www.cobo.com/developers/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 payouts. Specify this field when `payout_channel` is set to `Crypto`.  Call [List crypto addresses](https://www.cobo.com/developers/v2/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses.  | [optional] 
 **order_ids** | **[String]** |  | [optional] 
 
 

package/docs/CreateSettlementRequestRequest.md

@@ -9,5 +9,8 @@ Name | Type | Description | Notes
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
 **settlement_type** | [**SettlementType**](SettlementType.md) |  | [optional] 
 **settlements** | [**[CreateSettlement]**](CreateSettlement.md) |  | 
+**bank_account_id** | **String** | ｜ Only used in OffRamp payout channel. The ID of the bank account where the settled funds will be deposited. | [optional] 
+**currency** | **String** | The fiat currency for the settlement request. | [optional] 
+**remark** | **String** | The remark for the settlement request. | [optional] 
 
 

package/docs/CreateSwapActivityRequest.md

@@ -0,0 +1,15 @@
+# CoboWaas2.CreateSwapActivityRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_id** | **String** | The ID of the wallet used to pay. | 
+**address** | **String** | The address of the wallet used to pay. | [optional] 
+**quote_id** | **String** | The unique identifier of the swap quote. | 
+**app_initiator** | **String** | The initiator of the swap activity. It is optional and defaults to your API key if not specified. | [optional] 
+**request_id** | **String** | The request ID of the swap activity. | [optional] 
+**receiver_address** | **String** | The destination address of the swap activity. This property is required only when the swap type is `Bridge` and the wallet is not a Custodial Wallet (Asset Wallet). | [optional] 
+**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | [optional] 
+
+

package/docs/EstimateContractCallFeeParams.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional] 
+**request_id** | **String** | The request ID that is used to track a transaction request. | [optional] 
 **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) |  | 
 **chain_id** | **String** | The chain ID of the chain on which the smart contract is issued. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | 
 **source** | [**ContractCallSource**](ContractCallSource.md) |  | 

package/docs/EstimateFeeParams.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional] 
+**request_id** | **String** | The request ID that is used to track a transaction request. | [optional] 
 **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) |  | 
 **source** | [**ContractCallSource**](ContractCallSource.md) |  | 
 **token_id** | **String** | The token ID of the transferred 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). | 

package/docs/EstimateTransferFeeParams.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional] 
+**request_id** | **String** | The request ID that is used to track a transaction request. | [optional] 
 **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) |  | 
 **source** | [**TransferSource**](TransferSource.md) |  | 
 **token_id** | **String** | The token ID of the transferred 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). | 

package/docs/FeeStationApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**checkFeeStationUsage**](FeeStationApi.md#checkFeeStationUsage) | **POST** /fee_station/check_fee_station_usage | Check Fee Station usage
 [**estimateFeeStationFee**](FeeStationApi.md#estimateFeeStationFee) | **POST** /fee_station/transactions/estimate_fee | Estimate fee for Fee Station transaction
 [**getFeeStationTransactionById**](FeeStationApi.md#getFeeStationTransactionById) | **GET** /fee_station/transactions/{transaction_id} | Get Fee Station transaction information
 [**listFeeStationAddresses**](FeeStationApi.md#listFeeStationAddresses) | **GET** /fee_station/addresses | List Fee Station addresses
@@ -12,6 +13,58 @@ Method | HTTP request | Description
 
 
 
+## checkFeeStationUsage
+
+> FeeStationCheckFeeStationUsageResponse checkFeeStationUsage(opts)
+
+Check Fee Station usage
+
+This operation evaluates Fee Station usage for the current transaction.   It determines whether Fee station can be used, checks if the Fee Station balance is sufficient, and returns a breakdown of the amounts involved, including any portion that must be covered by the user or sponsored in USDT (U). 
+
+### 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.FeeStationApi();
+const opts = {
+  'FeeStationCheckFeeStationUsage': new CoboWaas2.FeeStationCheckFeeStationUsage()
+};
+apiInstance.checkFeeStationUsage(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **FeeStationCheckFeeStationUsage** | [**FeeStationCheckFeeStationUsage**](FeeStationCheckFeeStationUsage.md)| The information for evaluating Fee Station usage. | [optional] 
+
+### Return type
+
+[**FeeStationCheckFeeStationUsageResponse**](FeeStationCheckFeeStationUsageResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## estimateFeeStationFee
 
 > EstimatedFixedFee estimateFeeStationFee(opts)

package/docs/FeeStationCheckFeeStationUsage.md

@@ -0,0 +1,14 @@
+# CoboWaas2.FeeStationCheckFeeStationUsage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | 
+**amount** | **String** | The amount of tokens to be transferred in this request. | 
+**token_id** | **String** | The token ID of the transferred 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). | 
+**estimated_fee_amount** | **String** | The estimated transaction fee required for this transfer, before applying any Fee Station rules. | 
+**from_address** | **String** | The blockchain address that initiates the transfer. | 
+**from_wallet_id** | **String** | The wallet ID. | 
+
+

package/docs/FeeStationCheckFeeStationUsageResponse.md

@@ -0,0 +1,16 @@
+# CoboWaas2.FeeStationCheckFeeStationUsageResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The token used to pay the gas fee for this specific transaction. You can retrieve the IDs of all supported tokens by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | 
+**gas_station_type** | [**FeeStationGasStationType**](FeeStationGasStationType.md) |  | 
+**is_fee_station_applicable** | **Boolean** | Indicates whether Fee Station is applied for this transfer request. | 
+**is_balance_sufficient** | **Boolean** | If Fee Station is used, indicates whether its balance is sufficient to cover the required gas fee. | 
+**balance** | **String** | The current token balance available in Fee Station. | 
+**total_fee_amount** | **String** | The total gas amount required for this transfer request. | 
+**is_sponsor_applicable** | **Boolean** | Indicates whether USDT (U) sponsorship is applied when Fee Station balance is insufficient. | 
+**sponsored_fee_amount** | **String** | The amount of gas fee sponsored by USDT (U) when applicable. | 
+
+

package/docs/FeeStationGasStationType.md

@@ -0,0 +1,12 @@
+# CoboWaas2.FeeStationGasStationType
+
+## Enum
+
+
+* `FeeStation` (value: `"FeeStation"`)
+
+* `CoboOperationStation` (value: `"CoboOperationStation"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/ListSwapActivities200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListSwapActivities200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[SwapActivity]**](SwapActivity.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/ListSwapEnabledTokens200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListSwapEnabledTokens200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[SwapToken]**](SwapToken.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/ListTopUpPayerAccounts200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListTopUpPayerAccounts200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[PayerAccount]**](PayerAccount.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/Merchant.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **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. If you are a merchant (directly serving the payer), you do not need to configure the developer fee rate. | [optional] 
+**wallet_setup** | [**WalletSetup**](WalletSetup.md) |  | [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

@@ -8,9 +8,9 @@ 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 `{CHAIN}_{TOKEN}`. | 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | 
 **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] 
+**settled_amount** | **String** | The total amount of the token that has been paid out 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] 
+**total_balance** | **String** |  The total balance of the token available for payout or refund for the merchant.  `total_balance` = `total_received_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] 
 
 

package/docs/MessageSignDestination.md

@@ -7,7 +7,6 @@ Name | Type | Description | Notes
 **destination_type** | [**MessageSignDestinationType**](MessageSignDestinationType.md) |  | 
 **message** | **String** | The raw data of the message to be signed, encoded in Base64 format. | 
 **structured_data** | **{String: Object}** | The structured data to be signed, formatted as a JSON object according to the EIP-712 standard. | 
-**msg_hash** | **String** | Message hash to be signed, in hexadecimal format. | 
 **message_bip137** | **String** | Message to be signed, in hexadecimal format. | 
 **message_bip322** | **String** | Message to be signed, in hexadecimal format. | 
 **message_cosmos_adr36** | **String** | Message to be signed, in hexadecimal format. | 

package/docs/OtcFee.md

@@ -0,0 +1,10 @@
+# CoboWaas2.OtcFee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fee_rate** | **String** | The otc fee rate. | 
+**token_id** | **String** | The token id in otc. | [optional] 
+
+