@cobo/cobo-waas2 1.26.0 → 1.28.0

package/docs/PaymentOrderEventData.md

@@ -4,27 +4,30 @@
 
 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. | 
 **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] 
 
 
 
@@ -57,6 +60,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/PaymentPayout.md

@@ -0,0 +1,19 @@
+# CoboWaas2.PaymentPayout
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_id** | **String** | The payout ID generated by Cobo. | 
+**request_id** | **String** | The request ID provided by you when creating the payout. | 
+**payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | 
+**payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) |  | [optional] 
+**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) |  | 
+**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional] 
+**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional] 
+**currency** | **String** | The fiat currency for the payout. | [optional] 
+**actual_payout_amount** | **String** | The actual amount of this payout.  | [optional] 
+**bank_account** | [**BankAccount**](BankAccount.md) |  | [optional] 
+
+

package/docs/PaymentPayoutDetail.md

@@ -0,0 +1,19 @@
+# CoboWaas2.PaymentPayoutDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_id** | **String** | The payout ID generated by Cobo. | 
+**request_id** | **String** | The request ID provided by you when creating the payout. | 
+**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) |  | 
+**payout_item_details** | [**[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) |  | [optional] 
+**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional] 
+**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional] 
+**payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
+**currency** | **String** | The fiat currency for the payout. | [optional] 
+**actual_payout_amount** | **String** | The actual amount of this payout.  | [optional] 
+**bank_account** | [**BankAccount**](BankAccount.md) |  | [optional] 
+
+

package/docs/PaymentPayoutEvent.md

@@ -0,0 +1,65 @@
+# CoboWaas2.PaymentPayoutEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `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. | 
+**payout_id** | **String** | The payout ID generated by Cobo. | 
+**request_id** | **String** | The request ID provided by you when creating the payout. | 
+**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) |  | 
+**payout_item_details** | [**[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) |  | [optional] 
+**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional] 
+**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional] 
+**payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
+**currency** | **String** | The fiat currency for the payout. | [optional] 
+**actual_payout_amount** | **String** | The actual amount of this payout.  | [optional] 
+**bank_account** | [**BankAccount**](BankAccount.md) |  | [optional] 
+
+
+
+## Enum: DataTypeEnum
+
+
+* `Transaction` (value: `"Transaction"`)
+
+* `TSSRequest` (value: `"TSSRequest"`)
+
+* `Addresses` (value: `"Addresses"`)
+
+* `WalletInfo` (value: `"WalletInfo"`)
+
+* `MPCVault` (value: `"MPCVault"`)
+
+* `Chains` (value: `"Chains"`)
+
+* `Tokens` (value: `"Tokens"`)
+
+* `TokenListing` (value: `"TokenListing"`)
+
+* `PaymentOrder` (value: `"PaymentOrder"`)
+
+* `PaymentRefund` (value: `"PaymentRefund"`)
+
+* `PaymentSettlement` (value: `"PaymentSettlement"`)
+
+* `PaymentTransaction` (value: `"PaymentTransaction"`)
+
+* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
+
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
+* `SuspendedToken` (value: `"SuspendedToken"`)
+
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/PaymentPayoutItem.md

@@ -0,0 +1,22 @@
+# CoboWaas2.PaymentPayoutItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_item_id** | **String** | The payout item ID generated by Cobo. | 
+**payout_id** | **String** | The payout ID generated by Cobo. | 
+**token_id** | **String** | The token id of the payout item. | [optional] 
+**chain_id** | **String** | The ID of the blockchain network on which the payout item occurred. | [optional] 
+**amount** | **String** | The payout item token_id amount.  | 
+**status** | [**PaymentPayoutItemStatus**](PaymentPayoutItemStatus.md) |  | 
+**source_account** | **String** |  | 
+**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this payout item request. Each transaction represents a separate blockchain operation related to the payout item process. | [optional] 
+**created_timestamp** | **Number** | The created time of the payout item, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The updated time of the payout item, 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] 
+**crypto_address** | **String** | The actual blockchain address to which funds were transferred. | [optional] 
+**commission_fee** | [**CommissionFee**](CommissionFee.md) |  | [optional] 
+**bridging_fee** | [**BridgingFee**](BridgingFee.md) |  | [optional] 
+
+

package/docs/PaymentPayoutItemDetail.md

