@cobo/cobo-waas2 1.27.0 → 1.28.0

package/docs/ContractCallDestinationType.md

@@ -11,6 +11,8 @@
 
 * `TRON_Contract` (value: `"TRON_Contract"`)
 
+* `COSMOS_Contract` (value: `"COSMOS_Contract"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/CosmosContractCallDestination.md

@@ -6,6 +6,5 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) |  | 
 **cosmos_messages** | [**[CosmosContractCallMessage]**](CosmosContractCallMessage.md) |  | 
-**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
 
 

package/docs/CreateBatchAllocationRequest.md

@@ -0,0 +1,10 @@
+# CoboWaas2.CreateBatchAllocationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | The request ID that is used to track a allocation request. The request ID is provided by you and must be unique. | 
+**allocation_requests** | [**[AllocationRequest]**](AllocationRequest.md) |  | 
+
+

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 Wallets and Web3 Wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (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 Wallets and Web3 Wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (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,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The merchant name. | 
 **wallet_id** | **String** | This field has been deprecated. | [optional] 
-**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). | [optional] 
+**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances). | [optional] 
 **wallet_setup** | [**WalletSetup**](WalletSetup.md) |  | [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 Wallets and Web3 Wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (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

@@ -4,16 +4,20 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**merchant_id** | **String** | The merchant ID. This ID is assigned by Cobo when you create the merchant. | 
-**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. If left empty, both `order_amount` and `fee_amount` will be denominated in the cryptocurrency specified by `token_id`  Currently, only `USD` is supported.  | [optional] [default to '']
-**order_amount** | **String** |  The base amount of the order, excluding the developer fee (specified in `fee_amount`). The denomination of the amount depends on if `currency` is specified: - If `currency` is specified, the amount is in the currency specified by `currency`, e.g. \"USD\". - If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`, e.g. \"ETH_USDT\".   Values must be greater than `0` and contain two decimal places.  | 
-**fee_amount** | **String** |  The developer fee for the order.  - **When to set:**     If you are a merchant serving payers directly, set this field to `0`.     Developer fees are only relevant for platforms like payment service providers (PSPs) that charge fees to their downstream merchants.   For details, see [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).  - **Denomination:**     The denomination of `fee_amount` depends on the presence of `currency`:       - If `currency` is set, the amount is denominated in that currency (e.g., \"USD\").       - If `currency` is not set, the amount is denominated in the cryptocurrency specified by `token_id` (e.g., \"ETH_USDT\").  - **Calculation:**     The developer fee is added to the base order amount (`order_amount`) to determine the final amount charged to the customer.     For example:       - Base amount (`order_amount`): \"100.00\"       - Developer fee (`fee_amount`): \"2.00\"       - **Total charged:** \"102.00\"  - **Formatting:**     The value 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. 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** | This field has been deprecated.  | [optional] 
-**custom_exchange_rate** | **String** |  A custom exchange rate that defines how much fiat currency equals 1 unit of cryptocurrency. If not provided, the system's default exchange rate will be used.  For example, if the fiat currency is USD and the cryptocurrency is USDT, setting `custom_exchange_rate` to `\"0.99\"` means that 1 USDT will be valued at 0.99 USD.  | [optional] 
-**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur.  When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.  | [optional] 
+**merchant_id** | **String** | The merchant ID. | 
+**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional] 
+**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | 
+**pricing_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values:   - 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`  | [optional] 
+**pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional] 
+**fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. For example, if order_amount is \"100.00\" and fee_amount is \"2.00\", the customer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant and \"2.00\" settled to the developer. Values must be greater than 0 and contain two decimal places. | 
+**payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values:   - 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`  | [optional] 
+**payable_amount** | **String** | The actual payable amount of the order in the cryptocurrency. | [optional] 
+**expired_in** | **Number** | The pay-in order will expire after approximately a certain number of seconds: - 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] 
+**amount_tolerance** | **String** | Allowed amount deviation, precision to 1 decimal place. | [optional] 
+**currency** | **String** | The fiat currency of the order. | [optional] [default to '']
+**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional] 
+**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported values:   - 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`  | [optional] 
+**use_dedicated_address** | **Boolean** | Indicates whether to allocate a dedicated address for this order.  If false, a shared address from the address pool will be used.  | [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/CreatePayoutRequest.md

@@ -0,0 +1,14 @@
+# CoboWaas2.CreatePayoutRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | The request ID that is used to track a settlement request. The request ID is provided by you and must be unique. | 
+**payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | 
+**payout_params** | [**[PaymentPayoutParam]**](PaymentPayoutParam.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 create payouts. | [optional] 
+**remark** | **String** | The remark for the create payouts. | [optional] 
+
+

package/docs/CreateRefundRequest.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **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) |  | 
 **order_id** | **String** | The ID of the original pay-in order associated with this refund. Use this to track refunds against specific payments. | [optional] 
-**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).     - `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  When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified.  | [optional] 
-**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).  This field is required when `charge_merchant_fee` is `true`. Must be:   - A positive integer with up to two decimal places.   - Less than the refund amount  | [optional] 
-**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. It must be the same as `token_id`. 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`  | [optional] 
+**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).     - `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  When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified.  | [optional] 
+**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).  This field is required when `charge_merchant_fee` is `true`. Must be:   - A positive integer with up to two decimal places.   - Less than the refund amount  | [optional] 
+**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the transaction fee. This is only applicable if `charge_merchant_fee` is set to true.  | [optional] 
 
 

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 Wallets and Web3 Wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (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`  | 
 **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] 
-**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] 
+**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/payments/en/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses.  | [optional] 
 **crypto_address** | **String** | Only used in Crypto payout channel. The actual blockchain address to which funds will be transferred. If enable destination whitelist, this address must be associated with a destination.  | [optional] 
 **order_ids** | **[String]** |  | [optional] 
 

package/docs/CreateSettlementRequestRequest.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
 **settlement_type** | [**SettlementType**](SettlementType.md) |  | [optional] 
 **settlements** | [**[CreateSettlement]**](CreateSettlement.md) |  | 
-**bank_account_id** | **String** |  The ID of the bank account where the funds will be deposited. You can 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.  This field is only applicable for off-ramp.  | [optional] 
+**bank_account_id** | **String** |  The ID of the bank account where the funds will be deposited. You can call [List all bank accounts](https://www.cobo.com/payments/en/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts.  This field is only applicable for off-ramp.  | [optional] 
 **currency** | **String** | The fiat currency to receive after off-ramping. Currently, only `USD` is supported. Specify this field when `payout_channel` is set to `OffRamp`. | [optional] 
 **remark** | **String** | The remark for the payout request. | [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 Wallets and Web3 Wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (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/CreateStakeActivityExtra.md

@@ -6,9 +6,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pool_type** | [**StakingPoolType**](StakingPoolType.md) |  | 
 **finality_provider_public_key** | **String** | The public key of the finality provider. | 
+**finality_provider_public_keys** | **[String]** | The public keys of the finality providers, with each key corresponding to a BSN chain. | [optional] 
 **stake_block_time** | **Number** | The number of blocks that need to be processed before the locked tokens are unlocked and become accessible. | 
 **auto_broadcast** | **Boolean** | Whether to automatically broadcast the transaction. The default value is `true`.  - `true`: Automatically broadcast the transaction. - `false`: The transaction will not be submitted to the blockchain automatically. You can call [Broadcast signed transactions](https://www.cobo.com/developers/v2/api-references/transactions/broadcast-signed-transactions) to broadcast the transaction to the blockchain, or retrieve the signed raw transaction data `raw_tx` by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information) and broadcast it yourself.  | [optional] 
 **babylon_address** | [**StakingSource**](StakingSource.md) |  | [optional] 
+**original_staking_id** | **String** | The original staking ID to expand. Only set this when you want to expand existing staking. | [optional] 
 **provider_name** | **String** | The name of the provider. | 
 **timelock** | **Number** | The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. | 
 **change_address** | **String** | The change address on the Bitcoin chain. If not provided, the source wallet's address will be used as the change address. | [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 Wallets and Web3 Wallets. | [optional] 
+**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (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/GetExchangeRate200Response.md

@@ -4,7 +4,7 @@
 
 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}`. | 
+**token_id** | **String** | The token ID, which identifies the cryptocurrency. | 
 **currency** | **String** | The fiat currency. | 
 **rate** | **String** | The current exchange rate between the specified currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. | 
 

package/docs/LinkDisplayInfo.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **developer_name** | **String** | The brand name to display to end users on the page. This helps users identify who is providing the payment service.  | [optional] 
 **logo** | **String** | The URL of the logo image to display to end users on the page.  | [optional] 
+**return_url** | **String** | The URL to redirect to after the operation completes. | [optional] 
 
 

package/docs/ListAllocations200Response.md

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

package/docs/ListBatchAllocations200Response.md

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

package/docs/ListPayoutItems200Response.md

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

package/docs/ListPayouts200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListPayouts200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[PaymentPayout]**](PaymentPayout.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
 **vault_id** | **String** | The vault ID. | [optional] 
 **project_id** | **String** | The project ID. | [optional] 
 **name** | **String** | The vault name. | [optional] 
@@ -43,6 +43,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/MerchantBalance.md

@@ -9,8 +9,10 @@ Name | Type | Description | Notes
 **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 paid out from the merchant's balance. | [optional] 
+**payout_amount** | **String** | The merchant payout amount. | [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 available for payout or refund for the merchant.  `total_balance` = `total_received_amount` - `settled_amount` - `refunded_amount`  For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances)  | [optional] 
-**available_balance** | **String** | This field has been deprecated. | [optional] 
+**total_balance** | **String** |  The current balance of this token available to the merchant for payouts or refunds.  `total_balance` = `total_received_amount` - `settled_amount` - `refunded_amount`  For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances)  | [optional] 
+**available_balance** | **String** | The merchant available balance. | [optional] 
+**locked_balance** | **String** | The merchant locked balance. | [optional] 
 
 

