@cobo/cobo-waas2 1.7.0 → 1.8.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 +48 -3
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +6 -6
- package/dist/api/DevelopersApi.js +110 -0
- package/dist/api/DevelopersWebhooksApi.js +30 -30
- package/dist/api/OAuthApi.js +2 -2
- package/dist/api/StakingsApi.js +33 -30
- package/dist/api/TransactionsApi.js +73 -28
- package/dist/api/TravelRuleApi.js +216 -0
- package/dist/api/WalletsApi.js +68 -68
- package/dist/api/WalletsExchangeWalletApi.js +12 -12
- package/dist/api/WalletsMPCWalletsApi.js +60 -60
- package/dist/index.js +273 -0
- package/dist/model/Activity.js +29 -0
- package/dist/model/ActivityAction.js +30 -0
- package/dist/model/ActivityExtra.js +274 -0
- package/dist/model/AddressInfo.js +15 -2
- package/dist/model/AddressTransferDestination.js +1 -1
- package/dist/model/AddressesEventData.js +190 -0
- package/dist/model/ApiLogDetails.js +2 -2
- package/dist/model/BabylonStakeExtra.js +1 -1
- package/dist/model/BabylonStakingActivityDetailExtra.js +165 -0
- package/dist/model/BaseContractCallSource.js +1 -1
- package/dist/model/BroadcastSignedTransactionsRequest.js +1 -1
- package/dist/model/CallbackMessage.js +288 -0
- package/dist/model/ChainInfo.js +2 -2
- package/dist/model/ContractCallParams.js +2 -2
- package/dist/model/CoreStakingActivityDetailExtra.js +164 -0
- package/dist/model/CreateAddressRequest.js +2 -2
- package/dist/model/CreateClaimActivity.js +2 -2
- package/dist/model/CreateClaimActivityRequest.js +3 -3
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreateMpcVaultRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreateStakeActivity.js +4 -6
- package/dist/model/CreateStakeActivityExtra.js +1 -1
- package/dist/model/CreateStakeActivityRequest.js +5 -7
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/CreateWebhookEndpointRequest.js +2 -2
- package/dist/model/CustodialTransferSource.js +1 -1
- package/dist/model/DestinationWalletType.js +61 -0
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/EstimateClaimFee.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +2 -2
- package/dist/model/EstimateStakeFee.js +5 -7
- package/dist/model/EstimateTransferFeeParams.js +2 -2
- package/dist/model/EthStakeEstimatedFee.js +13 -0
- package/dist/model/EthStakingActivityDetailExtra.js +142 -0
- package/dist/model/EvmContractCallDestination.js +1 -1
- package/dist/model/EvmEIP191MessageSignDestination.js +1 -1
- package/dist/model/EvmEIP712MessageSignDestination.js +1 -1
- package/dist/model/ExchangeTransferDestination.js +1 -1
- package/dist/model/ExchangeTransferSource.js +1 -1
- package/dist/model/ExtendedTokenInfo.js +3 -3
- package/dist/model/GetStakingEstimationFee201Response.js +6 -0
- package/dist/model/GetStakingEstimationFeeRequest.js +1 -1
- package/dist/model/GetTransactionLimitation200Response.js +143 -0
- package/dist/model/ListCallbackMessages200Response.js +145 -0
- package/dist/model/ListSupportedCountries200ResponseInner.js +140 -0
- package/dist/model/LockUtxosRequestUtxosInner.js +2 -2
- package/dist/model/MPCDelegate.js +1 -1
- package/dist/model/MPCVaultEventData.js +279 -0
- package/dist/model/MaxTransferableValue.js +1 -1
- package/dist/model/MessageSignParams.js +2 -2
- package/dist/model/MpcTransferSource.js +1 -1
- package/dist/model/OrgInfo.js +133 -0
- package/dist/model/Pagination.js +4 -4
- package/dist/model/RawMessageSignDestination.js +1 -1
- package/dist/model/RetryCallbackMessage201Response.js +83 -0
- package/dist/model/SafeContractCallSource.js +1 -1
- package/dist/model/SafeTransferSource.js +1 -1
- package/dist/model/SelectedEntityType.js +61 -0
- package/dist/model/SelfCustodyWallet.js +152 -0
- package/dist/model/SourceGroup.js +1 -1
- package/dist/model/StakingPoolId.js +5 -0
- package/dist/model/StakingPoolType.js +5 -0
- package/dist/model/SubmitDepositTravelRuleInfo201Response.js +83 -0
- package/dist/model/SwapActivity.js +218 -0
- package/dist/model/SwapSummary.js +121 -0
- package/dist/model/SwapTokenPair.js +100 -0
- package/dist/model/TSSRequestWebhookEventData.js +18 -3
- package/dist/model/TokenBalance.js +2 -2
- package/dist/model/TokenBalanceBalance.js +6 -6
- package/dist/model/TokenInfo.js +2 -2
- package/dist/model/Transaction.js +2 -2
- package/dist/model/TransactionApprovalDetail.js +121 -0
- package/dist/model/TransactionApprovalResult.js +66 -0
- package/dist/model/TransactionCustodialAssetWalletSource.js +1 -1
- package/dist/model/TransactionDepositFromAddressSource.js +1 -1
- package/dist/model/TransactionDepositFromLoopSource.js +1 -1
- package/dist/model/TransactionDepositFromWalletSource.js +1 -1
- package/dist/model/TransactionDepositToAddressDestination.js +1 -1
- package/dist/model/TransactionDepositToWalletDestination.js +1 -1
- package/dist/model/TransactionDetail.js +4 -4
- package/dist/model/TransactionDetails.js +4 -4
- package/dist/model/TransactionEvmContractDestination.js +1 -1
- package/dist/model/TransactionExchangeWalletSource.js +1 -1
- package/dist/model/TransactionMPCWalletSource.js +1 -1
- package/dist/model/TransactionMessageSignEIP191Destination.js +1 -1
- package/dist/model/TransactionMessageSignEIP712Destination.js +1 -1
- package/dist/model/TransactionRawMessageSignDestination.js +1 -1
- package/dist/model/TransactionRawTxInfo.js +4 -4
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFixedFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionRoleApprovalDetail.js +152 -0
- package/dist/model/TransactionSelectedUtxo.js +123 -0
- package/dist/model/TransactionSmartContractSafeWalletSource.js +1 -1
- package/dist/model/TransactionTokeApproval.js +3 -3
- package/dist/model/TransactionTokenAmount.js +1 -1
- package/dist/model/TransactionTransferToAddressDestination.js +1 -1
- package/dist/model/TransactionTransferToWalletDestination.js +1 -1
- package/dist/model/TransactionUserApprovalDetail.js +162 -0
- package/dist/model/TransactionWebhookEventData.js +22 -7
- package/dist/model/TransferParams.js +2 -2
- package/dist/model/TravelRuleDepositExchangesOrVASP.js +168 -0
- package/dist/model/TravelRuleDepositExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleDepositLegalEntity.js +171 -0
- package/dist/model/TravelRuleDepositNaturalEntity.js +186 -0
- package/dist/model/TravelRuleDepositRequest.js +128 -0
- package/dist/model/TravelRuleDepositRequestTravelRuleInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASP.js +155 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawLegalEntity.js +144 -0
- package/dist/model/TravelRuleWithdrawNaturalEntity.js +159 -0
- package/dist/model/TravelRuleWithdrawRequest.js +128 -0
- package/dist/model/TravelRuleWithdrawRequestTravelRuleInfo.js +216 -0
- package/dist/model/TriggerTestWebhookEventRequest.js +1 -1
- package/dist/model/UpdateWebhookEndpointByIdRequest.js +1 -1
- package/dist/model/Vasp.js +141 -0
- package/dist/model/WalletInfoEventData.js +175 -0
- package/dist/model/WebhookEventData.js +135 -14
- package/dist/model/WebhookEventDataType.js +17 -2
- package/dist/model/WebhookEventType.js +23 -8
- package/docs/Activity.md +2 -0
- package/docs/ActivityAction.md +12 -0
- package/docs/ActivityExtra.md +20 -0
- package/docs/AddressBooksApi.md +3 -3
- package/docs/AddressInfo.md +2 -1
- package/docs/AddressesEventData.md +29 -0
- package/docs/ApiLogDetails.md +1 -1
- package/docs/BabylonStakeExtra.md +1 -1
- package/docs/BabylonStakingActivityDetailExtra.md +14 -0
- package/docs/BroadcastSignedTransactionsRequest.md +1 -1
- package/docs/CallbackMessage.md +46 -0
- package/docs/ChainInfo.md +1 -1
- package/docs/ContractCallParams.md +1 -1
- package/docs/CoreStakingActivityDetailExtra.md +13 -0
- package/docs/CreateAddressRequest.md +1 -1
- package/docs/CreateClaimActivity.md +1 -1
- package/docs/CreateClaimActivityRequest.md +1 -1
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMpcVaultRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreateStakeActivity.md +1 -1
- package/docs/CreateStakeActivityExtra.md +1 -1
- package/docs/CreateStakeActivityRequest.md +1 -1
- package/docs/CreateWalletParams.md +1 -1
- package/docs/CreateWebhookEndpointRequest.md +1 -1
- package/docs/DestinationWalletType.md +12 -0
- package/docs/DevelopersApi.md +118 -0
- package/docs/DevelopersWebhooksApi.md +15 -15
- package/docs/ErrorResponse.md +1 -1
- package/docs/EstimateClaimFee.md +1 -1
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +2 -2
- package/docs/EstimateStakeFee.md +1 -1
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/EthStakeEstimatedFee.md +1 -0
- package/docs/EthStakingActivityDetailExtra.md +11 -0
- package/docs/ExtendedTokenInfo.md +1 -1
- package/docs/GetStakingEstimationFee201Response.md +1 -0
- package/docs/GetStakingEstimationFeeRequest.md +2 -2
- package/docs/GetTransactionLimitation200Response.md +12 -0
- package/docs/ListCallbackMessages200Response.md +10 -0
- package/docs/ListSupportedCountries200ResponseInner.md +11 -0
- package/docs/LockUtxosRequestUtxosInner.md +1 -1
- package/docs/MPCVaultEventData.md +34 -0
- package/docs/MaxTransferableValue.md +1 -1
- package/docs/MessageSignParams.md +1 -1
- package/docs/OAuthApi.md +1 -1
- package/docs/OrgInfo.md +11 -0
- package/docs/Pagination.md +2 -2
- package/docs/RetryCallbackMessage201Response.md +9 -0
- package/docs/SelectedEntityType.md +12 -0
- package/docs/SelfCustodyWallet.md +12 -0
- package/docs/SourceGroup.md +1 -1
- package/docs/StakingPoolId.md +2 -0
- package/docs/StakingPoolType.md +2 -0
- package/docs/StakingsApi.md +18 -16
- package/docs/SubmitDepositTravelRuleInfo201Response.md +9 -0
- package/docs/SwapActivity.md +20 -0
- package/docs/SwapSummary.md +10 -0
- package/docs/SwapTokenPair.md +10 -0
- package/docs/TSSRequestWebhookEventData.md +7 -1
- package/docs/TokenBalance.md +1 -1
- package/docs/TokenBalanceBalance.md +4 -4
- package/docs/TokenInfo.md +1 -1
- package/docs/Transaction.md +2 -2
- package/docs/TransactionApprovalDetail.md +11 -0
- package/docs/TransactionApprovalResult.md +14 -0
- package/docs/TransactionDetail.md +2 -2
- package/docs/TransactionDetails.md +2 -2
- package/docs/TransactionRawTxInfo.md +1 -1
- package/docs/TransactionRoleApprovalDetail.md +13 -0
- package/docs/TransactionSelectedUtxo.md +12 -0
- package/docs/TransactionTokeApproval.md +1 -1
- package/docs/TransactionTokenAmount.md +1 -1
- package/docs/TransactionUserApprovalDetail.md +15 -0
- package/docs/TransactionWebhookEventData.md +9 -3
- package/docs/TransactionsApi.md +65 -14
- package/docs/TransferParams.md +1 -1
- package/docs/TravelRuleApi.md +214 -0
- package/docs/TravelRuleDepositExchangesOrVASP.md +13 -0
- package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md +29 -0
- package/docs/TravelRuleDepositLegalEntity.md +25 -0
- package/docs/TravelRuleDepositNaturalEntity.md +26 -0
- package/docs/TravelRuleDepositRequest.md +10 -0
- package/docs/TravelRuleDepositRequestTravelRuleInfo.md +16 -0
- package/docs/TravelRuleWithdrawExchangesOrVASP.md +12 -0
- package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md +16 -0
- package/docs/TravelRuleWithdrawLegalEntity.md +12 -0
- package/docs/TravelRuleWithdrawNaturalEntity.md +13 -0
- package/docs/TravelRuleWithdrawRequest.md +10 -0
- package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md +15 -0
- package/docs/TriggerTestWebhookEventRequest.md +1 -1
- package/docs/UpdateWebhookEndpointByIdRequest.md +1 -1
- package/docs/Vasp.md +11 -0
- package/docs/WalletInfoEventData.md +29 -0
- package/docs/WalletsApi.md +34 -34
- package/docs/WalletsExchangeWalletApi.md +6 -6
- package/docs/WalletsMPCWalletsApi.md +30 -30
- package/docs/WebhookEventData.md +17 -5
- package/docs/WebhookEventDataType.md +7 -1
- package/docs/WebhookEventType.md +14 -8
- package/package.json +2 -2
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**getTransactionLimitation**](TravelRuleApi.md#getTransactionLimitation) | **GET** /travel_rule/transaction/limitation | Retrieve transaction limitations
|
|
8
|
+
[**listSupportedCountries**](TravelRuleApi.md#listSupportedCountries) | **GET** /travel_rule/transaction/countries | List supported countries
|
|
9
|
+
[**submitDepositTravelRuleInfo**](TravelRuleApi.md#submitDepositTravelRuleInfo) | **POST** /travel_rule/transaction/deposit/travel_rule_info | Submit Deposit Transaction Travel Rule information
|
|
10
|
+
[**submitWithdrawTravelRuleInfo**](TravelRuleApi.md#submitWithdrawTravelRuleInfo) | **POST** /travel_rule/transaction/withdraw/travel_rule_info | Submit Withdraw Transaction Travel Rule information
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## getTransactionLimitation
|
|
15
|
+
|
|
16
|
+
> GetTransactionLimitation200Response getTransactionLimitation(transaction_type, transaction_id)
|
|
17
|
+
|
|
18
|
+
Retrieve transaction limitations
|
|
19
|
+
|
|
20
|
+
This endpoint retrieves transaction-related limitations based on the provided `transaction_type` and `transaction_id`. The response includes the following information: - **`vasp_list`**: A list of Virtual Asset Service Providers (VASPs) associated with the transaction token. - **`is_threshold_reached`**: Indicates whether the transaction amount has exceeded the predefined threshold. - If `true`: Additional Travel Rule information may be required for processing. - **`self_custody_wallet_challenge`**: A challenge string for verifying ownership of self-custody wallets. - **`connect_wallet_list`**: A list of supported wallet integrations for the transaction, such as MetaMask or WalletConnect. Use this endpoint to ensure compliance with Travel Rule requirements and to retrieve supported options for completing the transaction.
|
|
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.TravelRuleApi();
|
|
34
|
+
const transaction_type = "DEPOSIT";
|
|
35
|
+
const transaction_id = "123e4567-e89b-12d3-a456-426614174000";
|
|
36
|
+
apiInstance.getTransactionLimitation(transaction_type, transaction_id).then((data) => {
|
|
37
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
38
|
+
}, (error) => {
|
|
39
|
+
console.error(error);
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
Name | Type | Description | Notes
|
|
48
|
+
------------- | ------------- | ------------- | -------------
|
|
49
|
+
**transaction_type** | **String**| The transaction type. Possible values include: - `DEPOSIT`: A deposit transaction. - `WITHDRAW`: A withdrawal transaction. |
|
|
50
|
+
**transaction_id** | **String**| The transaction ID |
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**GetTransactionLimitation200Response**](GetTransactionLimitation200Response.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: Not defined
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## listSupportedCountries
|
|
67
|
+
|
|
68
|
+
> [ListSupportedCountries200ResponseInner] listSupportedCountries()
|
|
69
|
+
|
|
70
|
+
List supported countries
|
|
71
|
+
|
|
72
|
+
This operation retrieves all countries supported.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```javascript
|
|
77
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
78
|
+
// Initialize the API client
|
|
79
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
80
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
81
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
82
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
83
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
84
|
+
// Call the API
|
|
85
|
+
const apiInstance = new CoboWaas2.TravelRuleApi();
|
|
86
|
+
apiInstance.listSupportedCountries().then((data) => {
|
|
87
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
88
|
+
}, (error) => {
|
|
89
|
+
console.error(error);
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
This endpoint does not need any parameter.
|
|
97
|
+
|
|
98
|
+
### Return type
|
|
99
|
+
|
|
100
|
+
[**[ListSupportedCountries200ResponseInner]**](ListSupportedCountries200ResponseInner.md)
|
|
101
|
+
|
|
102
|
+
### Authorization
|
|
103
|
+
|
|
104
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
105
|
+
|
|
106
|
+
### HTTP request headers
|
|
107
|
+
|
|
108
|
+
- **Content-Type**: Not defined
|
|
109
|
+
- **Accept**: application/json
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
## submitDepositTravelRuleInfo
|
|
113
|
+
|
|
114
|
+
> SubmitDepositTravelRuleInfo201Response submitDepositTravelRuleInfo(opts)
|
|
115
|
+
|
|
116
|
+
Submit Deposit Transaction Travel Rule information
|
|
117
|
+
|
|
118
|
+
This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements. - **Destination Wallet Type (`destination_wallet_type`)**: - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`. - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`. - **Entity Types (`selected_entity_type`)**: - `LEGAL`: For legal entities, provide `legal_name`, `date_of_incorporation`, and `place_of_incorporation`. - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`.
|
|
119
|
+
|
|
120
|
+
### Example
|
|
121
|
+
|
|
122
|
+
```javascript
|
|
123
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
124
|
+
// Initialize the API client
|
|
125
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
126
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
127
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
128
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
129
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
130
|
+
// Call the API
|
|
131
|
+
const apiInstance = new CoboWaas2.TravelRuleApi();
|
|
132
|
+
const opts = {
|
|
133
|
+
'TravelRuleDepositRequest': new CoboWaas2.TravelRuleDepositRequest()
|
|
134
|
+
};
|
|
135
|
+
apiInstance.submitDepositTravelRuleInfo(opts).then((data) => {
|
|
136
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
137
|
+
}, (error) => {
|
|
138
|
+
console.error(error);
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
Name | Type | Description | Notes
|
|
147
|
+
------------- | ------------- | ------------- | -------------
|
|
148
|
+
**TravelRuleDepositRequest** | [**TravelRuleDepositRequest**](TravelRuleDepositRequest.md)| | [optional]
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
[**SubmitDepositTravelRuleInfo201Response**](SubmitDepositTravelRuleInfo201Response.md)
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: application/json
|
|
161
|
+
- **Accept**: application/json
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
## submitWithdrawTravelRuleInfo
|
|
165
|
+
|
|
166
|
+
> SubmitDepositTravelRuleInfo201Response submitWithdrawTravelRuleInfo(opts)
|
|
167
|
+
|
|
168
|
+
Submit Withdraw Transaction Travel Rule information
|
|
169
|
+
|
|
170
|
+
This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements. - **Destination Wallet Type (`destination_wallet_type`)**: - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`. - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`. - **Entity Types (`selected_entity_type`)**: - `LEGAL`: For legal entities, provide `legal_name`. - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`.
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
|
|
174
|
+
```javascript
|
|
175
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
176
|
+
// Initialize the API client
|
|
177
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
178
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
179
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
180
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
181
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
182
|
+
// Call the API
|
|
183
|
+
const apiInstance = new CoboWaas2.TravelRuleApi();
|
|
184
|
+
const opts = {
|
|
185
|
+
'TravelRuleWithdrawRequest': new CoboWaas2.TravelRuleWithdrawRequest()
|
|
186
|
+
};
|
|
187
|
+
apiInstance.submitWithdrawTravelRuleInfo(opts).then((data) => {
|
|
188
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
189
|
+
}, (error) => {
|
|
190
|
+
console.error(error);
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Parameters
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
Name | Type | Description | Notes
|
|
199
|
+
------------- | ------------- | ------------- | -------------
|
|
200
|
+
**TravelRuleWithdrawRequest** | [**TravelRuleWithdrawRequest**](TravelRuleWithdrawRequest.md)| | [optional]
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
[**SubmitDepositTravelRuleInfo201Response**](SubmitDepositTravelRuleInfo201Response.md)
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: application/json
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleDepositExchangesOrVASP
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
+
**vendor_code** | **String** | The vendor code for exchanges or VASPs. |
|
|
9
|
+
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
10
|
+
**vendor_vasp_name** | **String** | The vendor name to be provided when selecting \"Others\" as the VASP case. This field allows customers to specify the name of a vendor not listed. | [optional]
|
|
11
|
+
**entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) | |
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleDepositExchangesOrVASPEntityInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. |
|
|
8
|
+
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
+
**date_of_incorporation** | **Date** | The incorporation date of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted. | [optional]
|
|
10
|
+
**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted. | [optional]
|
|
11
|
+
**first_name** | **String** | The first name of the user. |
|
|
12
|
+
**last_name** | **String** | The last name of the user. |
|
|
13
|
+
**date_of_birth** | **Date** | The date of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted. | [optional]
|
|
14
|
+
**place_of_birth** | **String** | The place of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Enum: SelectedEntityTypeEnum
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
* `LEGAL` (value: `"LEGAL"`)
|
|
22
|
+
|
|
23
|
+
* `NATURAL` (value: `"NATURAL"`)
|
|
24
|
+
|
|
25
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleDepositLegalEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. |
|
|
8
|
+
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
+
**date_of_incorporation** | **Date** | The incorporation date of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted. | [optional]
|
|
10
|
+
**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## Enum: SelectedEntityTypeEnum
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
* `LEGAL` (value: `"LEGAL"`)
|
|
18
|
+
|
|
19
|
+
* `NATURAL` (value: `"NATURAL"`)
|
|
20
|
+
|
|
21
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleDepositNaturalEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. |
|
|
8
|
+
**first_name** | **String** | The first name of the user. |
|
|
9
|
+
**last_name** | **String** | The last name of the user. |
|
|
10
|
+
**date_of_birth** | **Date** | The date of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted. | [optional]
|
|
11
|
+
**place_of_birth** | **String** | The place of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## Enum: SelectedEntityTypeEnum
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
* `LEGAL` (value: `"LEGAL"`)
|
|
19
|
+
|
|
20
|
+
* `NATURAL` (value: `"NATURAL"`)
|
|
21
|
+
|
|
22
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleDepositRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_id** | **String** | The transaction ID. |
|
|
8
|
+
**travel_rule_info** | [**TravelRuleDepositRequestTravelRuleInfo**](TravelRuleDepositRequestTravelRuleInfo.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleDepositRequestTravelRuleInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
+
**vendor_code** | **String** | The vendor code for exchanges or VASPs. |
|
|
9
|
+
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
10
|
+
**vendor_vasp_name** | **String** | The vendor name to be provided when selecting \"Others\" as the VASP case. This field allows customers to specify the name of a vendor not listed. | [optional]
|
|
11
|
+
**entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) | |
|
|
12
|
+
**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. |
|
|
13
|
+
**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. |
|
|
14
|
+
**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. |
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleWithdrawExchangesOrVASP
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
+
**vendor_code** | **String** | The vendor code for exchanges or VASPs. |
|
|
9
|
+
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
10
|
+
**entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) | |
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleWithdrawExchangesOrVASPEntityInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) | |
|
|
8
|
+
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
+
**date_of_incorporation** | **Date** | The incorporation date of the entity. | [optional]
|
|
10
|
+
**place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional]
|
|
11
|
+
**first_name** | **String** | The first name of the user. |
|
|
12
|
+
**last_name** | **String** | The last name of the user. |
|
|
13
|
+
**date_of_birth** | **Date** | The date of birth of the user. | [optional]
|
|
14
|
+
**place_of_birth** | **String** | The place of birth of the user. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleWithdrawLegalEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) | |
|
|
8
|
+
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
+
**date_of_incorporation** | **Date** | The incorporation date of the entity. | [optional]
|
|
10
|
+
**place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleWithdrawNaturalEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) | |
|
|
8
|
+
**first_name** | **String** | The first name of the user. |
|
|
9
|
+
**last_name** | **String** | The last name of the user. |
|
|
10
|
+
**date_of_birth** | **Date** | The date of birth of the user. | [optional]
|
|
11
|
+
**place_of_birth** | **String** | The place of birth of the user. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleWithdrawRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_id** | **String** | The transaction ID. |
|
|
8
|
+
**travel_rule_info** | [**TravelRuleWithdrawRequestTravelRuleInfo**](TravelRuleWithdrawRequestTravelRuleInfo.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleWithdrawRequestTravelRuleInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
+
**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. |
|
|
9
|
+
**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. |
|
|
10
|
+
**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. |
|
|
11
|
+
**vendor_code** | **String** | The vendor code for exchanges or VASPs. |
|
|
12
|
+
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
13
|
+
**entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) | |
|
|
14
|
+
|
|
15
|
+
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**event_type** | [**WebhookEventType**](WebhookEventType.md) | |
|
|
8
|
-
**override_data** | **Object** | An object for customization of the webhook event payload. You only need to include the fields you want to customize. The provided fields must match the webhook event data structure, depending on the specified event type. For a complete introduction of the webhook event data structure, refer to the `data.data` property in the response of [List all webhook events](/v2/api-references/developers--webhooks/list-all-webhook-events). If this property is not provided, a default payload will be returned. | [optional]
|
|
8
|
+
**override_data** | **Object** | An object for customization of the webhook event payload. You only need to include the fields you want to customize. The provided fields must match the webhook event data structure, depending on the specified event type. For a complete introduction of the webhook event data structure, refer to the `data.data` property in the response of [List all webhook events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-webhook-events). If this property is not provided, a default payload will be returned. | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**subscribed_events** | [**[WebhookEventType]**](WebhookEventType.md) | The new event types you want to subscribe to for this webhook endpoint. You can call [Get webhook event types](/v2/api-references/developers--webhooks/get-webhook-event-types) to retrieve all available event types. | [optional]
|
|
7
|
+
**subscribed_events** | [**[WebhookEventType]**](WebhookEventType.md) | The new event types you want to subscribe to for this webhook endpoint. You can call [Get webhook event types](https://www.cobo.com/developers/v2/api-references/developers--webhooks/get-webhook-event-types) to retrieve all available event types. | [optional]
|
|
8
8
|
**status** | **String** | The new status you want to set the webhook endpoint to. If you set `status` to `STATUS_INACTIVE`, the endpoint will be revoked, meaning it will no longer receive any webhook events. | [optional]
|
|
9
9
|
**description** | **String** | The webhook endpoint description. | [optional]
|
|
10
10
|
|
package/docs/Vasp.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.Vasp
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | The name of the vasp. |
|
|
8
|
+
**vendor_code** | **String** | The symbol. |
|
|
9
|
+
**vendor_vasp_id** | **String** | The vasp str id. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# CoboWaas2.WalletInfoEventData
|
|
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. |
|
|
8
|
+
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## Enum: DataTypeEnum
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
* `Transaction` (value: `"Transaction"`)
|
|
16
|
+
|
|
17
|
+
* `TSSRequest` (value: `"TSSRequest"`)
|
|
18
|
+
|
|
19
|
+
* `Addresses` (value: `"Addresses"`)
|
|
20
|
+
|
|
21
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
22
|
+
|
|
23
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
24
|
+
|
|
25
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|