@cobo/cobo-waas2 1.19.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/README.md +13 -1
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/PreRequestScript.js +1 -1
  4. package/dist/api/OAuthApi.js +4 -4
  5. package/dist/api/PaymentApi.js +144 -6
  6. package/dist/api/TransactionsApi.js +94 -2
  7. package/dist/index.js +49 -0
  8. package/dist/model/AddressesEventData.js +13 -3
  9. package/dist/model/BalanceUpdateInfoEventData.js +13 -3
  10. package/dist/model/ChainsEventData.js +13 -3
  11. package/dist/model/ContractCallDestination.js +1 -1
  12. package/dist/model/CreatePaymentOrderRequest.js +4 -4
  13. package/dist/model/CreateRefundRequest.js +3 -3
  14. package/dist/model/CreateSettlement.js +1 -1
  15. package/dist/model/CustodialWeb3TransferSource.js +2 -2
  16. package/dist/model/EstimateContractCallFeeParams.js +4 -6
  17. package/dist/model/EvmContractCallDestination.js +2 -2
  18. package/dist/model/FILBase.js +0 -1
  19. package/dist/model/ForcedSweep.js +193 -0
  20. package/dist/model/ForcedSweepRequest.js +156 -0
  21. package/dist/model/ForcedSweepStatus.js +66 -0
  22. package/dist/model/ListForcedSweepRequests200Response.js +123 -0
  23. package/dist/model/ListTransactionApprovalDetails200Response.js +107 -0
  24. package/dist/model/MPCVaultEventData.js +13 -3
  25. package/dist/model/MpcTransferSource.js +2 -2
  26. package/dist/model/Order.js +2 -2
  27. package/dist/model/PaymentAddressUpdateEventData.js +284 -0
  28. package/dist/model/PaymentOrderEventData.js +16 -6
  29. package/dist/model/PaymentRefundEventData.js +13 -3
  30. package/dist/model/PaymentSettlementEvent.js +13 -3
  31. package/dist/model/PaymentTransactionEventData.js +827 -0
  32. package/dist/model/SOLBase.js +0 -1
  33. package/dist/model/SafeWalletDelegates.js +1 -1
  34. package/dist/model/SafeWalletDelegatesContractCall.js +1 -1
  35. package/dist/model/SettlementInfo.js +26 -0
  36. package/dist/model/SuspendedTokenEventData.js +13 -3
  37. package/dist/model/TSSRequestWebhookEventData.js +13 -3
  38. package/dist/model/TokenListingEventData.js +13 -3
  39. package/dist/model/TokenizationContractCallParamsData.js +1 -1
  40. package/dist/model/TokenizationEvmContractCallParams.js +2 -2
  41. package/dist/model/TokensEventData.js +13 -3
  42. package/dist/model/TransactionDestination.js +1 -1
  43. package/dist/model/TransactionEvmContractDestination.js +2 -2
  44. package/dist/model/TransactionRbfSource.js +1 -1
  45. package/dist/model/TransactionWebhookEventData.js +13 -3
  46. package/dist/model/UpdateTopUpAddress.js +2 -2
  47. package/dist/model/WalletInfoEventData.js +13 -3
  48. package/dist/model/WebhookEventData.js +115 -23
  49. package/dist/model/WebhookEventDataType.js +12 -2
  50. package/dist/model/WebhookEventType.js +5 -0
  51. package/docs/AddressesEventData.md +5 -1
  52. package/docs/BalanceUpdateInfoEventData.md +5 -1
  53. package/docs/ChainsEventData.md +5 -1
  54. package/docs/ContractCallDestination.md +1 -1
  55. package/docs/CreatePaymentOrderRequest.md +2 -2
  56. package/docs/CreateRefundRequest.md +2 -2
  57. package/docs/CreateSettlement.md +1 -1
  58. package/docs/CustodialWeb3TransferSource.md +1 -1
  59. package/docs/EstimateContractCallFeeParams.md +1 -1
  60. package/docs/EstimateFeeParams.md +1 -1
  61. package/docs/EvmContractCallDestination.md +1 -1
  62. package/docs/ForcedSweep.md +16 -0
  63. package/docs/ForcedSweepRequest.md +12 -0
  64. package/docs/ForcedSweepStatus.md +14 -0
  65. package/docs/ListForcedSweepRequests200Response.md +10 -0
  66. package/docs/ListTransactionApprovalDetails200Response.md +9 -0
  67. package/docs/MPCVaultEventData.md +5 -1
  68. package/docs/MpcTransferSource.md +1 -1
  69. package/docs/OAuthApi.md +2 -2
  70. package/docs/Order.md +1 -1
  71. package/docs/PaymentAddressUpdateEventData.md +53 -0
  72. package/docs/PaymentApi.md +168 -3
  73. package/docs/PaymentOrderEventData.md +6 -2
  74. package/docs/PaymentRefundEventData.md +5 -1
  75. package/docs/PaymentSettlementEvent.md +5 -1
  76. package/docs/PaymentTransactionEventData.md +84 -0
  77. package/docs/SafeWalletDelegates.md +1 -1
  78. package/docs/SafeWalletDelegatesContractCall.md +1 -1
  79. package/docs/SettlementInfo.md +2 -0
  80. package/docs/SuspendedTokenEventData.md +5 -1
  81. package/docs/TSSRequestWebhookEventData.md +5 -1
  82. package/docs/TokenListingEventData.md +5 -1
  83. package/docs/TokenizationContractCallParamsData.md +1 -1
  84. package/docs/TokenizationEvmContractCallParams.md +1 -1
  85. package/docs/TokensEventData.md +5 -1
  86. package/docs/TransactionDestination.md +1 -1
  87. package/docs/TransactionEvmContractDestination.md +1 -1
  88. package/docs/TransactionRbfSource.md +1 -1
  89. package/docs/TransactionWebhookEventData.md +5 -1
  90. package/docs/TransactionsApi.md +107 -1
  91. package/docs/UpdateTopUpAddress.md +1 -1
  92. package/docs/WalletInfoEventData.md +5 -1
  93. package/docs/WebhookEventData.md +22 -12
  94. package/docs/WebhookEventDataType.md +5 -1
  95. package/docs/WebhookEventType.md +2 -0
  96. package/package.json +1 -1
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **type** | [**TokenizationContractCallType**](TokenizationContractCallType.md) | | [optional]
8
- **calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
8
+ **calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters. |
9
9
  **value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