@@ -0,0 +1,22 @@
+# CoboWaas2.PaymentPayoutItemDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_item_id** | **String** | The payout item ID generated by Cobo. | 
+**payout_id** | **String** | The payout ID generated by Cobo. | 
+**token_id** | **String** | The token id of the payout. | [optional] 
+**chain_id** | **String** | The ID of the blockchain network on which the payout occurred. | [optional] 
+**source_account** | **String** |  | 
+**amount** | **String** | The payout token_id amount.  | 
+**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) |  | 
+**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this payout request. Each transaction represents a separate blockchain operation related to the payout process. | [optional] 
+**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The updated time of the payout, 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] 
+**crypto_address** | **String** | The actual blockchain address to which funds were transferred. | [optional] 
+**commission_fee** | [**CommissionFee**](CommissionFee.md) |  | [optional] 
+**bridging_fee** | [**BridgingFee**](BridgingFee.md) |  | [optional] 
+
+

package/docs/PaymentPayoutItemStatus.md

@@ -0,0 +1,18 @@
+# CoboWaas2.PaymentPayoutItemStatus
+
+## Enum
+
+
+* `Pending` (value: `"Pending"`)
+
+* `Processing` (value: `"Processing"`)
+
+* `Completed` (value: `"Completed"`)
+
+* `PartiallyCompleted` (value: `"PartiallyCompleted"`)
+
+* `Failed` (value: `"Failed"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/PaymentPayoutParam.md

@@ -0,0 +1,13 @@
+# CoboWaas2.PaymentPayoutParam
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_account** | **String** |  | 
+**token_id** | **String** | Only used in Crypto payout channel. The ID of the cryptocurrency you want to settle. 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`  | 
+**amount** | **String** | The payout cryptocurrency amount.  | 
+**crypto_address_id** | **String** | Only used in Crypto payout channel. The ID of the pre-approved crypto address used for Crypto settlements. - The value must refer to a valid address that has been pre-configured and approved for the given token.  | [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] 
+
+

package/docs/PaymentPayoutStatus.md

@@ -0,0 +1,20 @@
+# CoboWaas2.PaymentPayoutStatus
+
+## Enum
+
+
+* `Pending` (value: `"Pending"`)
+
+* `Processing` (value: `"Processing"`)
+
+* `Completed` (value: `"Completed"`)
+
+* `PartiallyCompleted` (value: `"PartiallyCompleted"`)
+
+* `Failed` (value: `"Failed"`)
+
+* `Canceled` (value: `"Canceled"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/PaymentRefundEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `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. | 
 **request_id** | **String** | The request ID provided by you when creating the refund request. | [optional] 
 **refund_id** | **String** | The refund order ID. | 
 **order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional] 
@@ -55,6 +55,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/PaymentSettlementEvent.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. | 
 **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) |  | 
@@ -50,6 +50,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/PaymentSourceType.md

@@ -0,0 +1,12 @@
+# CoboWaas2.PaymentSourceType
+
+## Enum
+
+
+* `Merchant` (value: `"Merchant"`)
+
+* `Psp` (value: `"Psp"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/PaymentTransaction.md

@@ -11,6 +11,8 @@ Name | Type | Description | Notes
 **to_address** | **String** | The destination address of the transaction. | 
 **amount** | **String** | The amount of cryptocurrency transferred, as a decimal string. | 
 **status** | [**TransactionStatus**](TransactionStatus.md) |  | 
+**counterparty** | [**Counterparty**](Counterparty.md) |  | [optional] 
+**destination** | [**Destination**](Destination.md) |  | [optional] 
 **created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. | 
 **updated_timestamp** | **Number** | The time when the transaction was updated, in Unix timestamp format, measured in milliseconds. | 
 

package/docs/PaymentTransactionEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `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. | 
 **transaction_id** | **String** | The transaction ID. | 
 **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional] 
 **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional] 
@@ -31,7 +31,7 @@ Name | Type | Description | Notes
 **category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional] 
 **description** | **String** | The description for your transaction. | [optional] 
 **is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer.  | [optional] 
-**cobo_category** | **[String]** | The transaction category defined by Cobo. Possible values include:  - `AutoSweep`: An auto-sweep transaction. - `AutoFueling`: A transaction where Fee Station pays transaction fees to an address within your wallet. - `AutoFuelingRefund`: A refund for an auto-fueling transaction. - `SafeTxMessage`: A message signing transaction to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - `BillPayment`: A transaction to pay Cobo bills through Fee Station. - `BillRefund`: A refund for a previously made bill payment. - `CommissionFeeCharge`: A transaction to charge commission fees via Fee Station. - `CommissionFeeRefund`: A refund of previously charged commission fees.  | [optional] 
+**cobo_category** | **[String]** | The transaction category defined by Cobo. For more details, refer to [Cobo-defined categories](/v2/guides/transactions/manage-transactions#cobo-defined-categories).  | [optional] 
 **extra** | **[String]** | A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\").  | [optional] 
 **fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) |  | [optional] 
 **created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. | 
