@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.
- package/README.md +13 -1
- package/dist/ApiClient.js +1 -1
- package/dist/PreRequestScript.js +1 -1
- package/dist/api/OAuthApi.js +4 -4
- package/dist/api/PaymentApi.js +144 -6
- package/dist/api/TransactionsApi.js +94 -2
- package/dist/index.js +49 -0
- package/dist/model/AddressesEventData.js +13 -3
- package/dist/model/BalanceUpdateInfoEventData.js +13 -3
- package/dist/model/ChainsEventData.js +13 -3
- package/dist/model/ContractCallDestination.js +1 -1
- package/dist/model/CreatePaymentOrderRequest.js +4 -4
- package/dist/model/CreateRefundRequest.js +3 -3
- package/dist/model/CreateSettlement.js +1 -1
- package/dist/model/CustodialWeb3TransferSource.js +2 -2
- package/dist/model/EstimateContractCallFeeParams.js +4 -6
- package/dist/model/EvmContractCallDestination.js +2 -2
- package/dist/model/FILBase.js +0 -1
- package/dist/model/ForcedSweep.js +193 -0
- package/dist/model/ForcedSweepRequest.js +156 -0
- package/dist/model/ForcedSweepStatus.js +66 -0
- package/dist/model/ListForcedSweepRequests200Response.js +123 -0
- package/dist/model/ListTransactionApprovalDetails200Response.js +107 -0
- package/dist/model/MPCVaultEventData.js +13 -3
- package/dist/model/MpcTransferSource.js +2 -2
- package/dist/model/Order.js +2 -2
- package/dist/model/PaymentAddressUpdateEventData.js +284 -0
- package/dist/model/PaymentOrderEventData.js +16 -6
- package/dist/model/PaymentRefundEventData.js +13 -3
- package/dist/model/PaymentSettlementEvent.js +13 -3
- package/dist/model/PaymentTransactionEventData.js +827 -0
- package/dist/model/SOLBase.js +0 -1
- package/dist/model/SafeWalletDelegates.js +1 -1
- package/dist/model/SafeWalletDelegatesContractCall.js +1 -1
- package/dist/model/SettlementInfo.js +26 -0
- package/dist/model/SuspendedTokenEventData.js +13 -3
- package/dist/model/TSSRequestWebhookEventData.js +13 -3
- package/dist/model/TokenListingEventData.js +13 -3
- package/dist/model/TokenizationContractCallParamsData.js +1 -1
- package/dist/model/TokenizationEvmContractCallParams.js +2 -2
- package/dist/model/TokensEventData.js +13 -3
- package/dist/model/TransactionDestination.js +1 -1
- package/dist/model/TransactionEvmContractDestination.js +2 -2
- package/dist/model/TransactionRbfSource.js +1 -1
- package/dist/model/TransactionWebhookEventData.js +13 -3
- package/dist/model/UpdateTopUpAddress.js +2 -2
- package/dist/model/WalletInfoEventData.js +13 -3
- package/dist/model/WebhookEventData.js +115 -23
- package/dist/model/WebhookEventDataType.js +12 -2
- package/dist/model/WebhookEventType.js +5 -0
- package/docs/AddressesEventData.md +5 -1
- package/docs/BalanceUpdateInfoEventData.md +5 -1
- package/docs/ChainsEventData.md +5 -1
- package/docs/ContractCallDestination.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +2 -2
- package/docs/CreateRefundRequest.md +2 -2
- package/docs/CreateSettlement.md +1 -1
- package/docs/CustodialWeb3TransferSource.md +1 -1
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +1 -1
- package/docs/EvmContractCallDestination.md +1 -1
- package/docs/ForcedSweep.md +16 -0
- package/docs/ForcedSweepRequest.md +12 -0
- package/docs/ForcedSweepStatus.md +14 -0
- package/docs/ListForcedSweepRequests200Response.md +10 -0
- package/docs/ListTransactionApprovalDetails200Response.md +9 -0
- package/docs/MPCVaultEventData.md +5 -1
- package/docs/MpcTransferSource.md +1 -1
- package/docs/OAuthApi.md +2 -2
- package/docs/Order.md +1 -1
- package/docs/PaymentAddressUpdateEventData.md +53 -0
- package/docs/PaymentApi.md +168 -3
- package/docs/PaymentOrderEventData.md +6 -2
- package/docs/PaymentRefundEventData.md +5 -1
- package/docs/PaymentSettlementEvent.md +5 -1
- package/docs/PaymentTransactionEventData.md +84 -0
- package/docs/SafeWalletDelegates.md +1 -1
- package/docs/SafeWalletDelegatesContractCall.md +1 -1
- package/docs/SettlementInfo.md +2 -0
- package/docs/SuspendedTokenEventData.md +5 -1
- package/docs/TSSRequestWebhookEventData.md +5 -1
- package/docs/TokenListingEventData.md +5 -1
- package/docs/TokenizationContractCallParamsData.md +1 -1
- package/docs/TokenizationEvmContractCallParams.md +1 -1
- package/docs/TokensEventData.md +5 -1
- package/docs/TransactionDestination.md +1 -1
- package/docs/TransactionEvmContractDestination.md +1 -1
- package/docs/TransactionRbfSource.md +1 -1
- package/docs/TransactionWebhookEventData.md +5 -1
- package/docs/TransactionsApi.md +107 -1
- package/docs/UpdateTopUpAddress.md +1 -1
- package/docs/WalletInfoEventData.md +5 -1
- package/docs/WebhookEventData.md +22 -12
- package/docs/WebhookEventDataType.md +5 -1
- package/docs/WebhookEventType.md +2 -0
- package/package.json +1 -1
|
@@ -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
|
**vault_id** | **String** | The vault ID. | [optional]
|
|
9
9
|
**project_id** | **String** | The project ID. | [optional]
|
|
10
10
|
**name** | **String** | The vault name. | [optional]
|
|
@@ -39,6 +39,10 @@ Name | Type | Description | Notes
|
|
|
39
39
|
|
|
40
40
|
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
41
41
|
|
|
42
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
43
|
+
|
|
44
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
45
|
+
|
|
42
46
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
43
47
|
|
|
44
48
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -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`.
|
|
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]
|
package/docs/OAuthApi.md
CHANGED
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
|
|
18
18
|
Get Access Token
|
|
19
19
|
|
|
20
|
-
This operation acquires an Access Token and a Refresh Token for the Checkout SDK. For security purposes, an Access Token expires after a certain period. Once it expires, you need to call the [Refresh Access Token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-access-token) operation to get a new Access Token and a new Refresh Token.
|
|
20
|
+
This operation acquires an Access Token and a Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk). For security purposes, an Access Token expires after a certain period. Once it expires, you need to call the [Refresh Access Token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-access-token) operation to get a new Access Token and a new Refresh Token.
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
|
|
@@ -121,7 +121,7 @@ Name | Type | Description | Notes
|
|
|
121
121
|
|
|
122
122
|
Refresh Access Token
|
|
123
123
|
|
|
124
|
-
This operation refreshes the Access Token and Refresh Token for the Checkout SDK. For security purposes, an Access Token expires after a certain period. Once it expires, you need to call this operation to get a new Access Token and Refresh Token.
|
|
124
|
+
This operation refreshes the Access Token and Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk). For security purposes, an Access Token expires after a certain period. Once it expires, you need to call this operation to get a new Access Token and Refresh Token.
|
|
125
125
|
|
|
126
126
|
### Example
|
|
127
127
|
|
package/docs/Order.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**order_id** | **String** | The order ID. |
|
|
8
8
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
9
|
-
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: `ETH_USDC`, `
|
|
9
|
+
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
10
10
|
**chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. Supported chains: - USDC: `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` - USDT: `TRON`, `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` |
|
|
11
11
|
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
12
12
|
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# CoboWaas2.PaymentAddressUpdateEventData
|
|
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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
|
+
**custom_payer_id** | **String** | Unique user identifier on the merchant side, used to assign a dedicated deposit address. |
|
|
9
|
+
**payer_id** | **String** | Unique payer identifier on the Cobo side, auto-generated by the system. |
|
|
10
|
+
**chain** | **String** | Blockchain network identifier, e.g., 'ETH' for Ethereum, 'TRON' for Tron. |
|
|
11
|
+
**previous_address** | **String** | The previous deposit address that was assigned before update. |
|
|
12
|
+
**updated_address** | **String** | The new updated deposit address assigned to the user. |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Enum: DataTypeEnum
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
* `Transaction` (value: `"Transaction"`)
|
|
20
|
+
|
|
21
|
+
* `TSSRequest` (value: `"TSSRequest"`)
|
|
22
|
+
|
|
23
|
+
* `Addresses` (value: `"Addresses"`)
|
|
24
|
+
|
|
25
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
26
|
+
|
|
27
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
28
|
+
|
|
29
|
+
* `Chains` (value: `"Chains"`)
|
|
30
|
+
|
|
31
|
+
* `Tokens` (value: `"Tokens"`)
|
|
32
|
+
|
|
33
|
+
* `TokenListing` (value: `"TokenListing"`)
|
|
34
|
+
|
|
35
|
+
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
36
|
+
|
|
37
|
+
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
38
|
+
|
|
39
|
+
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
40
|
+
|
|
41
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
42
|
+
|
|
43
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
44
|
+
|
|
45
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
46
|
+
|
|
47
|
+
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
48
|
+
|
|
49
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
package/docs/PaymentApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**cancelRefundById**](PaymentApi.md#cancelRefundById) | **PUT** /payments/refunds/{refund_id}/cancel | Cancel refund order
|
|
8
|
+
[**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create force sweep request
|
|
8
9
|
[**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
9
10
|
[**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
|
|
10
11
|
[**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
|
|
@@ -18,6 +19,7 @@ Method | HTTP request | Description
|
|
|
18
19
|
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Get top-up address
|
|
19
20
|
[**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
|
|
20
21
|
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
22
|
+
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List force sweep requests
|
|
21
23
|
[**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
|
|
22
24
|
[**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
|
|
23
25
|
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List all supported tokens
|
|
@@ -26,6 +28,7 @@ Method | HTTP request | Description
|
|
|
26
28
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
27
29
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
28
30
|
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order information
|
|
31
|
+
[**updateTopUpAddress**](PaymentApi.md#updateTopUpAddress) | **PUT** /payments/topup/address | Update top-up address
|
|
29
32
|
|
|
30
33
|
|
|
31
34
|
|
|
@@ -79,6 +82,58 @@ Name | Type | Description | Notes
|
|
|
79
82
|
- **Accept**: application/json
|
|
80
83
|
|
|
81
84
|
|
|
85
|
+
## createForcedSweepRequest
|
|
86
|
+
|
|
87
|
+
> ForcedSweep createForcedSweepRequest(opts)
|
|
88
|
+
|
|
89
|
+
Create force sweep request
|
|
90
|
+
|
|
91
|
+
This operation creates a force sweep request to settle or refund available balances.
|
|
92
|
+
|
|
93
|
+
### Example
|
|
94
|
+
|
|
95
|
+
```javascript
|
|
96
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
97
|
+
// Initialize the API client
|
|
98
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
99
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
100
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
101
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
102
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
103
|
+
// Call the API
|
|
104
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
105
|
+
const opts = {
|
|
106
|
+
'ForcedSweepRequest': new CoboWaas2.ForcedSweepRequest()
|
|
107
|
+
};
|
|
108
|
+
apiInstance.createForcedSweepRequest(opts).then((data) => {
|
|
109
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
110
|
+
}, (error) => {
|
|
111
|
+
console.error(error);
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Parameters
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
Name | Type | Description | Notes
|
|
120
|
+
------------- | ------------- | ------------- | -------------
|
|
121
|
+
**ForcedSweepRequest** | [**ForcedSweepRequest**](ForcedSweepRequest.md)| The request body to force sweep. | [optional]
|
|
122
|
+
|
|
123
|
+
### Return type
|
|
124
|
+
|
|
125
|
+
[**ForcedSweep**](ForcedSweep.md)
|
|
126
|
+
|
|
127
|
+
### Authorization
|
|
128
|
+
|
|
129
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
130
|
+
|
|
131
|
+
### HTTP request headers
|
|
132
|
+
|
|
133
|
+
- **Content-Type**: application/json
|
|
134
|
+
- **Accept**: application/json
|
|
135
|
+
|
|
136
|
+
|
|
82
137
|
## createMerchant
|
|
83
138
|
|
|
84
139
|
> Merchant createMerchant(opts)
|
|
@@ -322,7 +377,7 @@ apiInstance.getExchangeRate(token_id, currency).then((data) => {
|
|
|
322
377
|
|
|
323
378
|
Name | Type | Description | Notes
|
|
324
379
|
------------- | ------------- | ------------- | -------------
|
|
325
|
-
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `
|
|
380
|
+
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
326
381
|
**currency** | **String**| The fiat currency. Currently, only `USD` is supported. | [default to 'USD']
|
|
327
382
|
|
|
328
383
|
### Return type
|
|
@@ -642,7 +697,7 @@ apiInstance.getTopUpAddress(merchant_id, token_id, custom_payer_id).then((data)
|
|
|
642
697
|
Name | Type | Description | Notes
|
|
643
698
|
------------- | ------------- | ------------- | -------------
|
|
644
699
|
**merchant_id** | **String**| The merchant ID. |
|
|
645
|
-
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `
|
|
700
|
+
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
646
701
|
**custom_payer_id** | **String**| A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
647
702
|
|
|
648
703
|
### Return type
|
|
@@ -741,7 +796,7 @@ apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
|
741
796
|
|
|
742
797
|
Name | Type | Description | Notes
|
|
743
798
|
------------- | ------------- | ------------- | -------------
|
|
744
|
-
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `
|
|
799
|
+
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
745
800
|
|
|
746
801
|
### Return type
|
|
747
802
|
|
|
@@ -757,6 +812,64 @@ Name | Type | Description | Notes
|
|
|
757
812
|
- **Accept**: application/json
|
|
758
813
|
|
|
759
814
|
|
|
815
|
+
## listForcedSweepRequests
|
|
816
|
+
|
|
817
|
+
> ListForcedSweepRequests200Response listForcedSweepRequests(opts)
|
|
818
|
+
|
|
819
|
+
List force sweep requests
|
|
820
|
+
|
|
821
|
+
This operation retrieves the information of force_sweep requests.
|
|
822
|
+
|
|
823
|
+
### Example
|
|
824
|
+
|
|
825
|
+
```javascript
|
|
826
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
827
|
+
// Initialize the API client
|
|
828
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
829
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
830
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
831
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
832
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
833
|
+
// Call the API
|
|
834
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
835
|
+
const opts = {
|
|
836
|
+
'limit': 10,
|
|
837
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
838
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
839
|
+
'request_id': "random_request_id"
|
|
840
|
+
};
|
|
841
|
+
apiInstance.listForcedSweepRequests(opts).then((data) => {
|
|
842
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
843
|
+
}, (error) => {
|
|
844
|
+
console.error(error);
|
|
845
|
+
});
|
|
846
|
+
|
|
847
|
+
```
|
|
848
|
+
|
|
849
|
+
### Parameters
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
Name | Type | Description | Notes
|
|
853
|
+
------------- | ------------- | ------------- | -------------
|
|
854
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
855
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
856
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
857
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
858
|
+
|
|
859
|
+
### Return type
|
|
860
|
+
|
|
861
|
+
[**ListForcedSweepRequests200Response**](ListForcedSweepRequests200Response.md)
|
|
862
|
+
|
|
863
|
+
### Authorization
|
|
864
|
+
|
|
865
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
866
|
+
|
|
867
|
+
### HTTP request headers
|
|
868
|
+
|
|
869
|
+
- **Content-Type**: Not defined
|
|
870
|
+
- **Accept**: application/json
|
|
871
|
+
|
|
872
|
+
|
|
760
873
|
## listMerchants
|
|
761
874
|
|
|
762
875
|
> ListMerchants200Response listMerchants(opts)
|
|
@@ -1202,3 +1315,55 @@ Name | Type | Description | Notes
|
|
|
1202
1315
|
- **Content-Type**: application/json
|
|
1203
1316
|
- **Accept**: application/json
|
|
1204
1317
|
|
|
1318
|
+
|
|
1319
|
+
## updateTopUpAddress
|
|
1320
|
+
|
|
1321
|
+
> TopUpAddress updateTopUpAddress(opts)
|
|
1322
|
+
|
|
1323
|
+
Update top-up address
|
|
1324
|
+
|
|
1325
|
+
Update the top-up address for a payer under a specific merchant and token.
|
|
1326
|
+
|
|
1327
|
+
### Example
|
|
1328
|
+
|
|
1329
|
+
```javascript
|
|
1330
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1331
|
+
// Initialize the API client
|
|
1332
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1333
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1334
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1335
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1336
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1337
|
+
// Call the API
|
|
1338
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1339
|
+
const opts = {
|
|
1340
|
+
'UpdateTopUpAddress': new CoboWaas2.UpdateTopUpAddress()
|
|
1341
|
+
};
|
|
1342
|
+
apiInstance.updateTopUpAddress(opts).then((data) => {
|
|
1343
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1344
|
+
}, (error) => {
|
|
1345
|
+
console.error(error);
|
|
1346
|
+
});
|
|
1347
|
+
|
|
1348
|
+
```
|
|
1349
|
+
|
|
1350
|
+
### Parameters
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
Name | Type | Description | Notes
|
|
1354
|
+
------------- | ------------- | ------------- | -------------
|
|
1355
|
+
**UpdateTopUpAddress** | [**UpdateTopUpAddress**](UpdateTopUpAddress.md)| The request body to update top up address. | [optional]
|
|
1356
|
+
|
|
1357
|
+
### Return type
|
|
1358
|
+
|
|
1359
|
+
[**TopUpAddress**](TopUpAddress.md)
|
|
1360
|
+
|
|
1361
|
+
### Authorization
|
|
1362
|
+
|
|
1363
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1364
|
+
|
|
1365
|
+
### HTTP request headers
|
|
1366
|
+
|
|
1367
|
+
- **Content-Type**: application/json
|
|
1368
|
+
- **Accept**: application/json
|
|
1369
|
+
|
|
@@ -4,10 +4,10 @@
|
|
|
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
|
**order_id** | **String** | The order ID. |
|
|
9
9
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
10
|
-
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: `ETH_USDC`, `
|
|
10
|
+
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
11
11
|
**chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. Supported chains: - USDC: `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` - USDT: `TRON`, `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` |
|
|
12
12
|
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
13
13
|
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
@@ -52,6 +52,10 @@ Name | Type | Description | Notes
|
|
|
52
52
|
|
|
53
53
|
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
54
54
|
|
|
55
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
56
|
+
|
|
57
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
58
|
+
|
|
55
59
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
56
60
|
|
|
57
61
|
* `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. - `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
|
**request_id** | **String** | The request ID provided by you when creating the refund request. | [optional]
|
|
9
9
|
**refund_id** | **String** | The refund order ID. |
|
|
10
10
|
**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional]
|
|
@@ -50,6 +50,10 @@ Name | Type | Description | Notes
|
|
|
50
50
|
|
|
51
51
|
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
52
52
|
|
|
53
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
54
|
+
|
|
55
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
56
|
+
|
|
53
57
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
54
58
|
|
|
55
59
|
* `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. - `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
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
|
|
9
9
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
10
10
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
@@ -40,6 +40,10 @@ Name | Type | Description | Notes
|
|
|
40
40
|
|
|
41
41
|
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
42
42
|
|
|
43
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
44
|
+
|
|
45
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
46
|
+
|
|
43
47
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
44
48
|
|
|
45
49
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# CoboWaas2.PaymentTransactionEventData
|
|
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 payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
|
+
**transaction_id** | **String** | The transaction ID. |
|
|
9
|
+
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
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]
|
|
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** | [**TransactionType**](TransactionType.md) | | [optional]
|
|
13
|
+
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
14
|
+
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
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 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). | [optional]
|
|
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). | [optional]
|
|
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** | [**TransactionSource**](TransactionSource.md) | |
|
|
20
|
+
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
21
|
+
**result** | [**TransactionResult**](TransactionResult.md) | | [optional]
|
|
22
|
+
**fee** | [**TransactionFee**](TransactionFee.md) | | [optional]
|
|
23
|
+
**initiator** | **String** | The transaction initiator. | [optional]
|
|
24
|
+
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | |
|
|
25
|
+
**confirmed_num** | **Number** | The number of confirmations this transaction has received. | [optional]
|
|
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]
|
|
27
|
+
**transaction_hash** | **String** | The transaction hash. | [optional]
|
|
28
|
+
**block_info** | [**TransactionBlockInfo**](TransactionBlockInfo.md) | | [optional]
|
|
29
|
+
**raw_tx_info** | [**TransactionRawTxInfo**](TransactionRawTxInfo.md) | | [optional]
|
|
30
|
+
**replacement** | [**TransactionReplacement**](TransactionReplacement.md) | | [optional]
|
|
31
|
+
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
32
|
+
**description** | **String** | The description for your transaction. | [optional]
|
|
33
|
+
**is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer. | [optional]
|
|
34
|
+
**cobo_category** | **[String]** | The transaction category defined by Cobo. Possible values include: - `AutoSweep`: An auto-sweep transaction. - `AutoFueling`: A transaction where Fee Station pays transaction fees to an address within your wallet. - `AutoFuelingRefund`: A refund for an auto-fueling transaction. - `SafeTxMessage`: A message signing transaction to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - `BillPayment`: A transaction to pay Cobo bills through Fee Station. - `BillRefund`: A refund for a previously made bill payment. - `CommissionFeeCharge`: A transaction to charge commission fees via Fee Station. - `CommissionFeeRefund`: A refund of previously charged commission fees. | [optional]
|
|
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 `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\"). | [optional]
|
|
36
|
+
**fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
|
|
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
|
+
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
|
|
40
|
+
**order_id** | **String** | Unique identifier of a single order | [optional]
|
|
41
|
+
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | [optional]
|
|
42
|
+
**payer_id** | **String** | Unique payer identifier on the Cobo side, auto-generated by the system. | [optional]
|
|
43
|
+
**custom_payer_id** | **String** | Unique user identifier on the merchant side, used to assign a dedicated deposit address. | [optional]
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
## Enum: DataTypeEnum
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
* `Transaction` (value: `"Transaction"`)
|
|
51
|
+
|
|
52
|
+
* `TSSRequest` (value: `"TSSRequest"`)
|
|
53
|
+
|
|
54
|
+
* `Addresses` (value: `"Addresses"`)
|
|
55
|
+
|
|
56
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
57
|
+
|
|
58
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
59
|
+
|
|
60
|
+
* `Chains` (value: `"Chains"`)
|
|
61
|
+
|
|
62
|
+
* `Tokens` (value: `"Tokens"`)
|
|
63
|
+
|
|
64
|
+
* `TokenListing` (value: `"TokenListing"`)
|
|
65
|
+
|
|
66
|
+
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
67
|
+
|
|
68
|
+
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
69
|
+
|
|
70
|
+
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
71
|
+
|
|
72
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
73
|
+
|
|
74
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
75
|
+
|
|
76
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
77
|
+
|
|
78
|
+
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
79
|
+
|
|
80
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
|
|
8
8
|
**address** | **String** | The address of the recipient. | [optional]
|
|
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
|
|
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. | [optional]
|
|
11
11
|
**token_id** | **String** | The token ID. |
|
|
12
12
|
**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
|
|
13
13
|
|
|
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
|
|
8
8
|
**address** | **String** | The destination address. | [optional]
|
|
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
|
|
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. | [optional]
|
|
11
11
|
|
|
12
12
|
|
package/docs/SettlementInfo.md
CHANGED
|
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**pending_amount** | **String** | The amount unavailable for settlement or refund, in the specified cryptocurrency. | [optional]
|
|
12
12
|
**pending_currency_balance** | **String** | The amount unavailable for settlement or refund, in the specified fiat currency. | [optional]
|
|
13
13
|
**settled_amount** | **String** | The amount already settled, in the specified cryptocurrency. | [optional]
|
|
14
|
+
**available_balance** | **String** | The balance available for settlement or refund, in the specified fiat currency. | [optional]
|
|
15
|
+
**total_balance** | **String** | The balance total for settlement or refund, in the specified fiat currency. | [optional]
|
|
14
16
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
15
17
|
**created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
16
18
|
**updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [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
|
**token_ids** | **String** | A list of token IDs, separated by comma. |
|
|
9
9
|
**operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
|
|
10
10
|
|
|
@@ -35,6 +35,10 @@ Name | Type | Description | Notes
|
|
|
35
35
|
|
|
36
36
|
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
37
37
|
|
|
38
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
39
|
+
|
|
40
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
41
|
+
|
|
38
42
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
39
43
|
|
|
40
44
|
* `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. - `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
|
**tss_request_id** | **String** | The TSS request ID. | [optional]
|
|
9
9
|
**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
|
|
10
10
|
**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
|
|
@@ -40,6 +40,10 @@ Name | Type | Description | Notes
|
|
|
40
40
|
|
|
41
41
|
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
42
42
|
|
|
43
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
44
|
+
|
|
45
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
46
|
+
|
|
43
47
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
44
48
|
|
|
45
49
|
* `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. - `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
|
**request_id** | **String** | The unique identifier of the token listing request. |
|
|
9
9
|
**chain_id** | **String** | The ID of the blockchain where the token is deployed. |
|
|
10
10
|
**contract_address** | **String** | The token's contract address on the specified blockchain. |
|
|
@@ -44,6 +44,10 @@ Name | Type | Description | Notes
|
|
|
44
44
|
|
|
45
45
|
* `PaymentSettlement` (value: `"PaymentSettlement"`)
|
|
46
46
|
|
|
47
|
+
* `PaymentTransaction` (value: `"PaymentTransaction"`)
|
|
48
|
+
|
|
49
|
+
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
50
|
+
|
|
47
51
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
48
52
|
|
|
49
53
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**type** | [**TokenizationContractCallType**](TokenizationContractCallType.md) | | [optional]
|
|
8
|
-
**calldata** | **String** | The data
|
|
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
|
|