@cobo/cobo-waas2 1.16.0 → 1.18.0

package/docs/WalletsApi.md

@@ -41,7 +41,7 @@ Method | HTTP request | Description
 
 Batch check UTXOs
 
-The operation check a list of unspent transaction outputs (UTXOs) for a specified wallet and token.  <Note>This operation is applicable to MPC and Custodial Web3 Wallets. This interface can only withdraw a maximum of 100 utxos</Note> 
+This operation verifies the existence and details of specified unspent transaction outputs (UTXOs) for a given wallet and token. A maximum of 100 UTXOs can be verified per request. <Note>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</Note> 
 
 ### Example
 
@@ -73,7 +73,7 @@ apiInstance.batchCheckUtxo(wallet_id, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **wallet_id** | **String**| The wallet ID. | 
- **BatchCheckUtxoRequest** | [**BatchCheckUtxoRequest**](BatchCheckUtxoRequest.md)| The request body of the batch check UTXOs operation. | [optional] 
+ **BatchCheckUtxoRequest** | [**BatchCheckUtxoRequest**](BatchCheckUtxoRequest.md)| The request body of the Batch check UTXOs operation. | [optional] 
 
 ### Return type
 
@@ -901,7 +901,7 @@ Name | Type | Description  | Notes
 
 List enabled tokens
 
-This operation retrieves all the tokens that can be used by your organization.   You can filter the result by wallet type, subtype, and chain IDs. If you do not specify a wallet type, this operation returns a combination of tokens that can be used by your organization for each wallet type. 
+This operation retrieves all the tokens that can be used by your organization.   You can filter the result by wallet type, subtype, chain IDs, and token IDs. If you do not specify a wallet type, this operation returns a combination of tokens that can be used by your organization for each wallet type. 
 
 ### Example
 
@@ -919,6 +919,7 @@ const opts = {
   'wallet_type': new CoboWaas2.WalletType(),
   'wallet_subtype': new CoboWaas2.WalletSubtype(),
   'chain_ids': "BTC,ETH",
+  'token_ids': "ETH_USDT,ETH_USDC",
   'limit': 10,
   'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
   'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
@@ -939,6 +940,7 @@ Name | Type | Description  | Notes
  **wallet_type** | [**WalletType**](.md)| The wallet type.  - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction)  - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction)  - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction)  - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)  | [optional] 
  **wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype.  - `Asset`: Custodial Wallets (Asset Wallets)  - `Web3`: Custodial Wallets (Web3 Wallets)  - `Main`: Exchange Wallets (Main Account)  - `Sub`: Exchange Wallets (Sub Account)  - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets)  - `User-Controlled`: MPC Wallets (User-Controlled Wallets)  - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})  | [optional] 
  **chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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). | [optional] 
+ **token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional] 
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
  **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.  | [optional] 
  **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.  | [optional] 
@@ -1269,7 +1271,7 @@ Name | Type | Description  | Notes
 
 List UTXOs
 
-The operation retrieves a list of unspent transaction outputs (UTXOs) for a specified wallet and token.  <Note>This operation is applicable to MPC and Custodial Web3 Wallets.</Note> 
+The operation retrieves a list of unspent transaction outputs (UTXOs) for a specified wallet and token.  <Note>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</Note> 
 
 ### Example
 

package/docs/WebhookEvent.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **event_id** | **String** | The event ID. | [optional] 
 **url** | **String** | The webhook endpoint URL. | 
-**created_timestamp** | **Number** | The time when the event occurred, in Unix timestamp format, measured in milliseconds. | 
+**created_timestamp** | **Number** | The time when the event type was triggered, in Unix timestamp format (milliseconds). - The value remains unchanged across retries. - The default webhook timeout is 2 seconds.  | 
 **type** | [**WebhookEventType**](WebhookEventType.md) |  | 
 **data** | [**WebhookEventData**](WebhookEventData.md) |  | 
 **status** | [**WebhookEventStatus**](WebhookEventStatus.md) |  | [optional] 

package/docs/WebhookEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. | 
 **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 provided by you when creating the settlement request. | 
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **destination** | [**TransactionDestination**](TransactionDestination.md) |  | 
 **result** | [**TransactionResult**](TransactionResult.md) |  | [optional] 
 **fee** | [**TransactionFee**](TransactionFee.md) |  | [optional] 
-**initiator** | **String** | The initiator of this settlement request, usually the user's API key. | [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] 
 **initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) |  | 
 **confirmed_num** | **Number** | The number of confirmations this transaction has received. | [optional] 
 **confirming_threshold** | **Number** | The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. | [optional] 
@@ -34,8 +34,8 @@ Name | Type | Description | Notes
 **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] 
 **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 created time of the settlement request, represented as a UNIX timestamp in seconds. | 
