@cobo/cobo-waas2 1.28.0 → 1.29.0

package/docs/UpdateDestinationRequest.md

@@ -0,0 +1,14 @@
+# CoboWaas2.UpdateDestinationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**updated_destination_name** | **String** | The updated destination name. | 
+**updated_destination_type** | [**DestinationType**](DestinationType.md) |  | 
+**updated_merchant_id** | **String** | The updated ID of the merchant linked to the destination. | [optional] 
+**updated_country** | **String** | The updated country of the destination, in ISO 3166-1 alpha-3 format. | [optional] 
+**updated_email** | **String** | The updated email of the destination. | [optional] 
+**updated_contact_address** | **String** | The updated contact address of the destination. | [optional] 
+
+

package/docs/UpdateMerchantByIdRequest.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The merchant name. | [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] 
 
 

package/docs/WalletAddress.md

@@ -6,7 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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. | 
+**risk_level** | [**AddressRiskLevel**](AddressRiskLevel.md) |  | [optional] 
+**screening_timestamp** | **Number** | UNIX timestamp (in seconds) when the address was last screened for compliance. | [optional] 
 **updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. | 
 
 

package/docs/WalletInfoEventData.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. - `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. | 
 **wallet** | [**WalletInfo**](WalletInfo.md) |  | [optional] 
 
 
@@ -48,6 +48,8 @@ Name | Type | Description | Notes
 
 * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
 
+* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/WebhookEventData.md

@@ -4,23 +4,23 @@
 
 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. - `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. | 
 **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional] 
 **request_id** | **String** | The request ID provided by you when creating the payout. | 
 **wallet_id** | **String** | For deposit transactions, this property represents the wallet ID of the transaction destination. For transactions of other types, this property represents the wallet ID of the transaction source. | 
 **type** | [**TransactionType**](TransactionType.md) |  | [optional] 
-**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) |  | 
+**status** | [**KyaScreeningStatus**](KyaScreeningStatus.md) |  | 
 **sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) |  | [optional] 
 **failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional] 
-**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). | 
+**chain_id** | **String** | The chain identifier. | 
 **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). | 
 **asset_id** | **String** | (This concept applies to Exchange Wallets only) The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional] 
 **source** | [**TransactionSource**](TransactionSource.md) |  | 
 **destination** | [**TransactionDestination**](TransactionDestination.md) |  | 
 **result** | [**TransactionResult**](TransactionResult.md) |  | [optional] 
 **fee** | [**TransactionFee**](TransactionFee.md) |  | [optional] 
-**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional] 
+**initiator** | **String** | The initiator of this payout, usually the API key used to create the payout. | [optional] 
 **initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) |  | 
 **confirmed_num** | **Number** | The number of confirmations this transaction has received. | [optional] 
 **confirming_threshold** | **Number** | The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. | [optional] 
@@ -34,8 +34,8 @@ Name | Type | Description | Notes
 **cobo_category** | **[String]** | The transaction category defined by Cobo. For more details, refer to [Cobo-defined categories](/v2/guides/transactions/manage-transactions#cobo-defined-categories).  | [optional] 
 **extra** | **[String]** | A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\").  | [optional] 
 **fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) |  | [optional] 
-**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | 
-**updated_timestamp** | **Number** | The time when the KYT screening information was updated, in Unix timestamp format, measured in milliseconds. | 
+**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. | 
 **tss_request_id** | **String** | The TSS request ID. | [optional] 
 **source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) |  | [optional] 
 **target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional] 
@@ -53,7 +53,7 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **token** | [**TokenInfo**](TokenInfo.md) |  | [optional] 
 **feedback** | **String** | The feedback provided by Cobo when a token listing request is rejected. | [optional] 
-**address** | **String** | The wallet address. | 
+**address** | **String** | The screened blockchain address. | 
 **wallet_uuid** | **String** | The wallet ID. | 
 **balance** | [**Balance**](Balance.md) |  | 
 **token_ids** | **String** | A list of token IDs, separated by comma. | 
@@ -62,19 +62,19 @@ Name | Type | Description | Notes
 **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] 
 **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | 
-**pricing_currency** | **String** | The fiat currency of the order. | [optional] 
-**pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [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. | 
+**pricing_currency** | **String** | The pricing currency of the order. | [optional] 
+**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). | [optional] 
+**fee_amount** | **String** | The developer fee for the order. It is added to the base amount to determine the final charge. | 
 **payable_currency** | **String** | The ID of the cryptocurrency used for payment. | [optional] 
 **payable_amount** | **String** | The cryptocurrency amount to be paid for this order. | 
-**exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. | 
-**amount_tolerance** | **String** | Allowed amount deviation. | [optional] 
+**exchange_rate** | **String** | The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`.    <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note>  | 
+**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] 
 **receive_address** | **String** | The recipient wallet address to be used for the payment transaction. | 
 **received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). | 
 **expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional] 
 **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional] 
-**currency** | **String** | The fiat currency for the payout. | [optional] 
-**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional] 
+**currency** | **String** | The fiat currency you will receive from the payout. | [optional] 
+**order_amount** | **String** | This field has been deprecated. Please use `pricing_amount` instead. | [optional] 
 **settlement_status** | [**SettleStatus**](SettleStatus.md) |  | [optional] 
 **refund_id** | **String** | The refund order ID. | 
 **amount** | **String** | The amount in cryptocurrency to be returned for this refund order. | 
@@ -98,7 +98,7 @@ Name | Type | Description | Notes
 **updated_address** | **String** | The new top-up address that has been assigned to the payer. | 
 **payout_id** | **String** | The payout ID generated by Cobo. | 
 **payout_item_details** | [**[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) |  | [optional] 
-**actual_payout_amount** | **String** | The actual amount of this payout.  | [optional] 
+**actual_payout_amount** | **String** | The total amount of cryptocurrency actually paid out for this payout.  | [optional] 
 **disposition_type** | [**DispositionType**](DispositionType.md) |  | 
 **disposition_status** | [**DispositionStatus**](DispositionStatus.md) |  | 
 **destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional] 
@@ -106,6 +106,7 @@ Name | Type | Description | Notes
 **transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) |  | 
 **review_status** | [**ReviewStatusType**](ReviewStatusType.md) |  | 
 **funds_status** | [**FundsStatusType**](FundsStatusType.md) |  | 
+**screening_id** | **String** | The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). | 
 
 
 
@@ -148,6 +149,8 @@ Name | Type | Description | Notes
 
 * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
 
+* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/WebhookEventDataType.md

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

package/docs/WebhookEventType.md

@@ -79,6 +79,8 @@
 
 * `compliance.kyt.screenings.status.updated` (value: `"compliance.kyt.screenings.status.updated"`)
 
+* `compliance.kya.screenings.status.updated` (value: `"compliance.kya.screenings.status.updated"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/package.json

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