package/docs/OAuthApi.md

@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 Get Access Token
 
-This operation acquires an Access Token and a Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk).  For security purposes, an Access Token expires after a certain period. Once it expires, you need to call the [Refresh Access Token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-access-token) operation to get a new Access Token and a new Refresh Token. 
+ <Warning>This operation has been deprecated.</Warning> This operation acquires an Access Token and a Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk).  For security purposes, an Access Token expires after a certain period. Once it expires, you need to call the [Refresh Access Token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-access-token) operation to get a new Access Token and a new Refresh Token. 
 
 ### Example
 
@@ -121,7 +121,7 @@ Name | Type | Description  | Notes
 
 Refresh Access Token
 
-This operation refreshes the Access Token and Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk).  For security purposes, an Access Token expires after a certain period. Once it expires, you need to call this operation to get a new Access Token and Refresh Token. 
+ <Warning>This operation has been deprecated.</Warning> This operation refreshes the Access Token and Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk).  For security purposes, an Access Token expires after a certain period. Once it expires, you need to call this operation to get a new Access Token and Refresh Token. 
 
 ### Example
 

package/docs/Order.md

@@ -6,23 +6,26 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order_id** | **String** | The order ID. | 
 **merchant_id** | **String** | The merchant ID. | [optional] 
-**token_id** | **String** |  The ID of the cryptocurrency used for payment. Supported tokens:  - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
-**chain_id** | **String** |  The ID of the blockchain network where the payment transaction should be made. Supported chains:  - USDC: `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` - USDT: `TRON`, `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC`  | 
-**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. | 
-**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. | 
-**currency** | **String** | The fiat currency of the order. | 
-**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | 
-**fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. | 
-**exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. | 
-**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional] 
 **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional] 
 **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | 
