@cobo/cobo-waas2 1.35.0 → 1.37.0

package/docs/ComplianceKytScreeningsUpdateEventData.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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. | 
 **transaction_id** | **String** | The transaction ID. | 
 **transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) |  | 
 **review_status** | [**ReviewStatusType**](ReviewStatusType.md) |  | 
@@ -56,6 +56,10 @@ Name | Type | Description | Notes
 
 * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
 
+* `Organization` (value: `"Organization"`)
+
+* `FiatTransaction` (value: `"FiatTransaction"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/CreateBulkSendRequest.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**request_id** | **String** | The request ID that is used to track a bulk send request. The request ID is provided by you and must be unique within your system. | [optional] 
 **source_account** | **String** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`.  | 
 **execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) |  | 
 **description** | **String** | The description for the entire bulk send batch. | [optional] 

package/docs/CreateSatoshiTestChallengeRequest.md

@@ -0,0 +1,14 @@
+# CoboWaas2.CreateSatoshiTestChallengeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | [**SatoshiTestChallengeAction**](SatoshiTestChallengeAction.md) |  | 
+**chain_id** | **String** | The chain ID of the counterparty address. See the operation description for supported chains. | 
+**from_address** | **String** | The counterparty (self-custody) wallet address that will transfer the micro-deposit. | 
+**transaction_id** | **String** | The Cobo transaction ID that this Satoshi Test is verifying for. | 
+**transaction_type** | [**TravelRuleTransactionType**](TravelRuleTransactionType.md) |  | 
+**challenge_id** | **String** | The `challenge_id` returned by a previous `PREPARE` call. - When `action=SUBMIT`: if provided, activates that specific challenge by id (recommended when you cached the id client-side after `PREPARE`). If omitted, the server activates the latest matching challenge identified by `(chain_id, from_address)`. - When `action=PREPARE`: **must be omitted**. A new challenge is always generated; passing a `challenge_id` here will cause the request to be rejected.  | [optional] 
+
+

package/docs/FiatTransactionEventData.md

