@cobo/cobo-waas2 1.36.0 → 1.38.0

package/docs/WebhookEventData.md

@@ -4,17 +4,17 @@
 
 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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. | 
 **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional] 
 **request_id** | **String** | The request ID. | 
 **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** | [**KyaScreeningStatus**](KyaScreeningStatus.md) |  | 
+**status** | **String** | The status of the fiat transaction. Possible values include:   - `Created`: The transaction has been created.   - `Succeeded`: The transaction has been completed successfully.  | 
 **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 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). | 
+**token_id** | **String** | The token ID of the balance change. | 
 **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) |  | 
@@ -31,10 +31,10 @@ Name | Type | Description | Notes
 **category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional] 
 **description** | **String** | The description for the entire bulk send batch. | [optional] 
 **is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer.  | [optional] 
-**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] 
+**cobo_category** | **[String]** | The Cobo category of the transaction. | [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 time when the screening request was created, in Unix timestamp format, measured in milliseconds. | 
+**created_timestamp** | **Number** | The time when the transaction 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] 
@@ -43,7 +43,7 @@ Name | Type | Description | Notes
 **wallet** | [**WalletInfo**](WalletInfo.md) |  | [optional] 
 **vault_id** | **String** | The vault ID. | [optional] 
 **project_id** | **String** | The project ID. | [optional] 
-**name** | **String** | The vault name. | [optional] 
+**name** | **String** | The organization name. | [optional] 
 **root_pubkeys** | [**[RootPubkey]**](RootPubkey.md) |  | [optional] 
 **chains** | [**[ChainInfo]**](ChainInfo.md) | The enabled chains. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
@@ -77,13 +77,13 @@ Name | Type | Description | Notes
 **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. | 
+**amount** | **String** | The transaction amount. | 
 **to_address** | **String** | The recipient's wallet address where the refund will be sent. | 
 **refund_type** | [**RefundType**](RefundType.md) |  | [optional] 
 **charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund.    - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance    - `false`: The merchant is not charged any developer fee.  | [optional] 
 **merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional] 
 **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional] 
-**commission_fee** | [**CommissionFee**](CommissionFee.md) |  | [optional] 
+**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] 
 **settlement_request_id** | **String** | The settlement request ID generated by Cobo. | 
 **settlements** | [**[SettlementDetail]**](SettlementDetail.md) |  | 
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | 
@@ -93,26 +93,41 @@ Name | Type | Description | Notes
 **bank_account** | [**BankAccount**](BankAccount.md) |  | [optional] 
 **payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. | 
 **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. | 
+**subscription_id** | **String** | A unique identifier assigned by Cobo to track and identify subscription. | [optional] 
+**action_id** | **String** | A unique identifier assigned by Cobo to track and identify subscription action. | [optional] 
 **chain** | **String** | The chain ID. | 
 **previous_address** | **String** | The previous top-up address that was assigned to the payer. | 
 **updated_address** | **String** | The new top-up address that has been assigned to the payer. | 
 **payout_id** | **String** | The payout ID generated by Cobo. | 
-**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\"`.  | 
+**source_account** | **String** | The source account of the balance change. This field uses the same semantics as `source_account` in [List balance changes](https://www.cobo.com/developers/v2/api-references/payment/list-balance-changes). - When the account is a merchant account, this is the merchant ID (merchant code), which you can retrieve by calling [List all merchants](https://www.cobo.com/developers/v2/api-references/payment/list-all-merchants). - When the account is the developer account, use `developer`.  | 
 **payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional] 
 **recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) |  | [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] 
 **bulk_send_id** | **String** | The bulk send ID. | 
 **execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) |  | 
+**source_id** | **String** | The source ID of the balance change. | 
+**source_type** | [**PaymentBalanceChangeSourceType**](PaymentBalanceChangeSourceType.md) |  | 
+**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) |  | 
+**update_time** | **Number** | The time when the balance was updated, represented as a UNIX timestamp in seconds. | 
 **disposition_type** | [**DispositionType**](DispositionType.md) |  | 
 **disposition_status** | [**DispositionStatus**](DispositionStatus.md) |  | 
 **destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional] 
 **disposition_amount** | **String** | The amount to be refunded/isolated from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction.  | [optional] 
-**transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) |  | 
+**transaction_type** | [**FeeStationFiatTransactionType**](FeeStationFiatTransactionType.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). | 
+**org_id** | **String** | The organization ID. | [optional] 
+**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] 
+**fiat_currency** | **String** | The fiat currency of the transaction. Possible values include:   - `USD`: US Dollar.  | 
+**modified_timestamp** | **Number** | The time when the transaction was last modified, in Unix timestamp format, measured in milliseconds. | [optional] 
 
 
 
@@ -149,6 +164,8 @@ Name | Type | Description | Notes
 
 * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
 
+* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -159,6 +176,23 @@ Name | Type | Description | Notes
 
 * `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/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. - `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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. | 
 
 
 
@@ -41,6 +41,8 @@ Name | Type | Description | Notes
 
 * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
 
+* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
+
 * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
 
 * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -51,6 +53,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/WebhookEventType.md

@@ -23,12 +23,20 @@
 
 * `wallets.created` (value: `"wallets.created"`)
 
+* `wallets.updated` (value: `"wallets.updated"`)
+
 * `wallets.token_listing.failed` (value: `"wallets.token_listing.failed"`)
 
 * `wallets.token_listing.succeeded` (value: `"wallets.token_listing.succeeded"`)
 
 * `mpc_vaults.created` (value: `"mpc_vaults.created"`)
 
+* `mpc_vaults.updated` (value: `"mpc_vaults.updated"`)
+
+* `mpc_vaults.deleted` (value: `"mpc_vaults.deleted"`)
+
+* `organizations.updated` (value: `"organizations.updated"`)
+
 * `fee_station.transaction.created` (value: `"fee_station.transaction.created"`)
 
 * `fee_station.transaction.updated` (value: `"fee_station.transaction.updated"`)
@@ -65,6 +73,8 @@
 
 * `payment.transaction.failed` (value: `"payment.transaction.failed"`)
 
+* `payment.account.balance.updated` (value: `"payment.account.balance.updated"`)
+
 * `payment.status.updated` (value: `"payment.status.updated"`)
 
 * `payment.order.status.updated` (value: `"payment.order.status.updated"`)

package/package.json

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