+**pricing_currency** | **String** | The fiat currency of the order. | [optional] 
+**pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional] 
+**fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. | 
+**payable_currency** | **String** | The ID of the cryptocurrency used for payment. | [optional] 
+**chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. | 
+**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. | 
+**exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. | 
+**amount_tolerance** | **String** | Allowed amount deviation. | [optional] 
+**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. | 
 **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 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] 
+**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional] 
+**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] 
+**currency** | **String** | The fiat currency of the order. | [optional] 
+**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional] 
+**token_id** | **String** | The ID of the cryptocurrency used for payment. | [optional] 
 **settlement_status** | [**SettleStatus**](SettleStatus.md) |  | [optional] 
-**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur.  When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.  | [optional] 
 
 

package/docs/OrderLinkBusinessInfo.md

@@ -4,16 +4,20 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token_ids** | **[String]** | An array of token IDs representing the cryptocurrencies and chains available for payment. These options will be shown to users on the payment page for them to choose from. Supported token IDs include:   - 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`  | 
-**custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) | A list of custom exchange rates defining how much one unit of a specific cryptocurrency (`token_id`) is valued in the selected fiat or crypto currency (`currency`). If this field is omitted, the system’s default exchange rates will apply.  Each item specifies a `token_id` and its corresponding `exchange_rate`. For example, to treat 1 USDT (on Ethereum) as equivalent to 0.99 USD, provide:  ```json {   \"custom_exchange_rates\": [     {       \"token_id\": \"ETH_USDT\",       \"exchange_rate\": \"0.99\"     }   ],   \"currency\": \"USD\" } ```  | [optional] 
-**currency** | **String** | The currency in which both the order amount (`order_amount`) and the developer fee (`fee_amount`) are denominated. Only the following values are supported: `USD`, `USDT`, or `USDC`.  | 
-**fee_amount** | **String** | The developer fee for the order, denominated in the currency specified by `currency`.   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_id** | **String** | The merchant ID. | 
-**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), denominated in the currency specified by `currency`.  Values must be greater than `0` and contain 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.  | 
+**pricing_currency** | **String** | The currency for the base order amount and the developer fee. Currently, only `USD`/`USDT`/`USDC` are supported.  | [optional] 
+**pricing_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.  | [optional] 
+**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.  | 
+**payable_currencies** | **[String]** | List of supported cryptocurrency token IDs for this payment. Each token ID must be from the supported values.  | [optional] 
+**payable_amounts** | [**[OrderLinkBusinessInfoPayableAmountsInner]**](OrderLinkBusinessInfoPayableAmountsInner.md) | Optional list of payable amounts for different tokens. If provided, these amounts will be used instead of calculating the amounts based on the exchange rate.  | [optional] 
 **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** | This field has been deprecated.  | [optional] 