@@ -0,0 +1,84 @@
+# CoboWaas2.FiatTransactionEventData
+
+## 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. | 
+**transaction_id** | **String** | The transaction ID. | 
+**main_transaction_id** | **String** | The UUID of the parent (main) transaction that this record is associated with. Set only when the current record is a gas/fee transaction initiated by FeeStation; omit for main transactions. | [optional] 
+**transaction_type** | [**FeeStationFiatTransactionType**](FeeStationFiatTransactionType.md) |  | 
+**amount** | **String** | The transaction amount. | 
+**fiat_currency** | **String** | The fiat currency of the transaction. Possible values include:   - `USD`: US Dollar.  | 
+**status** | **String** | The status of the fiat transaction. Possible values include:   - `Created`: The transaction has been created.   - `Succeeded`: The transaction has been completed successfully.  | 
+**cobo_category** | **[String]** | The Cobo category of the transaction. | [optional] 
+**created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. | [optional] 
+**modified_timestamp** | **Number** | The time when the transaction was last modified, in Unix timestamp format, measured in milliseconds. | [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"`)
+
+* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
+
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
+* `SuspendedToken` (value: `"SuspendedToken"`)
+
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
+* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
+
+* `Organization` (value: `"Organization"`)
+
+* `FiatTransaction` (value: `"FiatTransaction"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+
+
+## Enum: StatusEnum
+
+
+* `Created` (value: `"Created"`)
+
+* `Succeeded` (value: `"Succeeded"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/GetTransactionLimitation200Response.md

@@ -6,7 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **vasp_list** | [**[Vasp]**](Vasp.md) | A list of virtual asset service providers (VASP) you can select as the transaction source or destination. | [optional] 
 **is_threshold_reached** | **Boolean** | Indicates whether the transaction amount exceeds a predefined threshold. If exceeded, additional information is required when filling Travel Rule details. - `true`: Threshold exceeded. - `false`: Threshold not exceeded.  | [optional] 
-**self_custody_wallet_challenge** | **String** | A human-readable, time-sensitive message to be signed by the wallet owner. The message contains key information including the wallet address, a unique nonce, and a timestamp. Signing this message confirms ownership of the wallet and allows the operation to proceed.  | [optional] 
+**self_custody_wallet_challenge** | **String** | **Deprecated.** Use [Get self-custody signature challenge](#operation/get_signature_challenge) instead. This field will be removed in a future release.  A human-readable, time-sensitive message to be signed by the wallet owner. The message contains key information including the wallet address, a unique nonce, and a timestamp. Signing this message confirms ownership of the wallet and allows the operation to proceed.  | [optional] 
 **connect_wallet_list** | **[String]** | A list of self-custody wallet providers you can select as the transaction source or destination. | [optional] 
+**satoshi_test_supported** | **Boolean** | Indicates whether Satoshi Test (on-chain micro-deposit verification) is supported for the transaction's chain. - `true`: You can initiate a Satoshi Test challenge to verify the counterparty address. - `false`: The chain does not support Satoshi Test; use signature verification instead.  | [optional] 
 
 

package/docs/ListAddressVerifications200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListAddressVerifications200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[AddressVerification]**](AddressVerification.md) | The page of address verification records. | 
+**pagination** | [**Pagination**](Pagination.md) |  | 
+
+

package/docs/ListBulkSends200Response.md

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

package/docs/MPCVaultEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. | 
 **vault_id** | **String** | The vault ID. | [optional] 
 **project_id** | **String** | The project ID. | [optional] 
 **name** | **String** | The vault name. | [optional] 
@@ -57,6 +57,10 @@ Name | Type | Description | Notes
 
 * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
 
+* `Organization` (value: `"Organization"`)
+
+* `FiatTransaction` (value: `"FiatTransaction"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/OrganizationEventData.md

@@ -0,0 +1,64 @@
+# CoboWaas2.OrganizationEventData
+
+## 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. | 
+**org_id** | **String** | The organization ID. | [optional] 
+**name** | **String** | The organization name. | [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"`)
+
+* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
+
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
+* `SuspendedToken` (value: `"SuspendedToken"`)
+
+* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
+
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
+* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
+
+* `Organization` (value: `"Organization"`)
+
+* `FiatTransaction` (value: `"FiatTransaction"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/PaymentAddressUpdateEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. | 
 **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. | 
 **payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. | 
 **chain** | **String** | The chain ID. | 
@@ -56,6 +56,10 @@ Name | Type | Description | Notes
 
 * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
 
+* `Organization` (value: `"Organization"`)
+
+* `FiatTransaction` (value: `"FiatTransaction"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentApi.md

@@ -47,8 +47,10 @@ Method | HTTP request | Description
 [**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
 [**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Create/Get top-up address
 [**listAllocationItems**](PaymentApi.md#listAllocationItems) | **GET** /payments/allocation_items | List all allocation items
+[**listBalanceChanges**](PaymentApi.md#listBalanceChanges) | **GET** /payments/balance_changes | List balance changes
 [**listBatchAllocations**](PaymentApi.md#listBatchAllocations) | **GET** /payments/batch_allocations | List all batch allocations
 [**listBulkSendItems**](PaymentApi.md#listBulkSendItems) | **GET** /payments/bulk_sends/{bulk_send_id}/items | List bulk send items
+[**listBulkSends**](PaymentApi.md#listBulkSends) | **GET** /payments/bulk_sends | List bulk sends
 [**listCounterparties**](PaymentApi.md#listCounterparties) | **GET** /payments/counterparty | List all counterparties
 [**listCounterpartyEntries**](PaymentApi.md#listCounterpartyEntries) | **GET** /payments/counterparty_entry | List counterparty entries
 [**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
@@ -2330,6 +2332,76 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## listBalanceChanges
+
+> PaymentBalanceChangeResponse listBalanceChanges(source_account, opts)
+
+List balance changes
+
+This operation retrieves balance changes for the specified source account. Each balance change includes the source information, token ID, changed amount, account balances before and after the change, flow direction, and creation time.  You need to specify `source_account`. Currently, use `developer` as the source account. You can use pagination parameters to control the response size, and filter balance changes by `token_id`, `flow_direction`, `min_created_timestamp`, `max_created_timestamp`, `source_type`, or `source_id`.  <Note>When specifying `source_id`, you must also specify `source_type`.</Note>  For more information, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). 
+
+### 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 source_account = "developer";
+const opts = {
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
+  'token_id': "ETH_USDT",
+  'flow_direction': new CoboWaas2.PaymentBalanceFlowDirection(),
+  'min_created_timestamp': 1744689600,
+  'max_created_timestamp': 1744776000,
+  'source_type': new CoboWaas2.PaymentBalanceChangeSourceType(),
+  'source_id': "po_1234567890"
+};
+apiInstance.listBalanceChanges(source_account, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_account** | **String**| The source account for which to retrieve balance changes. Currently, use &#x60;developer&#x60;. | 
+ **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] 
+ **token_id** | **String**| The token ID used to filter balance changes. For a complete list of supported tokens, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview).  | [optional] 
+ **flow_direction** | [**PaymentBalanceFlowDirection**](.md)| The direction of the balance change relative to the source account. Possible values include: - &#x60;in&#x60;: Funds flow into the source account. - &#x60;out&#x60;: Funds flow out of the source account.  | [optional] 
+ **min_created_timestamp** | **Number**| The minimum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or after this time are returned. | [optional] 
+ **max_created_timestamp** | **Number**| The maximum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or before this time are returned. | [optional] 
+ **source_type** | [**PaymentBalanceChangeSourceType**](.md)| The source type used to filter balance changes. Possible values include: - &#x60;Init&#x60;: Balance change caused by initialization. - &#x60;OrderIn&#x60;: Balance change from an order-in payment. - &#x60;LatePayment&#x60;: Balance change from a late payment. - &#x60;TopUp&#x60;: Balance change from a top-up. - &#x60;UnexceptedIn&#x60;: Balance change from an unexpected incoming payment. - &#x60;RefundOut&#x60;: Balance change from a refund payout. - &#x60;Payout&#x60;: Balance change from a payout. - &#x60;UnexceptedOut&#x60;: Balance change from an unexpected outgoing payment. - &#x60;Allocation&#x60;: Balance change from an allocation. - &#x60;SettlementNetwork&#x60;: Balance change from the settlement network. - &#x60;BulkSend&#x60;: Balance change from a bulk send.  &lt;Note&gt;When specifying &#x60;source_id&#x60;, you must also specify &#x60;source_type&#x60;.&lt;/Note&gt;  | [optional] 
+ **source_id** | **String**| The source ID used to filter balance changes.  &lt;Note&gt;When specifying &#x60;source_id&#x60;, you must also specify &#x60;source_type&#x60;.&lt;/Note&gt;  | [optional] 
+
+### Return type
+
+[**PaymentBalanceChangeResponse**](PaymentBalanceChangeResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## listBatchAllocations
 
 > ListBatchAllocations200Response listBatchAllocations(opts)
@@ -2446,6 +2518,64 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## listBulkSends
+
+> ListBulkSends200Response listBulkSends(opts)
+
+List bulk sends
+
+This operation retrieves the list of bulk sends. 
+
+### 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 = {
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
+  'request_id': "random_request_id"
+};
+apiInstance.listBulkSends(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **request_id** | **String**| The request ID. | [optional] 
+
+### Return type
+
+[**ListBulkSends200Response**](ListBulkSends200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## listCounterparties
 
 > ListCounterparties200Response listCounterparties(opts)

package/docs/PaymentBalanceChange.md

@@ -0,0 +1,19 @@
+# CoboWaas2.PaymentBalanceChange
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_id** | **String** | The source ID of the balance change. | 
+**source_type** | [**PaymentBalanceChangeSourceType**](PaymentBalanceChangeSourceType.md) |  | 
+**token_id** | **String** | The token ID of the balance change. | 
+**amount** | **String** | The balance change amount, truncated to two decimal places and represented as a numeric string. | 
+**amount_raw** | **String** | The balance change amount in the token's decimal precision, represented as a numeric string. | 
+**balance_before** | **String** | The account balance before the balance change, truncated to two decimal places and represented as a numeric string. | 
+**balance_before_raw** | **String** | The account balance before the balance change in the token's decimal precision, represented as a numeric string. | 
+**balance_after** | **String** | The account balance after the balance change, truncated to two decimal places and represented as a numeric string. | 
+**balance_after_raw** | **String** | The account balance after the balance change in the token's decimal precision, represented as a numeric string. | 
+**flow_direction** | [**PaymentBalanceFlowDirection**](PaymentBalanceFlowDirection.md) |  | 
+**created_timestamp** | **Number** | The time when the balance change was created, represented as a UNIX timestamp in seconds. | 
+
+

package/docs/PaymentBalanceChangeResponse.md

@@ -0,0 +1,10 @@
+# CoboWaas2.PaymentBalanceChangeResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[PaymentBalanceChange]**](PaymentBalanceChange.md) | The list of balance changes. | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/PaymentBalanceChangeSourceType.md

@@ -0,0 +1,30 @@
+# CoboWaas2.PaymentBalanceChangeSourceType
+
+## Enum
+
+
+* `Init` (value: `"Init"`)
+
+* `OrderIn` (value: `"OrderIn"`)
+
+* `LatePayment` (value: `"LatePayment"`)
+
+* `TopUp` (value: `"TopUp"`)
+
+* `UnexceptedIn` (value: `"UnexceptedIn"`)
+
+* `RefundOut` (value: `"RefundOut"`)
+
+* `Payout` (value: `"Payout"`)
+
+* `UnexceptedOut` (value: `"UnexceptedOut"`)
+
+* `Allocation` (value: `"Allocation"`)
+
+* `SettlementNetwork` (value: `"SettlementNetwork"`)
+
+* `BulkSend` (value: `"BulkSend"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/PaymentBalanceFlowDirection.md

@@ -0,0 +1,12 @@
+# CoboWaas2.PaymentBalanceFlowDirection
+
+## Enum
+
+
+* `in` (value: `"in"`)
+
+* `out` (value: `"out"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/PaymentBulkSend.md

@@ -5,11 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bulk_send_id** | **String** | The bulk send ID. | 
+**request_id** | **String** | The request ID. | [optional] 
 **source_account** | **String** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`.  | 
 **description** | **String** | The description for the entire bulk send batch. | [optional] 
 **execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) |  | 
 **status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) |  | 
 **created_timestamp** | **Number** | The created time of the bulk send, represented as a UNIX timestamp in seconds. | 
 **updated_timestamp** | **Number** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. | 
+**commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded. | [optional] 
 
 

package/docs/PaymentBulkSendEvent.md

@@ -4,14 +4,16 @@
 
 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. | 
 **bulk_send_id** | **String** | The bulk send ID. | 
+**request_id** | **String** | The request ID. | [optional] 
 **source_account** | **String** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`.  | 
 **description** | **String** | The description for the entire bulk send batch. | [optional] 
 **execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) |  | 
 **status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) |  | 
 **created_timestamp** | **Number** | The created time of the bulk send, represented as a UNIX timestamp in seconds. | 
 **updated_timestamp** | **Number** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. | 
+**commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded. | [optional] 
 
 
 
@@ -58,6 +60,10 @@ Name | Type | Description | Notes
 
 * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
 
+* `Organization` (value: `"Organization"`)
+
+* `FiatTransaction` (value: `"FiatTransaction"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentBulkSendItem.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **receiving_address** | **String** | The receiving address. | 
 **amount** | **String** | The amount of the cryptocurrency to be sent to the recipient. | 
 **description** | **String** | A note or comment about the bulk send item. | [optional] 
+**tx_hash** | **String** | The transaction hash of the bulk send item. | [optional] 
 **status** | [**PaymentBulkSendItemStatus**](PaymentBulkSendItemStatus.md) |  | 
 **validation_status** | [**PaymentBulkSendItemValidationStatus**](PaymentBulkSendItemValidationStatus.md) |  | 
 

package/docs/PaymentOrderEventData.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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. | 
 **order_id** | **String** | The order ID. | 
 **merchant_id** | **String** | The merchant ID. | [optional] 
 **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional] 
@@ -74,6 +74,10 @@ Name | Type | Description | Notes
 
 * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
 
+* `Organization` (value: `"Organization"`)
+
+* `FiatTransaction` (value: `"FiatTransaction"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentPayout.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) |  | [optional] 
 **initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional] 
 **actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.)  | [optional] 
-**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees of the payout. | [optional] 
+**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded. | [optional] 
 **remark** | **String** | A note or comment about the payout. | [optional] 
 **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) |  | 
 **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | 

package/docs/PaymentPayoutDetail.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) |  | [optional] 
 **initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional] 
 **actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.)  | [optional] 
-**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees of the payout. | [optional] 
+**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded. | [optional] 
 **remark** | **String** | A note or comment about the payout. | [optional] 
 **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) |  | 
 **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |