@cobo/cobo-waas2 1.20.0 → 1.22.0

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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
 **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) |  | 
@@ -12,6 +12,9 @@ Name | Type | Description | Notes
 **created_timestamp** | **Number** | The creation time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
 **updated_timestamp** | **Number** | The last update time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
 **initiator** | **String** |  The initiator of this settlement request. Can return either an API key or the Payment Management App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID.  | [optional] 
+**acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
+**payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
+**settlement_type** | [**SettlementType**](SettlementType.md) |  | [optional] 
 
 
 

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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
 **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] 
@@ -37,10 +37,10 @@ Name | Type | Description | Notes
 **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. | 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | 
-**order_id** | **String** | Unique identifier of a single order | [optional] 
+**order_id** | **String** | The pay-in order ID. | [optional] 
 **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | [optional] 
-**payer_id** | **String** | Unique payer identifier on the Cobo side, auto-generated by the system.  | [optional] 
-**custom_payer_id** | **String** | Unique user identifier on the merchant side, used to assign a dedicated deposit address.  | [optional] 
+**payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. | [optional] 
+**custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. | [optional] 
 
 
 

package/docs/PaymentWalletBalance.md

@@ -0,0 +1,14 @@
+# CoboWaas2.PaymentWalletBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_id** | **String** | The unique identifier of the wallet. | 
+**token_id** | **String** | The ID of the cryptocurrency. | 
+**swept_balance** | **String** | The payment wallet swept balance. | [optional] 
+**available_balance** | **String** | The payment wallet available balance. | [optional] 
+**total_balance** | **String** | The payment wallet total balance. | [optional] 
+**above_sweep_threshold_balance** | **String** | The payment wallet above sweep threshold balance. | [optional] 
+
+

package/docs/PspBalance.md

@@ -0,0 +1,14 @@
+# CoboWaas2.PspBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The ID of the cryptocurrency. | 
+**developer_fee_amount** | **String** | The psp developer fee amount. | [optional] 
+**settled_amount** | **String** | The psp settled amount. | [optional] 
+**refunded_amount** | **String** | The psp total refunded amount. | [optional] 
+**total_balance** | **String** | The psp total balance. | [optional] 
+**available_balance** | **String** | The psp available balance. | [optional] 
+
+

package/docs/ReceivedAmountPerAddress.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ReceivedAmountPerAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | Receiving address. | 
+**total_received_amount** | **String** | Total tokens received at this address, as a decimal string. | 
+
+

package/docs/SafeWallet.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **name** | **String** | The wallet name. | 
 **org_id** | **String** | The ID of the owning organization. | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional] 
 **chain_id** | **String** | The ID of the chain on which the wallet operates. | [optional] 
 **smart_contract_wallet_type** | [**SmartContractWalletType**](SmartContractWalletType.md) |  | 
 **safe_address** | **String** | The Smart Contract Wallet address. | [optional] 

package/docs/Settlement.md

@@ -11,5 +11,8 @@ Name | Type | Description | Notes
 **created_timestamp** | **Number** | The creation time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
 **updated_timestamp** | **Number** | The last update time of the settlement request, represented as a UNIX timestamp in seconds. | [optional] 
 **initiator** | **String** |  The initiator of this settlement request. Can return either an API key or the Payment Management App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID.  | [optional] 
+**acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
+**payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
+**settlement_type** | [**SettlementType**](SettlementType.md) |  | [optional] 
 
 

package/docs/SettlementDetail.md

@@ -18,5 +18,7 @@ Name | Type | Description | Notes
 **crypto_address_id** | **String** | The ID of the crypto address used for crypto withdrawal. | [optional] 
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
+**settlement_request_id** | **String** | The settlement request ID generated by Cobo. | [optional] 
+**order_ids** | **[String]** | A list of unique order IDs to be included in this settlement.  - This field is only applicable when `settlement_type` is set to `Merchant`. - If provided, the settlement will only apply to the specified orders.  | [optional] 
 
 

package/docs/SettlementInfo.md

@@ -6,13 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **merchant_id** | **String** | The merchant ID. For developer balance, this field will be empty. | [optional] 
 **token_id** | **String** | The ID of the cryptocurrency. | [optional] 