-**updated_timestamp** | **Number** | The updated time of the settlement request, represented as a UNIX timestamp in seconds. | 
+**created_timestamp** | **Number** | The creation time of the settlement request, represented as a UNIX timestamp in seconds. | 
+**updated_timestamp** | **Number** | The last update time of the settlement request, represented as a UNIX timestamp in seconds. | 
 **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] 
@@ -53,7 +53,10 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **token** | [**TokenInfo**](TokenInfo.md) |  | [optional] 
 **feedback** | **String** | The feedback provided by Cobo when a token listing request is rejected. | [optional] 
-**order_id** | **String** | The order ID corresponding to this refund. | 
+**address** | **String** | The wallet address. | 
+**wallet_uuid** | **String** | The wallet ID. | 
+**balance** | [**Balance**](Balance.md) |  | 
+**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | 
 **merchant_id** | **String** | The merchant ID. | [optional] 
 **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. | 
@@ -66,10 +69,14 @@ Name | Type | Description | Notes
 **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | 
 **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). | 
 **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional] 
+**settlement_status** | [**SettleStatus**](SettleStatus.md) |  | [optional] 
 **refund_id** | **String** | The refund order ID. | 
 **amount** | **String** | The amount in cryptocurrency to be returned for this refund order. | 
 **to_address** | **String** | The recipient's wallet address where the refund will be sent. | 
 **refund_type** | [**RefundType**](RefundType.md) |  | [optional] 
+**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund.    - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance    - `false`: The merchant is not charged any developer fee.  | [optional] 
+**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional] 
+**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional] 
 **settlement_request_id** | **String** | The settlement request ID generated by Cobo. | 
 **settlements** | [**[SettlementDetail]**](SettlementDetail.md) |  | 
 
@@ -94,6 +101,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)

package/docs/WebhookEventDataType.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. | 
 
 
 
@@ -27,6 +27,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)

package/docs/WebhookEventLog.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | The event log ID. | 
-**created_timestamp** | **Number** | The time when the log was created, in Unix timestamp format, measured in milliseconds. | 
+**created_timestamp** | **Number** | The time when the event type was triggered, in Unix timestamp format (milliseconds). - The value remains unchanged across retries. - The default webhook timeout is 2 seconds.  | 
 **request_headers** | **Object** | The request headers of the webhook event. | 
 **request_body** | [**WebhookEvent**](WebhookEvent.md) |  | 
 **response_body** | **String** | The response body of the webhook event. | [optional] 

package/docs/WebhookEventType.md

@@ -41,10 +41,16 @@
 
 * `wallet.chain.enabled` (value: `"wallet.chain.enabled"`)
 
+* `wallet.mpc.balance.updated` (value: `"wallet.mpc.balance.updated"`)
+
+* `wallet.web3.balance.updated` (value: `"wallet.web3.balance.updated"`)
+
 * `payment.transaction.created` (value: `"payment.transaction.created"`)
 
 * `payment.transaction.late` (value: `"payment.transaction.late"`)
 
+* `payment.transaction.completed` (value: `"payment.transaction.completed"`)
+
 * `payment.transaction.held` (value: `"payment.transaction.held"`)
 
 * `payment.status.updated` (value: `"payment.status.updated"`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobo/cobo-waas2",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "description": "The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's WaaS API offering. It enables you to access Cobo's full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols and streamlining blockchain interactions, this API allows you to concentrate on your core business activities without worrying about the safety of your assets. The WaaS 2.0 API presents the following key features:  - A unified API for Cobo's [all four wallet types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform) - Support for 80+ chains and 3000+ tokens - A comprehensive selection of webhook events - Flexible usage models for MPC Wallets, including [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction) and [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction) - Programmatic control of smart contract wallets such as Safe{Wallet} with fine-grained access controls - Seamlessly transfer funds across multiple exchanges, including Binance, OKX, Bybit, Deribit, and more  For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](https://www.cobo.com/developers/v2/guides/overview/introduction). ",
   "license": "GPL 2.0",
   "main": "dist/index.js",

package/docs/CreateBankAccountRequest.md

@@ -1,9 +0,0 @@
-# CoboWaas2.CreateBankAccountRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**info** | **{String: Object}** | JSON-formatted bank account details. The object should include the following fields: - beneficiary_name: Name of the account holder - beneficiary_address: Address of the account holder - account_number: Bank account number - bank_name: Name of the bank - bank_address: Address of the bank - iban: (Optional) International Bank Account Number - swift_or_bic: SWIFT or BIC code of the bank  | 
-
-

package/docs/TransactionMessageSignBTCEIP191Destination.md

@@ -1,10 +0,0 @@
-# CoboWaas2.TransactionMessageSignBTCEIP191Destination
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) |  | 
-**message** | **String** | The raw data of the message to be signed, encoded in Base64 format. | 
-
-