@cobo/cobo-waas2 1.28.0 → 1.30.0

package/docs/ComplianceApi.md

@@ -4,9 +4,12 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**createKyaScreenings**](ComplianceApi.md#createKyaScreenings) | **POST** /compliance/kya/screenings | Create KYA address screening requests
 [**getDispositionStatus**](ComplianceApi.md#getDispositionStatus) | **GET** /compliance/funds/disposition | Get disposition status
+[**getKyaScreening**](ComplianceApi.md#getKyaScreening) | **GET** /compliance/kya/screenings/{screening_id} | Get KYA address screening result
 [**getKytScreeningStatus**](ComplianceApi.md#getKytScreeningStatus) | **GET** /compliance/kyt/screenings/status | Get KYT screening status
 [**isolateFunds**](ComplianceApi.md#isolateFunds) | **POST** /compliance/funds/disposition/isolate | Isolate funds
+[**listKyaScreenings**](ComplianceApi.md#listKyaScreenings) | **GET** /compliance/kya/screenings | List KYA address screening results
 [**refundFunds**](ComplianceApi.md#refundFunds) | **POST** /compliance/funds/disposition/refund | Refund funds
 [**submitKytManualReview**](ComplianceApi.md#submitKytManualReview) | **POST** /compliance/kyt/screenings/manual_review | Submit KYT manual review result
 [**submitKytScreeningDecisions**](ComplianceApi.md#submitKytScreeningDecisions) | **POST** /compliance/kyt/screenings/decisions | Submit KYT screening decision
@@ -14,6 +17,58 @@ Method | HTTP request | Description
 
 
 
+## createKyaScreenings
+
+> [KyaScreeningResult] createKyaScreenings(opts)
+
+Create KYA address screening requests
+
+This operation submits up to 50 address screening requests in one call to assess address compliance and risk levels.  <Note>This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries.</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.ComplianceApi();
+const opts = {
+  'CreateKyaScreeningsBody': new CoboWaas2.CreateKyaScreeningsBody()
+};
+apiInstance.createKyaScreenings(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **CreateKyaScreeningsBody** | [**CreateKyaScreeningsBody**](CreateKyaScreeningsBody.md)| The request body to create KYA address screening requests. | [optional] 
+
+### Return type
+
+[**[KyaScreeningResult]**](KyaScreeningResult.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## getDispositionStatus
 
 > DispositionQueryResponse getDispositionStatus(transaction_id)
@@ -64,6 +119,56 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## getKyaScreening
+
+> KyaScreeningResult getKyaScreening(screening_id)
+
+Get KYA address screening result
+
+This operation retrieves a specific address screening result by &#x60;screening_id&#x60;, including risk assessment information.  &lt;Info&gt;This endpoint returns the full screening details including risk level, summary, and detailed risk category exposures.&lt;/Info&gt; 
+
+### 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.ComplianceApi();
+const screening_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+apiInstance.getKyaScreening(screening_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **screening_id** | **String**| The unique identifier (UUID) of the address screening request. | 
+
+### Return type
+
+[**KyaScreeningResult**](KyaScreeningResult.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## getKytScreeningStatus
 
 > KytScreeningsTransaction getKytScreeningStatus(transaction_id)
@@ -166,6 +271,64 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## listKyaScreenings
+
+> ListKyaScreenings200Response listKyaScreenings(opts)
+
+List KYA address screening results
+
+This operation retrieves the results of specified screening requests with pagination support. You can filter specific screening requests using screening_ids (up to 50 IDs).  &lt;Note&gt;For larger result sets (exceeding 50 screening results), use pagination parameters (limit, before, after) to page through results.&lt;/Note&gt; 
+
+### 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.ComplianceApi();
+const opts = {
+  'screening_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,a1b2c3d4-e5f6-4321-8765-fedcba987654",
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
+};
+apiInstance.listKyaScreenings(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **screening_ids** | **String**| A comma-separated list of screening request IDs to filter specific screening results. Maximum 50 IDs allowed to ensure URL length stays within standard web server limits (typically 8KB).  Each ID must be in standard UUID format (36 characters fixed length).  Example: &#x60;f47ac10b-58cc-4372-a567-0e02b2c3d479,a1b2c3d4-e5f6-4321-8765-fedcba987654&#x60;  | [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
+
+[**ListKyaScreenings200Response**](ListKyaScreenings200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## refundFunds
 
 > DispositionResponse refundFunds(opts)

package/docs/ComplianceDispositionUpdateEventData.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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `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. | 
 **transaction_id** | **String** | The transaction ID. | 
 **disposition_type** | [**DispositionType**](DispositionType.md) |  | 
 **disposition_status** | [**DispositionStatus**](DispositionStatus.md) |  | 
@@ -45,6 +45,8 @@ Name | Type | Description | Notes
 
 * `PaymentPayout` (value: `"PaymentPayout"`)
 
+* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -53,6 +55,8 @@ Name | Type | Description | Notes
 
 * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
 
+* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/ComplianceKyaScreeningsUpdateEventData.md

@@ -0,0 +1,64 @@
+# CoboWaas2.ComplianceKyaScreeningsUpdateEventData
+
+## 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. | 
+**screening_id** | **String** | The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). | 
+**address** | **String** | The screened blockchain address. | 
+**chain_id** | **String** | The chain identifier. | 
+**status** | [**KyaScreeningStatus**](KyaScreeningStatus.md) |  | 
+**created_timestamp** | **Number** | The time when the screening request was created, in Unix timestamp format, measured in milliseconds. | 
+**updated_timestamp** | **Number** | The time when the screening status was updated, in Unix timestamp format, measured in milliseconds. | 
+
+
+
+## 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"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `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. | 
 **transaction_id** | **String** | The transaction ID. | 
 **transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) |  | 
 **review_status** | [**ReviewStatusType**](ReviewStatusType.md) |  | 
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
 
 * `PaymentPayout` (value: `"PaymentPayout"`)
 
+* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -52,6 +54,8 @@ Name | Type | Description | Notes
 
 * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
 
+* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/ContractCallParams.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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. | 
+**request_id** | **String** | A client-defined unique request identifier (idempotency key) used to prevent duplicate contract call requests. It must be unique within the same organization. Requests with the same request ID will be rejected with an error. | 
 **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). | 
 **source** | [**ContractCallSource**](ContractCallSource.md) |  | 
 **destination** | [**ContractCallDestination**](ContractCallDestination.md) |  | 
-**description** | **String** | The description of the contract call transaction. | [optional] 
+**description** | **String** | The description of the contract call transaction. Maximum length is 2048 characters for MPC Wallets and Custodial Wallets (Web3 Wallets), and 1000 characters for Custodial Wallets (Asset Wallets). | [optional] 
 **category_names** | **[String]** | The custom category for you to identify your transactions. | [optional] 
 **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | [optional] 
 **transaction_process_type** | [**TransactionProcessType**](TransactionProcessType.md) |  | [optional] 

package/docs/CounterpartyWalletAddressDetail.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **counterparty_type** | [**CounterpartyType**](CounterpartyType.md) |  | 
 **wallet_address_id** | **String** | The wallet address ID. | 
 **address** | **String** | The wallet address. | 
-**chain_id** | **String** | The chain ID of the cryptocurrency. | 
+**chain_id** | **String** | The chain ID of the address. | 
 **updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. | 
 
 

package/docs/CreateBatchAllocationRequest.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_id** | **String** | The request ID that is used to track a allocation request. The request ID is provided by you and must be unique. | 
-**allocation_requests** | [**[AllocationRequest]**](AllocationRequest.md) |  | 
+**request_id** | **String** | The request ID that is used to track a batch allocation request. The request ID is provided by you and must be unique. | 
+**allocation_params** | [**[AllocationParam]**](AllocationParam.md) |  | 
 
 

package/docs/CreateBulkSendRequest.md

@@ -0,0 +1,12 @@
+# CoboWaas2.CreateBulkSendRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**payout_params** | [**[CreateBulkSendRequestPayoutParamsInner]**](CreateBulkSendRequestPayoutParamsInner.md) | The bulk send items. | 
+
+

package/docs/CreateBulkSendRequestPayoutParamsInner.md

@@ -0,0 +1,12 @@
+# CoboWaas2.CreateBulkSendRequestPayoutParamsInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The token ID of the cryptocurrency to be sent to the recipient. | 
+**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] 
+
+

package/docs/CreateCounterpartyEntry201Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.CreateCounterpartyEntry201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**counterparty_id** | **String** | The counterparty ID. | 
+**wallet_addresses** | [**[WalletAddress]**](WalletAddress.md) | The wallet addresses of the counterparty. | 
+
+

package/docs/CreateCounterpartyEntryRequest.md

@@ -0,0 +1,10 @@
+# CoboWaas2.CreateCounterpartyEntryRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**counterparty_id** | **String** | The counterparty ID. | 
+**wallet_addresses** | [**[CreateWalletAddress]**](CreateWalletAddress.md) | The wallet addresses of the counterparty. | [optional] 
+
+

package/docs/CreateDestinationEntry201Response.md

@@ -0,0 +1,11 @@
+# CoboWaas2.CreateDestinationEntry201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_id** | **String** | The destination ID. | 
+**wallet_addresses** | [**[WalletAddress]**](WalletAddress.md) | The wallet addresses of the destination. | [optional] 
+**bank_accounts** | [**[DestinationBankAccount]**](DestinationBankAccount.md) | The bank accounts of the destination. | [optional] 
+
+

package/docs/CreateDestinationEntryRequest.md

@@ -0,0 +1,11 @@
+# CoboWaas2.CreateDestinationEntryRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_id** | **String** | The destination ID. | 
+**wallet_addresses** | [**[CreateWalletAddress]**](CreateWalletAddress.md) | The wallet addresses of the destination. | [optional] 
+**bank_accounts** | [**[CreateDestinationBankAccount]**](CreateDestinationBankAccount.md) | The bank accounts of the destination. | [optional] 
+
+

package/docs/CreateKyaScreeningsBody.md

@@ -0,0 +1,9 @@
+# CoboWaas2.CreateKyaScreeningsBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**screenings** | [**[KyaScreeningRequest]**](KyaScreeningRequest.md) | List of address screening requests. Maximum 50 addresses per call. | 
+
+

package/docs/CreateMerchantRequest.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The merchant name. | 
 **wallet_id** | **String** | This field has been deprecated. | [optional] 
-**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances). | [optional] 
+**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances). | [optional] 
 **wallet_setup** | [**WalletSetup**](WalletSetup.md) |  | [optional] 
 
 

package/docs/CreatePaymentOrderRequest.md

@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 **merchant_id** | **String** | The merchant ID. | 
 **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional] 
 **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | 
-**pricing_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values:   - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | [optional] 
-**pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional] 
-**fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. For example, if order_amount is \"100.00\" and fee_amount is \"2.00\", the customer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant and \"2.00\" settled to the developer. Values must be greater than 0 and contain two decimal places. | 
-**payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values:   - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | [optional] 
-**payable_amount** | **String** | The actual payable amount of the order in the cryptocurrency. | [optional] 
+**pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`.  Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com/developers/v2/guides/overview/supported-chains-and-tokens).  | [optional] 
+**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional] 
+**fee_amount** | **String** | The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. | 
+**payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values:   - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
+**payable_amount** | **String** | The total amount the payer needs to pay, denominated in the specified `payable_currency`. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate.  Values must be greater than 0 and contain two decimal places.  | [optional] 
 **expired_in** | **Number** | The pay-in order will expire after approximately a certain number of seconds: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event.  | [optional] 
-**amount_tolerance** | **String** | Allowed amount deviation, precision to 1 decimal place. | [optional] 
-**currency** | **String** | The fiat currency of the order. | [optional] [default to '']
-**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional] 
-**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported values:   - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | [optional] 
-**use_dedicated_address** | **Boolean** | Indicates whether to allocate a dedicated address for this order.  If false, a shared address from the address pool will be used.  | [optional] 
-**custom_exchange_rate** | **String** | A custom exchange rate specified by the merchant.   - Only effective when `currency` is `\"USD\"`.   - Expressed as the amount of USD per 1 unit of the specified cryptocurrency.   - If not provided, the system will use the default internal rate.   Example: If the cryptocurrency is USDT and `custom_exchange_rate` = `\"0.99\"`, it means 1 USDT = 0.99 USD.  | [optional] 
+**amount_tolerance** | **String** | The allowed amount deviation, with precision up to 1 decimal place.  For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5)  | [optional] 
+**currency** | **String** | This field has been deprecated. Please use `pricing_currency` instead. | [optional] [default to '']
+**order_amount** | **String** | This field has been deprecated. Please use `pricing_amount` instead. | [optional] 
+**token_id** | **String** | This field has been deprecated. Please use `payable_currency` instead. | [optional] 
+**use_dedicated_address** | **Boolean** | This field has been deprecated. | [optional] 
+**custom_exchange_rate** | **String** | This field has been deprecated. | [optional] 
 
 

package/docs/CreatePayoutRequest.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_id** | **String** | The request ID that is used to track a settlement request. The request ID is provided by you and must be unique. | 
+**request_id** | **String** | The request ID that is used to track a payout request. The request ID is provided by you and must be unique. | 
+**source_account** | **String** | The source account from which the payout 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\"`.  | 
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | 
 **payout_params** | [**[PaymentPayoutParam]**](PaymentPayoutParam.md) |  | 
-**bank_account_id** | **String** | ｜ Only used in OffRamp payout channel. The ID of the bank account where the settled funds will be deposited. | [optional] 
-**currency** | **String** | The fiat currency for the create payouts. | [optional] 
-**remark** | **String** | The remark for the create payouts. | [optional] 
+**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) |  | 
+**remark** | **String** | An optional note or comment about the payout for your internal reference. | [optional] 
 
 

package/docs/CreateRefundRequest.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **token_id** | **String** | The ID of the cryptocurrency used for refund. Supported values:    - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
 **refund_type** | [**RefundType**](RefundType.md) |  | 
 **order_id** | **String** | The ID of the original pay-in order associated with this refund. Use this to track refunds against specific payments. | [optional] 
-**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).     - `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  When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified.  | [optional] 
-**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).  This field is required when `charge_merchant_fee` is `true`. Must be:   - A positive integer with up to two decimal places.   - Less than the refund amount  | [optional] 
+**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances).     - `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  When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified.  | [optional] 
+**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances).  This field is required when `charge_merchant_fee` is `true`. Must be:   - A positive integer with up to two decimal places.   - Less than the refund amount  | [optional] 
 **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the transaction fee. This is only applicable if `charge_merchant_fee` is set to true.  | [optional] 
 
 

package/docs/CreateReportRequest.md

@@ -0,0 +1,13 @@
+# CoboWaas2.CreateReportRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_time** | **Number** | The start time of the report. Unix timestamp measured in seconds. | 
+**end_time** | **Number** | The end time of the report. Unix timestamp measured in seconds. | 
+**report_export_format** | [**ReportExportFormat**](ReportExportFormat.md) |  | 
+**report_types** | [**[ReportType]**](ReportType.md) |  | 
+**token_ids** | **[String]** | Optional filter to include only items related to specified token IDs in the report. | [optional] 
+
+

package/docs/CreateTopUpAddresses.md

@@ -0,0 +1,11 @@
+# CoboWaas2.CreateTopUpAddresses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchant_id** | **String** | The merchant ID. If not provided, the default merchant created during organization initialization will be used. | [optional] 
+**token_id** | **String** | The token ID, which identifies the cryptocurrency.  | 
+**custom_payer_ids** | **[String]** | A list of unique custom payer IDs required to create top-up addresses. The maximum number of items is 50.  | 
+
+

package/docs/CreateTopUpAddresses201Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.CreateTopUpAddresses201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[TopUpAddress]**](TopUpAddress.md) |  | [optional] 
+
+

package/docs/CreateWalletAddress.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **address** | **String** | The wallet address. | 
-**chain_id** | **String** | The chain ID of the cryptocurrency. | 
+**chain_id** | **String** | The chain ID of the address. | 
 
 

package/docs/DeleteCounterpartyById200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.DeleteCounterpartyById200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deleted_counterparty_id** | **String** | The deleted counterparty ID. | 
+
+

package/docs/DeleteCounterpartyEntry200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.DeleteCounterpartyEntry200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deleted_counterparty_entry_id** | **String** | The deleted counterparty entry ID. | 
+
+

package/docs/DeleteDestinationById200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.DeleteDestinationById200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deleted_destination_id** | **String** | The deleted destination ID. | 
+
+

package/docs/DeleteDestinationEntry200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.DeleteDestinationEntry200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deleted_destination_entry_id** | **String** | The deleted destination entry ID. | 
+
+

package/docs/EntryType.md

@@ -0,0 +1,12 @@
+# CoboWaas2.EntryType
+
+## Enum
+
+
+* `Address` (value: `"Address"`)
+
+* `BankAccount` (value: `"BankAccount"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+