10
10
 
11
11
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
7
+ **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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
8
8
  **tokens** | [**[TokenInfo]**](TokenInfo.md) | The enabled tokens. |
9
9
  **wallet_type** | [**WalletType**](WalletType.md) | | [optional]
10
10
  **wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | | [optional]
@@ -36,6 +36,10 @@ Name | Type | Description | Notes
36
36
 
37
37
  * `PaymentSettlement` (value: `"PaymentSettlement"`)
38
38
 
39
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
40
+
41
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
42
+
39
43
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
40
44
 
41
45
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
16
16
  **amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. |
17
17
  **address** | **String** | The destination address. |
18
18
  **value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
19
- **calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
19
+ **calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters. |
20
20
  **calldata_info** | [**TransactionEvmCalldataInfo**](TransactionEvmCalldataInfo.md) | | [optional]
21
21
  **instructions** | [**[TransactionSolContractInstruction]**](TransactionSolContractInstruction.md) | | [optional]
22
22
  **cosmos_messages** | [**[TransactionCosmosMessage]**](TransactionCosmosMessage.md) | |
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) | |
8
8
  **address** | **String** | The destination address. |
9
9
  **value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
10
- **calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
10
+ **calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters. |
11
11
  **calldata_info** | [**TransactionEvmCalldataInfo**](TransactionEvmCalldataInfo.md) | | [optional]