-**available_amount** | **String** | The amount available for settlement or refund, in the specified cryptocurrency. | 
-**available_currency_balance** | **String** | The amount available for settlement or refund, in the specified fiat currency. | [optional] 
-**pending_amount** | **String** | The amount unavailable for settlement or refund, in the specified cryptocurrency. | [optional] 
-**pending_currency_balance** | **String** | The amount unavailable for settlement or refund, in the specified fiat currency. | [optional] 
+**available_amount** | **String** | This field is no longer in use and can be ignored. | 
+**available_currency_balance** | **String** | This field is no longer in use and can be ignored. | [optional] 
+**pending_amount** | **String** | This field is no longer in use and can be ignored. | [optional] 
+**pending_currency_balance** | **String** | This field is no longer in use and can be ignored. | [optional] 
 **settled_amount** | **String** | The amount already settled, in the specified cryptocurrency. | [optional] 
-**available_balance** | **String** | The balance available for settlement or refund, in the specified fiat currency. | [optional] 
-**total_balance** | **String** | The balance total for settlement or refund, in the specified fiat currency. | [optional] 
+**available_balance** | **String** | The balance available for settlement or refund, in the specified cryptocurrency. | [optional] 
+**total_balance** | **String** |  The total unsettled balance in the specified cryptocurrency, including: - Available balance that can be settled immediately - Amounts below the sweep threshold that require forced sweep before settlement  | [optional] 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
 **created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 
 **updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [optional] 

package/docs/SmartContractWalletInfo.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **name** | **String** | The wallet name. | 
 **org_id** | **String** | The ID of the owning organization. | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional] 
 **chain_id** | **String** | The ID of the chain on which the wallet operates. | [optional] 
 **smart_contract_wallet_type** | [**SmartContractWalletType**](SmartContractWalletType.md) |  | 
 **safe_address** | **String** | The Smart Contract Wallet address. | [optional] 

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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
 **token_ids** | **String** | A list of token IDs, separated by comma. | 
 **operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) |  | 
 

package/docs/SweepToAddress.md

@@ -0,0 +1,11 @@
+# CoboWaas2.SweepToAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | The wallet address. | 
+**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | 
+**status** | [**SweepToAddressStatus**](SweepToAddressStatus.md) |  | [optional] 
+
+

package/docs/SweepToAddressStatus.md

@@ -0,0 +1,12 @@
+# CoboWaas2.SweepToAddressStatus
+
+## Enum
+
+
+* `Valid` (value: `"Valid"`)
+
+* `Invalid` (value: `"Invalid"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/TSSRequestWebhookEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
 **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] 

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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
 **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. | 

package/docs/TokenizationActivityInfo.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) |  | 
 **initiator** | **String** | The initiator of the activity. | 
 **initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) |  | 
-**transaction_ids** | **[String]** | The IDs of the corresponding transactions of the activity. | [optional] 
-**created_timestamp** | **Number** | The creation timestamp of the activity in milliseconds since the Unix epoch. | [optional] 
+**transaction_ids** | **[String]** | The IDs of the corresponding transactions of the activity. | 
+**created_timestamp** | **Number** | The creation timestamp of the activity in milliseconds since the Unix epoch. | 
 **updated_timestamp** | **Number** | The last update timestamp of the activity in milliseconds since the Unix epoch. | 
 
 

package/docs/TokenizationAllowlistActivationRequest.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **activation** | **Boolean** | Whether to activate the allowlist feature for the token. | 
 **app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional] 
 **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | 
+**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] 
 
 

package/docs/TokenizationAllowlistAddressNote.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**address** | **String** | The allowed address. | 
-**note** | **String** | The note for the allowed address. | [optional] 
-**created_timestamp** | **Number** | The time when the allowlist address was created, in Unix timestamp format, measured in milliseconds. | [optional] 
+**address** | **String** | The address on the allowlist. | 
+**note** | **String** | The note for the address on the allowlist. | [optional] 
+**created_timestamp** | **Number** | The time when the address was added to the allowlist, in Unix timestamp format, measured in milliseconds. | [optional] 
 
 

package/docs/TokenizationAllowlistAddressesResponse.md

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