@@ -73,6 +73,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/PspBalance.md

@@ -7,8 +7,10 @@ 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}`. | 
 **developer_fee_amount** | **String** | The total amount of the token that has been received as developer fee. | [optional] 
 **settled_amount** | **String** | The total amount of the token that has been paid out from the developer's balance. | [optional] 
+**payout_amount** | **String** | The psp payout amount. | [optional] 
 **refunded_amount** | **String** | The total amount of the token that has been refunded from the developer's balance. | [optional] 
-**total_balance** | **String** |  The total balance of the token available for payout or refund for the developer.  `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount`  For more information, please refer to [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 total balance of the token available for payout or refund for the developer.  `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount`  For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances)  | [optional] 
+**available_balance** | **String** | The psp available balance. | [optional] 
+**locked_balance** | **String** | The psp locked balance. | [optional] 
 
 

package/docs/QueryDestinationWhitelistEnabled200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.QueryDestinationWhitelistEnabled200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enable_destination_whitelist** | **Boolean** | Indicates whether the destination whitelist is enabled. | 
+
+

package/docs/RefundLinkBusinessInfo.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**transaction_id** | **String** | The transaction ID. | 
-**amount** | **String** | The amount to refund in cryptocurrency. | 
+**transaction_id** | **String** | The transaction ID of the original order payment or top-up.  On the refund page, the from address of this transaction will be pre-filled as the default refund address.  The refund will be processed in the same token and on the same blockchain as this transaction.  | 
+**amount** | **String** | The amount to refund, denominated in the cryptocurrency of the original payment transaction. The amount must be a positive number and can have up to two decimal places. | 
 **refund_source** | [**RefundType**](RefundType.md) |  | 
-**merchant_id** | **String** | The merchant ID, required if the refund amount source is `Merchant`. | [optional] 
-**fee_amount** | **String** | The amount of the transaction fee that the merchant will bear for the refund.  | [optional] 
+**merchant_id** | **String** | The merchant ID, required if `refund_source` is `Merchant`. The fund will be deducted from the specified merchant's balance. | [optional] 
+**fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency of the original payment transaction. This field is only valid when `refund_source` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances). Must be:   - A positive integer with up to two decimal places.   - Less than the refund amount  | [optional] 
 
 

package/docs/SettlementDetail.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **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 payouts. | [optional] 
+**crypto_address** | **String** | The actual blockchain address to which funds were transferred. | [optional] 
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
 **settlement_request_id** | **String** | The settlement request ID generated by Cobo. | [optional] 

package/docs/Stakings.md

@@ -13,7 +13,8 @@ Name | Type | Description | Notes
 **rewards_info** | **Object** | The information about the staking rewards. | [optional] 
 **created_timestamp** | **Number** | The time when the staking position was created. | 
 **updated_timestamp** | **Number** | The time when the staking position was last updated. | 
-**validator_info** | [**BabylonValidator**](BabylonValidator.md) |  | 
+**validator_info** | [**BabylonValidator**](BabylonValidator.md) |  | [optional] 
+**validators** | [**[BabylonValidator]**](BabylonValidator.md) |  | [optional] 
 **extra** | [**StakingsExtra**](StakingsExtra.md) |  | [optional] 
 
 

package/docs/StakingsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**createBabylonAirdropRegistration**](StakingsApi.md#createBabylonAirdropRegistration) | **POST** /stakings/protocols/babylon/airdrops/registrations | Register for Babylon airdrop
+[**createBabylonStakingExpansion**](StakingsApi.md#createBabylonStakingExpansion) | **POST** /stakings/protocols/babylon/stakings/expansions | Expand Babylon BTC staking
 [**createBabylonStakingRegistration**](StakingsApi.md#createBabylonStakingRegistration) | **POST** /stakings/protocols/babylon/stakings/registrations | Register for Babylon Phase-2
 [**createClaimActivity**](StakingsApi.md#createClaimActivity) | **POST** /stakings/activities/claim | Create claim activity
 [**createStakeActivity**](StakingsApi.md#createStakeActivity) | **POST** /stakings/activities/stake | Create stake activity
@@ -79,6 +80,58 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## createBabylonStakingExpansion
+
+> Stakings createBabylonStakingExpansion(opts)
+
+Expand Babylon BTC staking
+
+This operation initiates a Babylon BTC staking expansion request.   Before calling this operation, please ensure the following: - The BTC staking position is active. - The finality provider public keys are valid. Each BSN chain has a unique finality provider public key at most.  The system first checks whether the provided BTC staking position is active. If active, it creates a new BTC staking position for the Phase-3 expansion.  The expansion is processed asynchronously and may take some time to complete.  For more information, refer to [Babylon's official doc](https://github.com/babylonlabs-io/babylon/tree/main/docs). 
+
+### 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.StakingsApi();
+const opts = {
+  'BabylonCreateStakingExpansion': new CoboWaas2.BabylonCreateStakingExpansion()
+};
+apiInstance.createBabylonStakingExpansion(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **BabylonCreateStakingExpansion** | [**BabylonCreateStakingExpansion**](BabylonCreateStakingExpansion.md)| The request body to expand Babylon BTC staking to Phase-3 | [optional] 
+
+### Return type
+
+[**Stakings**](Stakings.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## createBabylonStakingRegistration
 
 > CreateBabylonStakingRegistration201Response createBabylonStakingRegistration(opts)
@@ -115,7 +168,7 @@ apiInstance.createBabylonStakingRegistration(opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **CreateBabylonStakingRegistrationRequest** | [**CreateBabylonStakingRegistrationRequest**](CreateBabylonStakingRegistrationRequest.md)| The request body to transit Babylon BTC staking to phase 2 | [optional] 
+ **CreateBabylonStakingRegistrationRequest** | [**CreateBabylonStakingRegistrationRequest**](CreateBabylonStakingRegistrationRequest.md)| The request body to transit Babylon BTC staking to Phase-2 | [optional] 
 
 ### Return type
 

package/docs/SuspendedTokenEventData.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. | 
 **token_ids** | **String** | A list of token IDs, separated by comma. | 
 **operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) |  | 
 
@@ -39,6 +39,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/SwapActivity.md

@@ -21,6 +21,6 @@ Name | Type | Description | Notes
 **created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional] 
 **updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional] 
 **network_fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | [optional] 
-**destination_address** | **String** | The address of an MPC Wallet or Web3 Wallet that receives the swapped or bridged assets. | [optional] 
+**destination_address** | **String** | The address of an MPC Wallet or Custodial Wallet (Web3 Wallet) that receives the swapped or bridged assets. | [optional] 
 
 

package/docs/SwapActivityDetail.md

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional] 
 **updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional] 
 **network_fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | [optional] 
-**destination_address** | **String** | The address of an MPC Wallet or Web3 Wallet that receives the swapped or bridged assets. | [optional] 
+**destination_address** | **String** | The address of an MPC Wallet or Custodial Wallet (Web3 Wallet) that receives the swapped or bridged assets. | [optional] 
 **timeline** | [**[SwapActivityTimeline]**](SwapActivityTimeline.md) |  | [optional] 
 **approvers** | [**[SwapActivityApprovers]**](SwapActivityApprovers.md) |  | [optional] 
 **signers** | [**[SwapActivitySigners]**](SwapActivitySigners.md) |  | [optional] 

package/docs/SwapsApi.md

@@ -69,7 +69,7 @@ Name | Type | Description  | Notes
 
 Estimate swap fee
 
-This operation estimates the network fee of a swap activity. You can use this operation to estimate the network fee before initiating swap activities from MPC Wallets or Web3 Wallets.  It requires a valid `wallet_id` and `quote_id`, so you need to [get a swap quote](https://www.cobo.com/developers/v2/api-references/swaps/get-swap-quote) first. 
+This operation estimates the network fee of a swap activity. You can use this operation to estimate the network fee before initiating swap activities from MPC Wallets or Custodial Wallets (Web3 Wallets).  It requires a valid `wallet_id` and `quote_id`, so you need to [get a swap quote](https://www.cobo.com/developers/v2/api-references/swaps/get-swap-quote) first. 
 
 ### Example
 

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. - `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. | 
 **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] 
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)

package/docs/TokenListingEventData.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. | 
 **request_id** | **String** | The unique identifier of the token listing request. | 
 **chain_id** | **String** | The ID of the blockchain where the token is deployed. | 
 **contract_address** | **String** | The token's contract address on the specified blockchain. | 
@@ -48,6 +48,8 @@ Name | Type | Description | Notes
 
 * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
 
+* `PaymentPayout` (value: `"PaymentPayout"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)