12
12
 
13
13
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **source_type** | [**WalletSubtype**](WalletSubtype.md) | |
8
8
  **wallet_id** | **String** | The wallet ID. |
9
- **address** | **String** | Indicates the wallet address to be used as the source of funds. - For UTXO-based chains: both `address` and `included_utxos` are optional. If both `address` and `included_utxos` are provided, the UTXOs must belong to the specified address. If neither `address` nor `included_utxos` is provided, the system will select UTXOs from the wallet associated with `wallet_id`. For RBF transactions, please note the following: - If the original transaction did not specify `included_utxos`, the RBF transaction may omit `address`, `included_utxos`, or both. - If the original transaction specified `included_utxos`, the RBF transaction must specify either `address` or `included_utxos`, or both. - The `address` or `included_utxos` in the RBF transaction may differ from those in the original transaction. - For account-based chains: You need to provide `address` otherwise the token transfer will fail. However, when estimating fees for a transfer, `address` is not required. | [optional]
9
+ **address** | **String** | Indicates the wallet address to be used as the source of funds. - For UTXO-based chains: both `address` and `included_utxos` are optional. If both `address` and `included_utxos` are provided, the UTXOs must belong to the specified address. If neither `address` nor `included_utxos` is provided, the system will select UTXOs from the wallet associated with `wallet_id`. - For account-based chains: You need to provide `address` otherwise the token transfer will fail. However, when estimating fees for a transfer, `address` is not required. For detailed rules on `address` and `included_utxos` in both regular and RBF transactions, see [Address and included_utxos usage](https://www.cobo.com/developers/v2/guides/transactions/sources-and-destinations#address-and-included-utxos-usage). | [optional]
10
10
  **included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
11
11
  **excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
12
12
  **mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) | | [optional]
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
7
+ **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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
8
8
  **transaction_id** | **String** | The transaction ID. |
9
9
  **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
10
10
  **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. | [optional]
@@ -64,6 +64,10 @@ Name | Type | Description | Notes
64
64
 
65
65
  * `PaymentSettlement` (value: `"PaymentSettlement"`)
66
66
 
67
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
68
+
69
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
70
+
67
71
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
68
72
 
