@cobo/cobo-waas2 1.22.0 → 1.24.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.
- package/README.md +81 -17
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +200 -21
- package/dist/api/AutoSweepApi.js +26 -26
- package/dist/api/ComplianceApi.js +214 -0
- package/dist/api/FeeStationApi.js +47 -4
- package/dist/api/PaymentApi.js +204 -57
- package/dist/api/SwapsApi.js +374 -0
- package/dist/api/TokenizationApi.js +2 -2
- package/dist/api/TransactionsApi.js +18 -18
- package/dist/api/WalletsApi.js +4 -4
- package/dist/api/WalletsMPCWalletsApi.js +2 -2
- package/dist/index.js +329 -21
- package/dist/model/AddressBook.js +12 -12
- package/dist/model/AddressInfo.js +13 -0
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/AddressesEventDataAllOfAddresses.js +18 -0
- package/dist/model/ApprovalDetail.js +4 -4
- package/dist/model/ApprovalResult.js +6 -11
- package/dist/model/ApprovalTemplate.js +4 -4
- package/dist/model/ApprovalTransactionResult.js +8 -8
- package/dist/model/ApprovalUserDetail.js +95 -24
- package/dist/model/AutoSweepTask.js +9 -9
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/BridgingFee.js +136 -0
- package/dist/model/ChainInfo.js +14 -1
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/CommissionFee.js +110 -0
- package/dist/model/ComplianceDispositionUpdateEventData.js +321 -0
- package/dist/model/ContractCallDestination.js +48 -8
- package/dist/model/ContractCallDestinationType.js +5 -0
- package/dist/model/CreateAddressBookParam.js +165 -0
- package/dist/model/CreateAddressBooks201Response.js +107 -0
- package/dist/model/CreateAddressBooksParam.js +128 -0
- package/dist/model/CreateAutoSweepTask.js +5 -5
- package/dist/model/CreateCustodialWalletParams.js +1 -1
- package/dist/model/CreateExchangeWalletParams.js +2 -2
- package/dist/model/CreateMerchantRequest.js +14 -7
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreatePaymentOrderRequest.js +17 -4
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateSafeWalletParams.js +1 -1
- package/dist/model/CreateSettlement.js +3 -3
- package/dist/model/CreateSettlementRequestRequest.js +39 -0
- package/dist/model/CreateSmartContractWalletParams.js +1 -1
- package/dist/model/CreateSwapActivityRequest.js +193 -0
- package/dist/model/CreateSweepToAddress.js +1 -1
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/CustodialTransferDestination.js +1 -1
- package/dist/model/DeleteAddressBookById201Response.js +106 -0
- package/dist/model/DispositionEventData.js +170 -0
- package/dist/model/DispositionQueryResponse.js +146 -0
- package/dist/model/DispositionResponse.js +122 -0
- package/dist/model/DispositionStatus.js +116 -0
- package/dist/model/DispositionType.js +66 -0
- package/dist/model/EstimateContractCallFeeParams.js +1 -1
- package/dist/model/EstimateFeeParams.js +1 -1
- package/dist/model/EstimateTransferFeeParams.js +1 -1
- package/dist/model/EstimatedEvmEip1559Fee.js +1 -1
- package/dist/model/EstimatedEvmLegacyFee.js +1 -1
- package/dist/model/EstimatedFILFee.js +1 -1
- package/dist/model/EstimatedFixedFee.js +1 -1
- package/dist/model/EstimatedSOLFee.js +1 -1
- package/dist/model/EstimatedUtxoFee.js +1 -1
- package/dist/model/FeeStationCheckFeeStationUsage.js +186 -0
- package/dist/model/FeeStationCheckFeeStationUsageResponse.js +200 -0
- package/dist/model/FeeStationGasStationType.js +61 -0
- package/dist/model/IsolateDisposition.js +167 -0
- package/dist/model/ListSwapActivities200Response.js +123 -0
- package/dist/model/ListSwapEnabledTokens200Response.js +123 -0
- package/dist/model/ListTopUpPayerAccounts200Response.js +123 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/Merchant.js +10 -1
- package/dist/model/MerchantBalance.js +7 -7
- package/dist/model/MessageSignDestination.js +8 -70
- package/dist/model/OrgInfo.js +9 -0
- package/dist/model/OtcFee.js +123 -0
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentEstimateFee.js +125 -0
- package/dist/model/PaymentEstimateFee201Response.js +107 -0
- package/dist/model/{RawMessageSignDestination.js → PaymentEstimateFeeRequest.js} +51 -37
- package/dist/model/PaymentEstimatedFee.js +173 -0
- package/dist/model/PaymentFeeType.js +71 -0
- package/dist/model/PaymentOrderEventData.js +8 -3
- package/dist/model/PaymentRefundEventData.js +30 -5
- package/dist/model/PaymentSettlementEvent.js +70 -9
- package/dist/model/PaymentTransactionEventData.js +8 -3
- package/dist/model/PaymentWalletBalance.js +6 -6
- package/dist/model/PspBalance.js +7 -7
- package/dist/model/ReceivedAmountPerAddress.js +5 -5
- package/dist/model/Refund.js +17 -1
- package/dist/model/RefundDisposition.js +167 -0
- package/dist/model/RoleDetail.js +41 -6
- package/dist/model/SettleRequestStatus.js +5 -0
- package/dist/model/Settlement.js +45 -3
- package/dist/model/SettlementDetail.js +33 -1
- package/dist/model/SettlementInfo.js +7 -7
- package/dist/model/SolContractCallAddressLookupTableAccount.js +126 -0
- package/dist/model/SolContractCallDestination.js +30 -0
- package/dist/model/StellarContractCallContractParam.js +164 -0
- package/dist/model/StellarContractCallContractType.js +56 -0
- package/dist/model/StellarContractCallDestination.js +125 -0
- package/dist/model/StellarContractCallTrustLineOperationType.js +56 -0
- package/dist/model/StellarContractCallTrustLineParam.js +133 -0
- package/dist/model/SupportedToken.js +9 -0
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/SwapActivity.js +9 -9
- package/dist/model/SwapActivityApprovers.js +1 -1
- package/dist/model/SwapActivityDetail.js +34 -18
- package/dist/model/SwapActivitySigners.js +2 -2
- package/dist/model/SwapActivityTimeline.js +5 -5
- package/dist/model/SwapEstimateFee.js +147 -0
- package/dist/model/SwapQuote.js +18 -31
- package/dist/model/SwapReceivingTransaction.js +133 -0
- package/dist/model/SwapToken.js +9 -9
- package/dist/model/SweepToAddress.js +1 -1
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TransactionCoboCategory.js +5 -0
- package/dist/model/TransactionDestination.js +48 -8
- package/dist/model/TransactionDestinationType.js +5 -0
- package/dist/model/TransactionEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionEvmLegacyFee.js +1 -1
- package/dist/model/TransactionFILFee.js +1 -1
- package/dist/model/TransactionFixedFee.js +1 -1
- package/dist/model/TransactionFuelingInfo.js +13 -0
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFILFee.js +1 -1
- package/dist/model/TransactionRequestSOLFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionSOLFee.js +1 -1
- package/dist/model/TransactionSolContractAddressLookupTableAccount.js +126 -0
- package/dist/model/TransactionSolContractDestination.js +30 -0
- package/dist/model/TransactionStellarContractParam.js +164 -0
- package/dist/model/TransactionStellarContractType.js +56 -0
- package/dist/model/{BTCEIP191MessageSignDestination.js → TransactionStellarDestination.js} +38 -35
- package/dist/model/TransactionStellarTrustLineOperationType.js +56 -0
- package/dist/model/TransactionStellarTrustLineParam.js +133 -0
- package/dist/model/TransactionUtxoFee.js +1 -1
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/UnfreezeDisposition.js +111 -0
- package/dist/model/UpdateAddressBookParam.js +150 -0
- package/dist/model/UpdateBankAccountByIdRequest.js +108 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/UpdateTopUpAddress.js +4 -6
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WalletSetup.js +66 -0
- package/dist/model/WebhookEventData.js +81 -11
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +5 -0
- package/docs/AddressBook.md +7 -7
- package/docs/AddressBooksApi.md +218 -8
- package/docs/AddressInfo.md +1 -0
- package/docs/AddressesEventData.md +3 -1
- package/docs/AddressesEventDataAllOfAddresses.md +1 -0
- package/docs/ApprovalDetail.md +3 -3
- package/docs/ApprovalResult.md +3 -5
- package/docs/ApprovalTemplate.md +3 -3
- package/docs/ApprovalTransactionResult.md +4 -4
- package/docs/ApprovalUserDetail.md +15 -9
- package/docs/AutoSweepApi.md +18 -18
- package/docs/AutoSweepTask.md +5 -5
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/BridgingFee.md +11 -0
- package/docs/ChainInfo.md +2 -1
- package/docs/ChainsEventData.md +3 -1
- package/docs/CommissionFee.md +9 -0
- package/docs/ComplianceApi.md +218 -0
- package/docs/ComplianceDispositionUpdateEventData.md +56 -0
- package/docs/ContractCallDestination.md +2 -0
- package/docs/ContractCallDestinationType.md +2 -0
- package/docs/CreateAddressBookParam.md +13 -0
- package/docs/CreateAddressBooks201Response.md +9 -0
- package/docs/CreateAddressBooksParam.md +9 -0
- package/docs/CreateAutoSweepTask.md +2 -2
- package/docs/CreateCustodialWalletParams.md +1 -1
- package/docs/CreateExchangeWalletParams.md +1 -1
- package/docs/CreateMerchantRequest.md +3 -2
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +4 -3
- package/docs/CreateRefundRequest.md +1 -1
- package/docs/CreateSafeWalletParams.md +1 -1
- package/docs/CreateSettlement.md +3 -3
- package/docs/CreateSettlementRequestRequest.md +3 -0
- package/docs/CreateSmartContractWalletParams.md +1 -1
- package/docs/CreateSwapActivityRequest.md +15 -0
- package/docs/CreateWalletParams.md +1 -1
- package/docs/DeleteAddressBookById201Response.md +9 -0
- package/docs/DispositionEventData.md +14 -0
- package/docs/DispositionQueryResponse.md +12 -0
- package/docs/DispositionResponse.md +10 -0
- package/docs/DispositionStatus.md +34 -0
- package/docs/DispositionType.md +14 -0
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +1 -1
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/FeeStationApi.md +53 -0
- package/docs/FeeStationCheckFeeStationUsage.md +14 -0
- package/docs/FeeStationCheckFeeStationUsageResponse.md +16 -0
- package/docs/FeeStationGasStationType.md +12 -0
- package/docs/IsolateDisposition.md +13 -0
- package/docs/ListSwapActivities200Response.md +10 -0
- package/docs/ListSwapEnabledTokens200Response.md +10 -0
- package/docs/ListTopUpPayerAccounts200Response.md +10 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/Merchant.md +2 -1
- package/docs/MerchantBalance.md +6 -6
- package/docs/MessageSignDestination.md +0 -1
- package/docs/OrgInfo.md +1 -0
- package/docs/OtcFee.md +10 -0
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentApi.md +203 -28
- package/docs/PaymentEstimateFee.md +10 -0
- package/docs/PaymentEstimateFee201Response.md +9 -0
- package/docs/PaymentEstimateFeeRequest.md +10 -0
- package/docs/PaymentEstimatedFee.md +13 -0
- package/docs/PaymentFeeType.md +16 -0
- package/docs/PaymentOrderEventData.md +3 -1
- package/docs/PaymentRefundEventData.md +5 -2
- package/docs/PaymentSettlementEvent.md +9 -4
- package/docs/PaymentTransactionEventData.md +3 -1
- package/docs/PaymentWalletBalance.md +5 -5
- package/docs/PspBalance.md +6 -6
- package/docs/ReceivedAmountPerAddress.md +2 -2
- package/docs/Refund.md +2 -1
- package/docs/RefundDisposition.md +13 -0
- package/docs/RoleDetail.md +4 -1
- package/docs/SettleRequestStatus.md +2 -0
- package/docs/Settlement.md +6 -3
- package/docs/SettlementDetail.md +3 -1
- package/docs/SettlementInfo.md +6 -6
- package/docs/SolContractCallAddressLookupTableAccount.md +10 -0
- package/docs/SolContractCallDestination.md +1 -0
- package/docs/StellarContractCallContractParam.md +11 -0
- package/docs/StellarContractCallContractType.md +10 -0
- package/docs/StellarContractCallDestination.md +10 -0
- package/docs/StellarContractCallTrustLineOperationType.md +10 -0
- package/docs/StellarContractCallTrustLineParam.md +11 -0
- package/docs/SupportedToken.md +1 -0
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/SwapActivity.md +9 -9
- package/docs/SwapActivityDetail.md +10 -9
- package/docs/SwapActivitySigners.md +1 -1
- package/docs/SwapActivityTimeline.md +3 -3
- package/docs/SwapEstimateFee.md +12 -0
- package/docs/SwapQuote.md +10 -11
- package/docs/SwapReceivingTransaction.md +11 -0
- package/docs/SwapToken.md +6 -6
- package/docs/SwapsApi.md +356 -0
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokenizationApi.md +2 -2
- package/docs/TokensEventData.md +3 -1
- package/docs/TransactionCoboCategory.md +2 -0
- package/docs/TransactionDestination.md +2 -0
- package/docs/TransactionDestinationType.md +2 -0
- package/docs/TransactionFuelingInfo.md +1 -0
- package/docs/TransactionSolContractAddressLookupTableAccount.md +10 -0
- package/docs/TransactionSolContractDestination.md +1 -0
- package/docs/TransactionStellarContractParam.md +11 -0
- package/docs/TransactionStellarContractType.md +10 -0
- package/docs/TransactionStellarDestination.md +10 -0
- package/docs/TransactionStellarTrustLineOperationType.md +10 -0
- package/docs/TransactionStellarTrustLineParam.md +11 -0
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +11 -11
- package/docs/UnfreezeDisposition.md +9 -0
- package/docs/UpdateAddressBookParam.md +12 -0
- package/docs/UpdateBankAccountByIdRequest.md +9 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/UpdateTopUpAddress.md +1 -1
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletSetup.md +14 -0
- package/docs/WalletsApi.md +2 -2
- package/docs/WalletsMPCWalletsApi.md +1 -1
- package/docs/WebhookEventData.md +12 -3
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +2 -0
- package/package.json +1 -1
- package/dist/model/ApprovalShowInfo.js +0 -140
- package/docs/ApprovalShowInfo.md +0 -13
- package/docs/BTCEIP191MessageSignDestination.md +0 -10
- package/docs/RawMessageSignDestination.md +0 -10
|
@@ -4,15 +4,21 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
7
|
+
**name** | **String** | Name of the user who approved the transaction. | [optional]
|
|
8
|
+
**email** | **String** | Email of the user. | [optional]
|
|
9
|
+
**pubkey** | **String** | Public key of the user. | [optional]
|
|
10
|
+
**signature** | **String** | Signature produced by the user for this approval. | [optional]
|
|
11
|
+
**statement_uuid** | **String** | UUID of the statement associated with this approval. | [optional]
|
|
11
12
|
**result** | [**ApprovalResult**](ApprovalResult.md) | | [optional]
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**
|
|
16
|
-
**
|
|
13
|
+
**approval_result_code** | **Number** | Integer value representing the result of the approval. | [optional]
|
|
14
|
+
**created_time** | **Number** | Timestamp when the approval was created. | [optional]
|
|
15
|
+
**template_version** | **String** | Version of the template used for the transaction approval. | [optional]
|
|
16
|
+
**header_title** | **String** | Display title used in the transaction approval. | [optional]
|
|
17
|
+
**is_for_sign** | **Boolean** | Indicates whether this approval requires signing: - `true`: The user must sign the transaction. - `false`: The user only needs to approve or reject without signing. | [optional]
|
|
18
|
+
**show_info** | **String** | Additional information to show for the transaction approval. | [optional]
|
|
19
|
+
**language** | **String** | Language used for the transaction approval. | [optional]
|
|
20
|
+
**message_version** | **String** | Version of the message format used for the transaction approval. | [optional]
|
|
21
|
+
**message** | **String** | Message associated with the transaction approval. | [optional]
|
|
22
|
+
**extra_message** | **String** | Any additional message or information related to the transaction approval. | [optional]
|
|
17
23
|
|
|
18
24
|
|
package/docs/AutoSweepApi.md
CHANGED
|
@@ -4,11 +4,11 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**createAutoSweepTask**](AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks |
|
|
8
|
-
[**createWalletSweepToAddresses**](AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | create
|
|
9
|
-
[**getAutoSweepTaskById**](AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto
|
|
10
|
-
[**listAutoSweepTask**](AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List
|
|
11
|
-
[**listWalletSweepToAddresses**](AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List
|
|
7
|
+
[**createAutoSweepTask**](AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks | Create auto-sweep task
|
|
8
|
+
[**createWalletSweepToAddresses**](AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | create sweep-to address
|
|
9
|
+
[**getAutoSweepTaskById**](AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto-sweep task details
|
|
10
|
+
[**listAutoSweepTask**](AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List auto-sweep tasks
|
|
11
|
+
[**listWalletSweepToAddresses**](AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List sweep-to addresses
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
|
|
@@ -16,9 +16,9 @@ Method | HTTP request | Description
|
|
|
16
16
|
|
|
17
17
|
> AutoSweepTask createAutoSweepTask(opts)
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Create auto-sweep task
|
|
20
20
|
|
|
21
|
-
This operation
|
|
21
|
+
This operation creates an auto-sweep task for the specified wallet and token. The task triggers transactions to sweep the full balance of the specified token to the configured sweep-to address.
|
|
22
22
|
|
|
23
23
|
### Example
|
|
24
24
|
|
|
@@ -48,7 +48,7 @@ apiInstance.createAutoSweepTask(opts).then((data) => {
|
|
|
48
48
|
|
|
49
49
|
Name | Type | Description | Notes
|
|
50
50
|
------------- | ------------- | ------------- | -------------
|
|
51
|
-
**CreateAutoSweepTask** | [**CreateAutoSweepTask**](CreateAutoSweepTask.md)| The request body to
|
|
51
|
+
**CreateAutoSweepTask** | [**CreateAutoSweepTask**](CreateAutoSweepTask.md)| The request body to create an auto-sweep task. | [optional]
|
|
52
52
|
|
|
53
53
|
### Return type
|
|
54
54
|
|
|
@@ -68,9 +68,9 @@ Name | Type | Description | Notes
|
|
|
68
68
|
|
|
69
69
|
> SweepToAddress createWalletSweepToAddresses(opts)
|
|
70
70
|
|
|
71
|
-
create
|
|
71
|
+
create sweep-to address
|
|
72
72
|
|
|
73
|
-
This operation
|
|
73
|
+
This operation creates a new sweep-to address for the specified wallet. The previously sweep-to address for the same token becomes invalid once the new one is created. Use this operation to change the sweep-to address when your setup changes, you switch networks, or the current address is compromised or tainted by suspicious funds. You can withdraw any remaining balances from the old sweep-to addresses to the new address or another designated destination. <Note>Sweep-to addresses are only applicable to MPC Wallets and Web3 Wallets with the auto-sweep feature enabled.</Note>
|
|
74
74
|
|
|
75
75
|
### Example
|
|
76
76
|
|
|
@@ -100,7 +100,7 @@ apiInstance.createWalletSweepToAddresses(opts).then((data) => {
|
|
|
100
100
|
|
|
101
101
|
Name | Type | Description | Notes
|
|
102
102
|
------------- | ------------- | ------------- | -------------
|
|
103
|
-
**CreateSweepToAddress** | [**CreateSweepToAddress**](CreateSweepToAddress.md)| The request body to generates a new sweep
|
|
103
|
+
**CreateSweepToAddress** | [**CreateSweepToAddress**](CreateSweepToAddress.md)| The request body to generates a new sweep-to address within a specified wallet. | [optional]
|
|
104
104
|
|
|
105
105
|
### Return type
|
|
106
106
|
|
|
@@ -120,9 +120,9 @@ Name | Type | Description | Notes
|
|
|
120
120
|
|
|
121
121
|
> AutoSweepTask getAutoSweepTaskById(task_id)
|
|
122
122
|
|
|
123
|
-
Get auto
|
|
123
|
+
Get auto-sweep task details
|
|
124
124
|
|
|
125
|
-
This operation retrieves detailed information about a specified auto
|
|
125
|
+
This operation retrieves detailed information about a specified auto-sweep task.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -170,9 +170,9 @@ Name | Type | Description | Notes
|
|
|
170
170
|
|
|
171
171
|
> ListAutoSweepTask200Response listAutoSweepTask(wallet_id, opts)
|
|
172
172
|
|
|
173
|
-
List
|
|
173
|
+
List auto-sweep tasks
|
|
174
174
|
|
|
175
|
-
This operation retrieves a list of auto
|
|
175
|
+
This operation retrieves a list of auto-sweep tasks for the specified wallet. You can filter the results by token ID, task IDs, or a created-time range.
|
|
176
176
|
|
|
177
177
|
### Example
|
|
178
178
|
|
|
@@ -212,7 +212,7 @@ Name | Type | Description | Notes
|
|
|
212
212
|
------------- | ------------- | ------------- | -------------
|
|
213
213
|
**wallet_id** | **String**| The wallet ID. |
|
|
214
214
|
**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). | [optional]
|
|
215
|
-
**task_ids** | **String**| A list of auto
|
|
215
|
+
**task_ids** | **String**| A list of auto-sweep task IDs, separated by comma. | [optional]
|
|
216
216
|
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
|
|
217
217
|
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change. | [optional]
|
|
218
218
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
@@ -238,9 +238,9 @@ Name | Type | Description | Notes
|
|
|
238
238
|
|
|
239
239
|
> ListWalletSweepToAddresses200Response listWalletSweepToAddresses(wallet_id)
|
|
240
240
|
|
|
241
|
-
List
|
|
241
|
+
List sweep-to addresses
|
|
242
242
|
|
|
243
|
-
This operation retrieves a list of sweep
|
|
243
|
+
This operation retrieves a list of sweep-to addresses within your wallet. <Note>Sweep-to addresses are only applicable to MPC Wallets and Web3 Wallets with the auto-sweep feature enabled.</Note>
|
|
244
244
|
|
|
245
245
|
### Example
|
|
246
246
|
|
package/docs/AutoSweepTask.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**task_id** | **String** |
|
|
8
|
-
**wallet_id** | **String** |
|
|
9
|
-
**token_id** | **String** |
|
|
7
|
+
**task_id** | **String** | Auto-sweep task ID. |
|
|
8
|
+
**wallet_id** | **String** | Wallet ID. |
|
|
9
|
+
**token_id** | **String** | Token ID of the swept 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). |
|
|
10
10
|
**status** | [**AutoSweepTaskStatus**](AutoSweepTaskStatus.md) | |
|
|
11
|
-
**transaction_ids** | **[String]** |
|
|
12
|
-
**failed_reasons** | **[String]** |
|
|
11
|
+
**transaction_ids** | **[String]** | IDs of the transactions triggered by the task. | [optional]
|
|
12
|
+
**failed_reasons** | **[String]** | Reasons why the task creation failed. | [optional]
|
|
13
13
|
**created_timestamp** | **Number** | The time when the task was created, in Unix timestamp format, measured in milliseconds. |
|
|
14
14
|
**updated_timestamp** | **Number** | The time when the task was updated, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
15
15
|
|
|
@@ -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. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update 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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**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). |
|
|
9
9
|
**address** | **String** | The wallet address. |
|
|
10
10
|
**wallet_uuid** | **String** | The wallet ID. |
|
|
@@ -46,6 +46,8 @@ Name | Type | Description | Notes
|
|
|
46
46
|
|
|
47
47
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
48
48
|
|
|
49
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
50
|
+
|
|
49
51
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
50
52
|
|
|
51
53
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.BridgingFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**fee_amount** | **String** | The bridging fee amount. |
|
|
8
|
+
**received_token_id** | **String** | The received token id after bridge. | [optional]
|
|
9
|
+
**received_amount** | **String** | The received amount after bridge. | [optional]
|
|
10
|
+
|
|
11
|
+
|
package/docs/ChainInfo.md
CHANGED
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. |
|
|
8
|
-
**symbol** | **String** | The chain symbol, which is the abbreviated name of a chain. | [optional]
|
|
8
|
+
**symbol** | **String** | The chain symbol for display purposes, which is the abbreviated name of a chain. | [optional]
|
|
9
9
|
**icon_url** | **String** | The URL of the chain icon. | [optional]
|
|
10
|
+
**chain_identifier** | **String** | A functional identifier used to group blockchains with similar execution logic. For example, `ETH` for all EVM-compatible chains (Ethereum, BNB Smart Chain, Polygon). | [optional]
|
|
10
11
|
**explorer_tx_url** | **String** | The transaction URL pattern on the blockchain explorer. You can use it to concatenate the transaction URLs. | [optional]
|
|
11
12
|
**explorer_address_url** | **String** | The address URL pattern on the blockchain explorer. You can use it to concatenate the address URLs. | [optional]
|
|
12
13
|
**require_memo** | **Boolean** | Whether the chain requires a memo. | [optional]
|
package/docs/ChainsEventData.md
CHANGED
|
@@ -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. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update 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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**chains** | [**[ChainInfo]**](ChainInfo.md) | The enabled chains. |
|
|
9
9
|
**wallet_type** | [**WalletType**](WalletType.md) | | [optional]
|
|
10
10
|
**wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | | [optional]
|
|
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
|
|
|
44
44
|
|
|
45
45
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
46
46
|
|
|
47
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
48
|
+
|
|
47
49
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
48
50
|
|
|
49
51
|
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# CoboWaas2.ComplianceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**getDispositionStatus**](ComplianceApi.md#getDispositionStatus) | **GET** /compliance/funds/disposition | Get disposition status
|
|
8
|
+
[**isolateFunds**](ComplianceApi.md#isolateFunds) | **POST** /compliance/funds/disposition/isolate | Isolate funds
|
|
9
|
+
[**refundFunds**](ComplianceApi.md#refundFunds) | **POST** /compliance/funds/disposition/refund | Refund funds
|
|
10
|
+
[**unfreezeFunds**](ComplianceApi.md#unfreezeFunds) | **POST** /compliance/funds/disposition/unfreeze | Unfreeze frozen funds
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## getDispositionStatus
|
|
15
|
+
|
|
16
|
+
> DispositionQueryResponse getDispositionStatus(transaction_id)
|
|
17
|
+
|
|
18
|
+
Get disposition status
|
|
19
|
+
|
|
20
|
+
This operation retrieves the current status of a disposition request for a specific transaction. You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze) that has been initiated for a transaction. The response includes the disposition type, current status, and the disposition transaction ID if applicable. <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note>
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
|
|
24
|
+
```javascript
|
|
25
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
26
|
+
// Initialize the API client
|
|
27
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
28
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
29
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
30
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
31
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
32
|
+
// Call the API
|
|
33
|
+
const apiInstance = new CoboWaas2.ComplianceApi();
|
|
34
|
+
const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
35
|
+
apiInstance.getDispositionStatus(transaction_id).then((data) => {
|
|
36
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
37
|
+
}, (error) => {
|
|
38
|
+
console.error(error);
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
Name | Type | Description | Notes
|
|
47
|
+
------------- | ------------- | ------------- | -------------
|
|
48
|
+
**transaction_id** | **String**| The UUID of the transaction to query for disposition status. |
|
|
49
|
+
|
|
50
|
+
### Return type
|
|
51
|
+
|
|
52
|
+
[**DispositionQueryResponse**](DispositionQueryResponse.md)
|
|
53
|
+
|
|
54
|
+
### Authorization
|
|
55
|
+
|
|
56
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
57
|
+
|
|
58
|
+
### HTTP request headers
|
|
59
|
+
|
|
60
|
+
- **Content-Type**: Not defined
|
|
61
|
+
- **Accept**: application/json
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
## isolateFunds
|
|
65
|
+
|
|
66
|
+
> DispositionResponse isolateFunds(opts)
|
|
67
|
+
|
|
68
|
+
Isolate funds
|
|
69
|
+
|
|
70
|
+
This operation creates a request to isolate funds for a specific transaction. The funds will be sent to a designated isolation address for compliance purposes. You need to specify the transaction ID to be isolated and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The isolation will initiate a withdrawal transaction from the compliance-managed address to the specified isolation address.</Note>
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```javascript
|
|
75
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
76
|
+
// Initialize the API client
|
|
77
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
78
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
79
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
80
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
81
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
82
|
+
// Call the API
|
|
83
|
+
const apiInstance = new CoboWaas2.ComplianceApi();
|
|
84
|
+
const opts = {
|
|
85
|
+
'IsolateDisposition': new CoboWaas2.IsolateDisposition()
|
|
86
|
+
};
|
|
87
|
+
apiInstance.isolateFunds(opts).then((data) => {
|
|
88
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
89
|
+
}, (error) => {
|
|
90
|
+
console.error(error);
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Parameters
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
Name | Type | Description | Notes
|
|
99
|
+
------------- | ------------- | ------------- | -------------
|
|
100
|
+
**IsolateDisposition** | [**IsolateDisposition**](IsolateDisposition.md)| The request body to isolate funds. | [optional]
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
[**DispositionResponse**](DispositionResponse.md)
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: application/json
|
|
113
|
+
- **Accept**: application/json
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
## refundFunds
|
|
117
|
+
|
|
118
|
+
> DispositionResponse refundFunds(opts)
|
|
119
|
+
|
|
120
|
+
Refund funds
|
|
121
|
+
|
|
122
|
+
This operation creates a request to refund funds for a specific transaction. The funds will be sent to the specified destination address. You need to specify the transaction ID to be refunded and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The refund will initiate a withdrawal transaction from the compliance-managed address to the specified destination.</Note>
|
|
123
|
+
|
|
124
|
+
### Example
|
|
125
|
+
|
|
126
|
+
```javascript
|
|
127
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
128
|
+
// Initialize the API client
|
|
129
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
130
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
131
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
132
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
133
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
134
|
+
// Call the API
|
|
135
|
+
const apiInstance = new CoboWaas2.ComplianceApi();
|
|
136
|
+
const opts = {
|
|
137
|
+
'RefundDisposition': new CoboWaas2.RefundDisposition()
|
|
138
|
+
};
|
|
139
|
+
apiInstance.refundFunds(opts).then((data) => {
|
|
140
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
141
|
+
}, (error) => {
|
|
142
|
+
console.error(error);
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
Name | Type | Description | Notes
|
|
151
|
+
------------- | ------------- | ------------- | -------------
|
|
152
|
+
**RefundDisposition** | [**RefundDisposition**](RefundDisposition.md)| The request body to refund funds. | [optional]
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
[**DispositionResponse**](DispositionResponse.md)
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: application/json
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
## unfreezeFunds
|
|
169
|
+
|
|
170
|
+
> DispositionResponse unfreezeFunds(opts)
|
|
171
|
+
|
|
172
|
+
Unfreeze frozen funds
|
|
173
|
+
|
|
174
|
+
This operation creates a request to unfreeze funds for a previously frozen transaction. It releases the frozen funds back to their original state. You only need to specify the transaction ID to be unfrozen. Once unfrozen, the funds will be available for normal operations. <Note>The unfreeze process will release the compliance hold on the transaction, allowing it to proceed normally.</Note>
|
|
175
|
+
|
|
176
|
+
### Example
|
|
177
|
+
|
|
178
|
+
```javascript
|
|
179
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
180
|
+
// Initialize the API client
|
|
181
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
182
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
183
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
184
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
185
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
186
|
+
// Call the API
|
|
187
|
+
const apiInstance = new CoboWaas2.ComplianceApi();
|
|
188
|
+
const opts = {
|
|
189
|
+
'UnfreezeDisposition': new CoboWaas2.UnfreezeDisposition()
|
|
190
|
+
};
|
|
191
|
+
apiInstance.unfreezeFunds(opts).then((data) => {
|
|
192
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
193
|
+
}, (error) => {
|
|
194
|
+
console.error(error);
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Parameters
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
Name | Type | Description | Notes
|
|
203
|
+
------------- | ------------- | ------------- | -------------
|
|
204
|
+
**UnfreezeDisposition** | [**UnfreezeDisposition**](UnfreezeDisposition.md)| The request body to unfreeze funds. | [optional]
|
|
205
|
+
|
|
206
|
+
### Return type
|
|
207
|
+
|
|
208
|
+
[**DispositionResponse**](DispositionResponse.md)
|
|
209
|
+
|
|
210
|
+
### Authorization
|
|
211
|
+
|
|
212
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
213
|
+
|
|
214
|
+
### HTTP request headers
|
|
215
|
+
|
|
216
|
+
- **Content-Type**: application/json
|
|
217
|
+
- **Accept**: application/json
|
|
218
|
+
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# CoboWaas2.ComplianceDispositionUpdateEventData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
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. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
|
+
**transaction_id** | **String** | The transaction ID. |
|
|
9
|
+
**disposition_type** | [**DispositionType**](DispositionType.md) | |
|
|
10
|
+
**disposition_status** | [**DispositionStatus**](DispositionStatus.md) | |
|
|
11
|
+
**destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional]
|
|
12
|
+
**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]
|
|
13
|
+
**updated_timestamp** | **Number** | The time when the disposition was updated, in Unix timestamp format, measured in milliseconds. |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Enum: DataTypeEnum
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
* `Transaction` (value: `"Transaction"`)
|
|
21
|
+
|
|
22
|
+
* `TSSRequest` (value: `"TSSRequest"`)
|
|
23
|
+
|
|
24
|
+
* `Addresses` (value: `"Addresses"`)
|
|
25
|
+
|
|
26
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
27
|
+
|
|
28
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
29
|
+
|
|
30
|
+
* `Chains` (value: `"Chains"`)
|
|
31
|
+
|
|
32
|
+
* `Tokens` (value: `"Tokens"`)
|
|
33
|
+
|
|
34
|
+
* `TokenListing` (value: `"TokenListing"`)
|
|
35
|
+
|
|
36
|
+
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
37
|
+
|
|
38
|
+
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
39
|
+
|
|
40
|
+
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
41
|
+
|
|
42
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
43
|
+
|
|
44
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
45
|
+
|
|
46
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
47
|
+
|
|
48
|
+
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
49
|
+
|
|
50
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
51
|
+
|
|
52
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
|
|
10
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
|
**instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
|
|
12
|
+
**address_lookup_table_accounts** | [**[SolContractCallAddressLookupTableAccount]**](SolContractCallAddressLookupTableAccount.md) | | [optional]
|
|
13
|
+
**contract_param** | [**StellarContractCallContractParam**](StellarContractCallContractParam.md) | |
|
|
12
14
|
|
|
13
15
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.CreateAddressBookParam
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**chain_ids** | **[String]** | A list of chain IDs. |
|
|
8
|
+
**address** | **String** | The wallet address. |
|
|
9
|
+
**memo** | **String** | Optional memo or tag required by some chains. | [optional]
|
|
10
|
+
**label** | **String** | A user-defined label for the address. | [optional]
|
|
11
|
+
**email** | **String** | The email of the address owner. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**wallet_id** | **String** |
|
|
8
|
-
**token_id** | **String** |
|
|
7
|
+
**wallet_id** | **String** | ID of the wallet where the token will be swept. |
|
|
8
|
+
**token_id** | **String** | ID of the token to be swept. 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). |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The wallet name. |
|
|
8
8
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
|
-
**enable_auto_sweep** | **Boolean** | Enable the auto
|
|
10
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The wallet name. |
|
|
8
8
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
|
-
**enable_auto_sweep** | **Boolean** | Enable the auto
|
|
10
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional]
|
|
11
11
|
**exchange_id** | [**ExchangeId**](ExchangeId.md) | |
|
|
12
12
|
**apikey** | **String** | The API key of your exchange account. |
|
|
13
13
|
**secret** | **String** | The API secret of your exchange account. |
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The merchant name. |
|
|
8
|
-
**wallet_id** | **String** | The ID of the wallet linked to the merchant. |
|
|
9
|
-
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. | [optional]
|
|
8
|
+
**wallet_id** | **String** | The ID of the wallet linked to the merchant. | [optional]
|
|
9
|
+
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. If you are a merchant (directly serving the payer), you do not need to configure the developer fee rate. | [optional]
|
|
10
|
+
**wallet_setup** | [**WalletSetup**](WalletSetup.md) | | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The wallet name. |
|
|
8
8
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
|
-
**enable_auto_sweep** | **Boolean** | Enable the auto
|
|
10
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional]
|
|
11
11
|
**vault_id** | **String** | The ID of the owning vault. You can call [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults) to retrieve all vault IDs under your organization. |
|
|
12
12
|
|
|
13
13
|
|