@cobo/cobo-waas2 1.31.0 → 1.32.0

package/docs/PaymentApi.md

@@ -66,6 +66,7 @@ Method | HTTP request | Description
 [**listTopUpPayerAccounts**](PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
 [**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
 [**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
+[**triggerTestPaymentsWebhookEvent**](PaymentApi.md#triggerTestPaymentsWebhookEvent) | **POST** /payments/webhooks/trigger | Trigger test webhook event
 [**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
 [**updateCounterparty**](PaymentApi.md#updateCounterparty) | **PUT** /payments/counterparty/{counterparty_id} | Update counterparty
 [**updateDestination**](PaymentApi.md#updateDestination) | **PUT** /payments/destination/{destination_id} | Update destination
@@ -2815,11 +2816,11 @@ Name | Type | Description  | Notes
 
 ## listMerchantBalances
 
-> ListMerchantBalances200Response listMerchantBalances(token_id, opts)
+> ListMerchantBalances200Response listMerchantBalances(opts)
 
 List merchant balances
 
- This operation retrieves the balance information for specified merchants.   The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned.  For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances). 
+This operation retrieves merchant balance information.  You need to specify at least one of `merchant_ids` or `token_id` to filter the results.  <Note>Do not pass `acquiring_type` for this operation.</Note>  For more information, refer to [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). 
 
 ### Example
 
@@ -2833,12 +2834,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
 apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
 // Call the API
 const apiInstance = new CoboWaas2.PaymentApi();
-const token_id = "ETH_USDT";
 const opts = {
   'merchant_ids': "M1001,M1002,M1003",
+  'token_id': "ETH_USDT",
   'acquiring_type': new CoboWaas2.AcquiringType()
 };
-apiInstance.listMerchantBalances(token_id, opts).then((data) => {
+apiInstance.listMerchantBalances(opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
   console.error(error);
@@ -2851,8 +2852,8 @@ apiInstance.listMerchantBalances(token_id, opts).then((data) => {
 
 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 &#x60;{CHAIN}_{TOKEN}&#x60;. Supported values include:   - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60;   - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60;  | 
- **merchant_ids** | **String**| A list of merchant IDs to query. | [optional] 
+ **merchant_ids** | **String**| The comma-separated list of merchant IDs to filter by.  At least one of &#x60;merchant_ids&#x60; or &#x60;token_id&#x60; must be provided.  For more information about merchants, refer to [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview).  | [optional] 
+ **token_id** | **String**| The token ID that identifies the cryptocurrency.  At least one of &#x60;merchant_ids&#x60; or &#x60;token_id&#x60; must be provided.  For a complete list of supported tokens, refer to [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview).  | [optional] 
  **acquiring_type** | [**AcquiringType**](.md)| This parameter has been deprecated | [optional] 
 
 ### Return type
@@ -3441,6 +3442,58 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## triggerTestPaymentsWebhookEvent
+
+> TriggerTestPaymentWebhookEventResponse triggerTestPaymentsWebhookEvent(opts)
+
+Trigger test webhook event
+
+This operation tests the functionality of your Payments webhook endpoint by triggering a test webhook event. The test event is sent to all endpoints you have registered on Cobo Portal.  You need to specify the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the &#x60;override_data&#x60; property to customize the payload.  For more information about Payments webhooks, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). For webhook event types and payload structure, refer to [List all webhook events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-webhook-events). 
+
+### 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.PaymentApi();
+const opts = {
+  'TriggerTestPaymentsWebhookEventRequest': new CoboWaas2.TriggerTestPaymentsWebhookEventRequest()
+};
+apiInstance.triggerTestPaymentsWebhookEvent(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **TriggerTestPaymentsWebhookEventRequest** | [**TriggerTestPaymentsWebhookEventRequest**](TriggerTestPaymentsWebhookEventRequest.md)| The request body used to trigger a test Payments webhook event.  You need to specify the event type. You can optionally include the &#x60;override_data&#x60; property to customize the payload. The provided fields must match the webhook event data structure for the specified event type.  | [optional] 
+
+### Return type
+
+[**TriggerTestPaymentWebhookEventResponse**](TriggerTestPaymentWebhookEventResponse.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## updateBankAccountById
 
 > BankAccount updateBankAccountById(bank_account_id, opts)

package/docs/ReportType.md

@@ -31,6 +31,8 @@
 
 * `Summary` (value: `"Summary"`)
 
+* `BulkSend` (value: `"BulkSend"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/TransactionDepositToAddressDestinationTxInfo.md

@@ -5,5 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **vout_n** | **Number** | The output index of the UTXO. | [optional] 
+**object_id** | **String** | The ID of the blockchain object to spend (e.g., SUI Coin object). | [optional] 
+**version** | **String** | Object version number. | [optional] 
 
 

package/docs/TransactionRawTxInfo.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **selected_utxos** | [**[TransactionSelectedUtxo]**](TransactionSelectedUtxo.md) | The selected UTXOs to be consumed in the transaction. | [optional] 
 **raw_tx** | **String** | The raw transaction data. | [optional] 
 **unsigned_raw_tx** | **String** | The unsigned raw transaction data. | [optional] 
-**utxo_change** | [**TransactionUtxoChange**](TransactionUtxoChange.md) |  | [optional] 
+**utxo_change** | [**TransactionUtxoChange**](TransactionUtxoChange.md) | Deprecated. Use `utxo_changes` instead. | [optional] 
+**utxo_changes** | [**[TransactionUtxoChange]**](TransactionUtxoChange.md) | The UTXO change outputs in the transaction. | [optional] 
 
 

package/docs/TransactionSelectedUtxo.md

@@ -6,9 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **tx_hash** | **String** | The transaction hash of the UTXO. | [optional] 
 **vout_n** | **Number** | The output index of the UTXO. | [optional] 
+**token_id** | **String** | The token ID of the UTXO. | [optional] 
 **address** | **String** | The address of the UTXO. | [optional] 
 **value** | **String** | The value of the UTXO. | [optional] 
 **redeem_script** | **String** | The redeem script used in P2SH and P2WSH transactions. | [optional] 
 **revealed_script** | **String** | The revealed script used for Taproot script-path spend transaction. | [optional] 
+**object_id** | **String** | The ID of the blockchain object to spend (e.g., SUI Coin object). | [optional] 
+**version** | **String** | Object version number. | [optional] 
 
 

package/docs/TransactionUtxoChange.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **address** | **String** | The receiving address of the UTXO change output. | [optional] 
 **value** | **String** | The amount of the UTXO change output. | [optional] 
+**token_id** | **String** | The token ID of the UTXO change output. | [optional] 
 
 

package/docs/TransactionsApi.md

@@ -775,8 +775,8 @@ 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] 
  **project_id** | **String**| (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).  | [optional] 
- **min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time.  If not provided, the default value is 90 days before the current time. This default value is subject to change.  | [optional] 
- **max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time.  If not provided, the default value is the current time. This default value is subject to change.  | [optional] 
+ **min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time.  If you specify `min_created_timestamp` without specifying `max_created_timestamp`, `max_created_timestamp` is automatically set to `min_created_timestamp` + 90 days. If you specify both, the time range cannot exceed 90 days.  If not provided, the default value is 90 days before the current time. This default value is subject to change.  | [optional] 
+ **max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time.  If you specify `max_created_timestamp` without specifying `min_created_timestamp`, `min_created_timestamp` is automatically set to `max_created_timestamp` - 90 days. If you specify both, the time range cannot exceed 90 days.  If not provided, the default value is the current time. This default value is subject to change.  | [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] 

package/docs/TriggerTestPaymentWebhookEventResponse.md

@@ -0,0 +1,9 @@
+# CoboWaas2.TriggerTestPaymentWebhookEventResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**triggered** | **Boolean** | Whether a test webhook event was successfully triggered. - `true`: The test webhook event was successfully triggered. - `false`: The test webhook event could not be triggered.  | [optional] 
+
+

package/docs/TriggerTestPaymentsWebhookEventRequest.md

@@ -0,0 +1,10 @@
+# CoboWaas2.TriggerTestPaymentsWebhookEventRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_type** | [**WebhookEventType**](WebhookEventType.md) |  | 
+**override_data** | **Object** | An optional object to customize the webhook event payload. Include only the fields you want to override.  The provided fields must match the webhook event data structure for the specified event type. For the full event data structure, refer to the `data.data` property in the response of [List all webhook events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-webhook-events).  If this property is omitted, a default payload is returned.  | [optional] 
+
+

package/docs/UTXO.md

@@ -13,5 +13,9 @@ Name | Type | Description | Notes
 **is_locked** | **Boolean** | Whether the UTXO is locked. | [optional] 
 **confirmed_number** | **Number** | The number of confirmations for the UTXO. | [optional] 
 **is_frozen** | **Boolean** | Whether the UTXO is frozen. | [optional] 
+**is_change** | **Boolean** | Whether the UTXO is a change output of a transaction. | [optional] 
+**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. | [optional] 
+**object_id** | **String** | The ID of the blockchain object to spend (e.g., SUI Coin object). | [optional] 
+**version** | **String** | Object version number. | [optional] 
 
 

package/docs/UpdateDestinationBankAccount.md

@@ -15,5 +15,7 @@ Name | Type | Description | Notes
 **iban_code** | **String** | The IBAN code of the bank account. | [optional] 
 **further_credit** | **String** | The further credit of the bank account. | [optional] 
 **intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) |  | [optional] 
+**country** | **String** | Beneficiary's country, in ISO 3166-1 alpha-3 format. | [optional] 
+**city** | **String** | Beneficiary's city. | [optional] 
 
 

package/docs/WalletsApi.md

@@ -27,6 +27,7 @@ Method | HTTP request | Description
 [**listTokenBalancesForAddress**](WalletsApi.md#listTokenBalancesForAddress) | **GET** /wallets/{wallet_id}/addresses/{address}/tokens | List token balances by address
 [**listTokenBalancesForWallet**](WalletsApi.md#listTokenBalancesForWallet) | **GET** /wallets/{wallet_id}/tokens | List token balances by wallet
 [**listTokenListingRequests**](WalletsApi.md#listTokenListingRequests) | **GET** /wallets/tokens/listing_requests | List token listing requests
+[**listTransactionUtxos**](WalletsApi.md#listTransactionUtxos) | **GET** /wallets/{wallet_id}/transaction_utxos | List transaction UTXOs
 [**listUtxos**](WalletsApi.md#listUtxos) | **GET** /wallets/{wallet_id}/utxos | List UTXOs
 [**listWallets**](WalletsApi.md#listWallets) | **GET** /wallets | List all wallets
 [**lockUtxos**](WalletsApi.md#lockUtxos) | **POST** /wallets/{wallet_id}/utxos/lock | Lock UTXOs
@@ -1320,6 +1321,76 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## listTransactionUtxos
+
+> ListUtxos200Response listTransactionUtxos(wallet_id, chain_id, tx_hash, opts)
+
+List transaction UTXOs
+
+The operation retrieves a list of UTXOs for a specified transaction of a wallet. You must specify the wallet, chain, and transaction hash.  <Note>This operation is applicable to MPC and Custodial Web3 Wallets.</Note> 
+
+### 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.WalletsApi();
+const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+const chain_id = "ETH";
+const tx_hash = "dd7e1cecf6bbde1844ee1815b780711a1e306a718bcd23cd64401b48ef88eb83";
+const opts = {
+  'is_change': false,
+  'vout_n': 0,
+  'token_id': "ETH_USDT",
+  'address': "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
+};
+apiInstance.listTransactionUtxos(wallet_id, chain_id, tx_hash, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **wallet_id** | **String**| The wallet ID. | 
+ **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). | 
+ **tx_hash** | **String**| The transaction hash to filter UTXOs by. | 
+ **is_change** | **Boolean**| Filter UTXOs by whether they are change outputs. | [optional] 
+ **vout_n** | **Number**| The output index of the UTXO to filter by. | [optional] 
+ **token_id** | **String**| The token ID, which 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] 
+ **address** | **String**|  | [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] 
+
+### Return type
+
+[**ListUtxos200Response**](ListUtxos200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## listUtxos
 
 > ListUtxos200Response listUtxos(wallet_id, token_id, opts)

package/docs/WebhookEventType.md

@@ -85,6 +85,10 @@
 
 * `payment.transaction.external.completed` (value: `"payment.transaction.external.completed"`)
 
+* `payment.transaction.settlement_network.created` (value: `"payment.transaction.settlement_network.created"`)
+
+* `payment.transaction.settlement_network.completed` (value: `"payment.transaction.settlement_network.completed"`)
+
 * `compliance.disposition.status.updated` (value: `"compliance.disposition.status.updated"`)
 
 * `compliance.kyt.screenings.status.updated` (value: `"compliance.kyt.screenings.status.updated"`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobo/cobo-waas2",
-  "version": "1.31.0",
+  "version": "1.32.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",