-**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur.  When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.  | [optional] 
+**amount_tolerance** | **String** | Allowed amount deviation, precision to 1 decimal place. | [optional] 
+**currency** | **String** | The currency for the base order amount and the developer fee. Currently, only `USD`/`USDT`/`USDC` are supported.  | [optional] 
+**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.  | [optional] 
+**token_ids** | **[String]** | List of supported cryptocurrency token IDs for this payment. Each token ID must be from the supported values.  | [optional] 
+**custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) | Optional list of final exchange rates for different tokens. If provided, these rates will be used instead of real-time market rates.  | [optional] 
+**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/OrderLinkBusinessInfoCustomExchangeRatesInner.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token_id** | **String** | The token ID. | 
-**exchange_rate** | **String** | The exchange rate to use for this token. | 
+**token_id** | **String** | The cryptocurrency token ID | 
+**exchange_rate** | **String** | The fixed exchange rate to use for this token | 
 
 

package/docs/OrderLinkBusinessInfoPayableAmountsInner.md

@@ -0,0 +1,10 @@
+# CoboWaas2.OrderLinkBusinessInfoPayableAmountsInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The cryptocurrency token ID | 
+**amount** | **String** | The actual payable amount of the order in the cryptocurrency. | 
+
+

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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. | 
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/PaymentAllocationAmount.md

@@ -0,0 +1,10 @@
+# CoboWaas2.PaymentAllocationAmount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The ID of the cryptocurrency. | 
+**allocation_amount** | **String** | The allocation amount. | 
+
+