69
73
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -12,7 +12,9 @@ Method | HTTP request | Description
12
12
  [**createTransferTransaction**](TransactionsApi.md#createTransferTransaction) | **POST** /transactions/transfer | Transfer token
13
13
  [**dropTransactionById**](TransactionsApi.md#dropTransactionById) | **POST** /transactions/{transaction_id}/drop | Drop transaction
14
14
  [**estimateFee**](TransactionsApi.md#estimateFee) | **POST** /transactions/estimate_fee | Estimate transaction fee
15
+ [**getTransactionApprovalDetail**](TransactionsApi.md#getTransactionApprovalDetail) | **GET** /transactions/{transaction_id}/approval_detail | Get transaction approval details
15
16
  [**getTransactionById**](TransactionsApi.md#getTransactionById) | **GET** /transactions/{transaction_id} | Get transaction information
17
+ [**listTransactionApprovalDetails**](TransactionsApi.md#listTransactionApprovalDetails) | **GET** /transactions/approval_details | List transaction approval details
16
18
  [**listTransactions**](TransactionsApi.md#listTransactions) | **GET** /transactions | List all transactions
17
19
  [**resendTransactionById**](TransactionsApi.md#resendTransactionById) | **POST** /transactions/{transaction_id}/resend | Resend transaction
18
20
  [**signAndBroadcastTransactionById**](TransactionsApi.md#signAndBroadcastTransactionById) | **POST** /transactions/{transaction_id}/sign_and_broadcast | Sign and broadcast transaction
@@ -182,7 +184,7 @@ Name | Type | Description | Notes
182
184
 
183
185
  Call smart contract
184
186
 
185
- This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to the transactions from MPC Wallets or Smart Contract Wallets on the blockchains that have a similar architecture to Ethereum.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
187
+ This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to the transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets on the blockchains that have a similar architecture to Ethereum.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
186
188
 
187
189
  ### Example
188
190
 
@@ -438,6 +440,56 @@ Name | Type | Description | Notes
438
440
  - **Accept**: application/json
439
441
 
440
442
 
443
+ ## getTransactionApprovalDetail
444
+
445
+ > TransactionApprovalDetail getTransactionApprovalDetail(transaction_id)
446
+
447
+ Get transaction approval details
448
+
449
+ This operation retrieves detailed approval information about a specified transaction.
450
+
451
+ ### Example
452
+
453
+ ```javascript
454
+ const CoboWaas2 = require('@cobo/cobo-waas2');
455
+ // Initialize the API client
456
+ const apiClient = CoboWaas2.ApiClient.instance
457
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
458
+ apiClient.setEnv(CoboWaas2.Env.DEV);
459
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
460
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
461
+ // Call the API
462
+ const apiInstance = new CoboWaas2.TransactionsApi();
463
+ const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
464
+ apiInstance.getTransactionApprovalDetail(transaction_id).then((data) => {
465
+ console.log('API called successfully. Returned data: ' + data);
466
+ }, (error) => {
467
+ console.error(error);
468
+ });
469
+
470
+ ```
471
+
472
+ ### Parameters
473
+
474
+
475
+ Name | Type | Description | Notes
476
+ ------------- | ------------- | ------------- | -------------
477
+ **transaction_id** | **String**| The transaction ID. |
478
+
479
+ ### Return type
480
+
481
+ [**TransactionApprovalDetail**](TransactionApprovalDetail.md)
482
+
483
+ ### Authorization
484
+
485
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
486
+
487
+ ### HTTP request headers
488
+
489
+ - **Content-Type**: Not defined
490
+ - **Accept**: application/json
491
+
492
+
441
493
  ## getTransactionById
442
494
 
443
495
  > TransactionDetail getTransactionById(transaction_id)
@@ -488,6 +540,60 @@ Name | Type | Description | Notes
488
540
  - **Accept**: application/json
489
541
 
490
542
 
543
+ ## listTransactionApprovalDetails
544
+
545
+ > ListTransactionApprovalDetails200Response listTransactionApprovalDetails(opts)
546
+
547
+ List transaction approval details
548
+
549
+ This operation retrieves detailed approval information for all transactions.
550
+
551
+ ### Example
552
+
553
+ ```javascript
554
+ const CoboWaas2 = require('@cobo/cobo-waas2');
555
+ // Initialize the API client
556
+ const apiClient = CoboWaas2.ApiClient.instance
557
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
558
+ apiClient.setEnv(CoboWaas2.Env.DEV);
559
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
560
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
561
+ // Call the API
562
+ const apiInstance = new CoboWaas2.TransactionsApi();
563
+ const opts = {
564
+ 'transaction_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,557918d2-632a-4fe1-932f-315711f05fe3",
565
+ 'cobo_ids': "20231213122855000000000000000000,20231213122955000000000000000000"
566
+ };
567
+ apiInstance.listTransactionApprovalDetails(opts).then((data) => {
568
+ console.log('API called successfully. Returned data: ' + data);
569
+ }, (error) => {
570
+ console.error(error);
571
+ });
572
+
573
+ ```
574
+
575
+ ### Parameters
576
+
577
+
578
+ Name | Type | Description | Notes
579
+ ------------- | ------------- | ------------- | -------------
580
+ **transaction_ids** | **String**| A list of transaction IDs, separated by comma. | [optional]
581
+ **cobo_ids** | **String**| A list of Cobo IDs, separated by comma. A Cobo ID can be used to track a transaction. | [optional]
582
+
583
+ ### Return type
584
+
585
+ [**ListTransactionApprovalDetails200Response**](ListTransactionApprovalDetails200Response.md)
586
+
587
+ ### Authorization
588
+
589
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
590
+
591
+ ### HTTP request headers
592
+
593
+ - **Content-Type**: Not defined
594
+ - **Accept**: application/json
595
+
596
+
491
597
  ## listTransactions
492
598
 
493
599
  > ListTransactions200Response listTransactions(opts)
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **merchant_id** | **String** | The merchant ID. |
8
- **token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format &#x60;{CHAIN}_{TOKEN}&#x60;. Supported values include: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#x60;, &#x60;BSC_USDC&#x60; - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60; |
8
+ **token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format &#x60;{CHAIN}_{TOKEN}&#x60;. Supported values include: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60; - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60; |
9
9
  **custom_payer_id** | **String** | Unique customer identifier on the merchant side, used to allocate a dedicated top-up address |
10
10
 
11
11
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The payment address update event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. |
8
8
  **wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
9
9
 
10
10
 
@@ -34,6 +34,10 @@ Name | Type | Description | Notes
34
34
 
35
35
  * `PaymentSettlement` (value: `"PaymentSettlement"`)
36
36
 
37
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
38
+
39
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
40
+
37
41
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
38
42
 
39
43
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -4,23 +4,23 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The payment address update event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. |
8
8
  **transaction_id** | **String** | The transaction ID. |
9
9
  **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
10
- **request_id** | **String** | The request ID provided by you when creating the settlement request. |
10
+ **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. |
11
11
  **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. |
12
- **type** | [**MPCVaultType**](MPCVaultType.md) | | [optional]
13
- **status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
12
+ **type** | [**TransactionType**](TransactionType.md) | | [optional]
13
+ **status** | [**TransactionStatus**](TransactionStatus.md) | |
14
14
  **sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
15
15
  **failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
16
- **chain_id** | **String** | The ID of the blockchain network on which the refund transaction occurs. |
17
- **token_id** | **String** | The ID of the cryptocurrency used for refund. |
16
+ **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). |
17
+ **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). |
18
18
  **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]
19
- **source** | [**TokenListingRequestSource**](TokenListingRequestSource.md) | |
19
+ **source** | [**TransactionSource**](TransactionSource.md) | |
20
20
  **destination** | [**TransactionDestination**](TransactionDestination.md) | |
21
21
  **result** | [**TransactionResult**](TransactionResult.md) | | [optional]
22
22
  **fee** | [**TransactionFee**](TransactionFee.md) | | [optional]
23
- **initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payment Management App&#39;s ID. - Format &#x60;api_key_&lt;API_KEY&gt;&#x60;: Indicates the settlement request was initiated via the Payment API using the API key. - Format &#x60;app_&lt;APP_ID&gt;&#x60;: Indicates the settlement request was initiated through the Payment Management App using the App ID. | [optional]
23
+ **initiator** | **String** | The transaction initiator. | [optional]
24
24
  **initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | |
25
25
  **confirmed_num** | **Number** | The number of confirmations this transaction has received. | [optional]
26
26
  **confirming_threshold** | **Number** | The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. | [optional]
@@ -29,13 +29,13 @@ Name | Type | Description | Notes
29
29
  **raw_tx_info** | [**TransactionRawTxInfo**](TransactionRawTxInfo.md) | | [optional]
30
30
  **replacement** | [**TransactionReplacement**](TransactionReplacement.md) | | [optional]
31
31
  **category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
32
- **description** | **String** | The description of the TSS request. | [optional]
32
+ **description** | **String** | The description for your transaction. | [optional]
33
33
  **is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - &#x60;true&#x60;: The transaction was executed as a Cobo Loop transfer. - &#x60;false&#x60;: The transaction was not executed as a Cobo Loop transfer. | [optional]
34
34
  **cobo_category** | **[String]** | The transaction category defined by Cobo. Possible values include: - &#x60;AutoSweep&#x60;: An auto-sweep transaction. - &#x60;AutoFueling&#x60;: A transaction where Fee Station pays transaction fees to an address within your wallet. - &#x60;AutoFuelingRefund&#x60;: A refund for an auto-fueling transaction. - &#x60;SafeTxMessage&#x60;: A message signing transaction to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - &#x60;BillPayment&#x60;: A transaction to pay Cobo bills through Fee Station. - &#x60;BillRefund&#x60;: A refund for a previously made bill payment. - &#x60;CommissionFeeCharge&#x60;: A transaction to charge commission fees via Fee Station. - &#x60;CommissionFeeRefund&#x60;: A refund of previously charged commission fees. | [optional]
35
35
  **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 &#x60;extra_type&#x60; field in the JSON object (for example, \&quot;BabylonBusinessInfo\&quot;, \&quot;BtcAddressInfo\&quot;). | [optional]
36
36
  **fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
37
- **created_timestamp** | **Number** | The creation time of the settlement request, represented as a UNIX timestamp in seconds. |
38
- **updated_timestamp** | **Number** | The last update time of the settlement request, represented as a UNIX timestamp in seconds. |
37
+ **created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. |
38
+ **updated_timestamp** | **Number** | The time when the transaction was updated, in Unix timestamp format, measured in milliseconds. |
39
39
  **tss_request_id** | **String** | The TSS request ID. | [optional]
40
40
  **source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
41
41
  **target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
58
58
  **balance** | [**Balance**](Balance.md) | |
59
59
  **token_ids** | **String** | A list of token IDs, separated by comma. |
60
60
  **operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
61
- **order_id** | **String** | The ID of the pay-in order corresponding to this refund. |
61
+ **order_id** | **String** | Unique identifier of a single order |
62
62
  **merchant_id** | **String** | The merchant ID. | [optional]
63
63
  **payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
64
64
  **receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
@@ -81,6 +81,12 @@ Name | Type | Description | Notes
81
81
  **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if &#x60;charge_merchant_fee&#x60; is set to true. | [optional]
82
82
  **settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
83
83
  **settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
84
+ **acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
85
+ **payer_id** | **String** | Unique payer identifier on the Cobo side, auto-generated by the system. |
86
+ **custom_payer_id** | **String** | Unique user identifier on the merchant side, used to assign a dedicated deposit address. |
87
+ **chain** | **String** | Blockchain network identifier, e.g., &#39;ETH&#39; for Ethereum, &#39;TRON&#39; for Tron. |
88
+ **previous_address** | **String** | The previous deposit address that was assigned before update. |
89
+ **updated_address** | **String** | The new updated deposit address assigned to the user. |
84
90
 
85
91
 
86
92
 
@@ -109,6 +115,10 @@ Name | Type | Description | Notes
109
115
 
110
116
  * `PaymentSettlement` (value: `"PaymentSettlement"`)
111
117
 
118
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
119
+
120
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
121
+
112
122
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
113
123
 
114
124
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The payment address update event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. |
8
8
 
9
9
 
10
10
 
@@ -33,6 +33,10 @@ Name | Type | Description | Notes
33
33
 
34
34
  * `PaymentSettlement` (value: `"PaymentSettlement"`)
35
35
 
36
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
37
+
38
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
39
+
36
40
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
37
41
 
38
42
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -67,6 +67,8 @@
67
67
 
68
68
  * `payment.settlement.status.updated` (value: `"payment.settlement.status.updated"`)
69
69
 
70
+ * `payment.address.updated` (value: `"payment.address.updated"`)
71
+
70
72
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
71
73
 
72
74
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cobo/cobo-waas2",
3
- "version": "1.19.0",
3
+ "version": "1.20.0",
4
4
  "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). ",
5
5
  "license": "GPL 2.0",
6
6
  "main": "dist/index.js",