@cobo/cobo-waas2 1.22.0 → 1.23.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 +39 -14
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +200 -21
- package/dist/api/AutoSweepApi.js +26 -26
- package/dist/api/ComplianceApi.js +214 -0
- package/dist/api/PaymentApi.js +16 -16
- package/dist/api/TokenizationApi.js +2 -2
- package/dist/api/TransactionsApi.js +16 -16
- package/dist/api/WalletsApi.js +4 -4
- package/dist/api/WalletsMPCWalletsApi.js +2 -2
- package/dist/index.js +105 -7
- package/dist/model/AddressBook.js +12 -12
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/ApprovalDetail.js +4 -4
- package/dist/model/ApprovalResult.js +6 -11
- package/dist/model/ApprovalTemplate.js +4 -4
- package/dist/model/ApprovalTransactionResult.js +8 -8
- package/dist/model/ApprovalUserDetail.js +95 -24
- package/dist/model/AutoSweepTask.js +9 -9
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/ChainInfo.js +14 -1
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/ComplianceDispositionUpdateEventData.js +321 -0
- package/dist/model/CreateAddressBookParam.js +165 -0
- package/dist/model/CreateAddressBooks201Response.js +107 -0
- package/dist/model/CreateAddressBooksParam.js +128 -0
- package/dist/model/CreateAutoSweepTask.js +5 -5
- package/dist/model/CreateCustodialWalletParams.js +1 -1
- package/dist/model/CreateExchangeWalletParams.js +2 -2
- package/dist/model/CreateMerchantRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreatePaymentOrderRequest.js +3 -3
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateSafeWalletParams.js +1 -1
- package/dist/model/CreateSettlement.js +1 -1
- package/dist/model/CreateSmartContractWalletParams.js +1 -1
- package/dist/model/CreateSweepToAddress.js +1 -1
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/DeleteAddressBookById201Response.js +106 -0
- package/dist/model/DispositionEventData.js +170 -0
- package/dist/model/DispositionQueryResponse.js +146 -0
- package/dist/model/DispositionResponse.js +122 -0
- package/dist/model/DispositionStatus.js +116 -0
- package/dist/model/DispositionType.js +66 -0
- package/dist/model/IsolateDisposition.js +167 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/Merchant.js +1 -1
- package/dist/model/MerchantBalance.js +7 -7
- package/dist/model/OrgInfo.js +9 -0
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentOrderEventData.js +8 -3
- package/dist/model/PaymentRefundEventData.js +8 -3
- package/dist/model/PaymentSettlementEvent.js +8 -3
- package/dist/model/PaymentTransactionEventData.js +8 -3
- package/dist/model/PaymentWalletBalance.js +6 -6
- package/dist/model/PspBalance.js +7 -7
- package/dist/model/ReceivedAmountPerAddress.js +5 -5
- package/dist/model/RefundDisposition.js +167 -0
- package/dist/model/RoleDetail.js +41 -6
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/SweepToAddress.js +1 -1
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/UnfreezeDisposition.js +111 -0
- package/dist/model/UpdateAddressBookParam.js +150 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEventData.js +62 -10
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +5 -0
- package/docs/AddressBook.md +7 -7
- package/docs/AddressBooksApi.md +218 -8
- package/docs/AddressesEventData.md +3 -1
- package/docs/ApprovalDetail.md +3 -3
- package/docs/ApprovalResult.md +3 -5
- package/docs/ApprovalTemplate.md +3 -3
- package/docs/ApprovalTransactionResult.md +4 -4
- package/docs/ApprovalUserDetail.md +15 -9
- package/docs/AutoSweepApi.md +18 -18
- package/docs/AutoSweepTask.md +5 -5
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/ChainInfo.md +2 -1
- package/docs/ChainsEventData.md +3 -1
- package/docs/ComplianceApi.md +218 -0
- package/docs/ComplianceDispositionUpdateEventData.md +56 -0
- package/docs/CreateAddressBookParam.md +13 -0
- package/docs/CreateAddressBooks201Response.md +9 -0
- package/docs/CreateAddressBooksParam.md +9 -0
- package/docs/CreateAutoSweepTask.md +2 -2
- package/docs/CreateCustodialWalletParams.md +1 -1
- package/docs/CreateExchangeWalletParams.md +1 -1
- package/docs/CreateMerchantRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +2 -2
- package/docs/CreateRefundRequest.md +1 -1
- package/docs/CreateSafeWalletParams.md +1 -1
- package/docs/CreateSettlement.md +1 -1
- package/docs/CreateSmartContractWalletParams.md +1 -1
- package/docs/CreateWalletParams.md +1 -1
- package/docs/DeleteAddressBookById201Response.md +9 -0
- package/docs/DispositionEventData.md +14 -0
- package/docs/DispositionQueryResponse.md +12 -0
- package/docs/DispositionResponse.md +10 -0
- package/docs/DispositionStatus.md +34 -0
- package/docs/DispositionType.md +14 -0
- package/docs/IsolateDisposition.md +13 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/Merchant.md +1 -1
- package/docs/MerchantBalance.md +6 -6
- package/docs/OrgInfo.md +1 -0
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentApi.md +10 -10
- package/docs/PaymentOrderEventData.md +3 -1
- package/docs/PaymentRefundEventData.md +3 -1
- package/docs/PaymentSettlementEvent.md +3 -1
- package/docs/PaymentTransactionEventData.md +3 -1
- package/docs/PaymentWalletBalance.md +5 -5
- package/docs/PspBalance.md +6 -6
- package/docs/ReceivedAmountPerAddress.md +2 -2
- package/docs/RefundDisposition.md +13 -0
- package/docs/RoleDetail.md +4 -1
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokenizationApi.md +2 -2
- package/docs/TokensEventData.md +3 -1
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +10 -10
- package/docs/UnfreezeDisposition.md +9 -0
- package/docs/UpdateAddressBookParam.md +12 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletsApi.md +2 -2
- package/docs/WalletsMPCWalletsApi.md +1 -1
- package/docs/WebhookEventData.md +8 -2
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +2 -0
- package/package.json +1 -1
- package/dist/model/ApprovalShowInfo.js +0 -140
- package/docs/ApprovalShowInfo.md +0 -13
package/docs/PaymentApi.md
CHANGED
|
@@ -13,9 +13,9 @@ Method | HTTP request | Description
|
|
|
13
13
|
[**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
|
|
14
14
|
[**deleteCryptoAddress**](PaymentApi.md#deleteCryptoAddress) | **POST** /payments/crypto_addresses/{crypto_address_id}/delete | Delete crypto address
|
|
15
15
|
[**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
|
|
16
|
-
[**getPayerBalanceByAddress**](PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance
|
|
16
|
+
[**getPayerBalanceByAddress**](PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance
|
|
17
17
|
[**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
|
|
18
|
-
[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get
|
|
18
|
+
[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get developer balance
|
|
19
19
|
[**getRefundDetailById**](PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
|
|
20
20
|
[**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
|
|
21
21
|
[**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
|
|
@@ -199,7 +199,7 @@ Name | Type | Description | Notes
|
|
|
199
199
|
|
|
200
200
|
Create merchant
|
|
201
201
|
|
|
202
|
-
This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet. Upon successful creation, a merchant ID is generated and returned along with the merchant's information.
|
|
202
|
+
This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. If you are a merchant (directly serving the payer), you only need to create one merchant and do not need to configure the developer fee rate. The developer fee rate only applies to platforms such as payment service providers (PSPs) that charge fees to their downstream merchants.
|
|
203
203
|
|
|
204
204
|
### Example
|
|
205
205
|
|
|
@@ -507,9 +507,9 @@ Name | Type | Description | Notes
|
|
|
507
507
|
|
|
508
508
|
> [ReceivedAmountPerAddress] getPayerBalanceByAddress(merchant_id, payer_id, token_id)
|
|
509
509
|
|
|
510
|
-
Get payer balance
|
|
510
|
+
Get payer balance
|
|
511
511
|
|
|
512
|
-
This operation retrieves
|
|
512
|
+
This operation retrieves the total amount received for a specific payer. The information is grouped by token and receiving address.
|
|
513
513
|
|
|
514
514
|
### Example
|
|
515
515
|
|
|
@@ -611,9 +611,9 @@ Name | Type | Description | Notes
|
|
|
611
611
|
|
|
612
612
|
> PspBalance getPspBalance(token_id)
|
|
613
613
|
|
|
614
|
-
Get
|
|
614
|
+
Get developer balance
|
|
615
615
|
|
|
616
|
-
This operation retrieves the information
|
|
616
|
+
This operation retrieves the balance information for you as the developer. The balance information is grouped by token.
|
|
617
617
|
|
|
618
618
|
### Example
|
|
619
619
|
|
|
@@ -1091,7 +1091,7 @@ Name | Type | Description | Notes
|
|
|
1091
1091
|
|
|
1092
1092
|
List merchant balances
|
|
1093
1093
|
|
|
1094
|
-
This operation retrieves the information
|
|
1094
|
+
This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned.
|
|
1095
1095
|
|
|
1096
1096
|
### Example
|
|
1097
1097
|
|
|
@@ -1124,7 +1124,7 @@ apiInstance.listMerchantBalances(token_id, acquiring_type, opts).then((data) =>
|
|
|
1124
1124
|
Name | Type | Description | Notes
|
|
1125
1125
|
------------- | ------------- | ------------- | -------------
|
|
1126
1126
|
**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` |
|
|
1127
|
-
**acquiring_type** | [**AcquiringType**](.md)|
|
|
1127
|
+
**acquiring_type** | [**AcquiringType**](.md)| The payment acquisition type. - `Order`: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions. - `TopUp`: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models. |
|
|
1128
1128
|
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
1129
1129
|
|
|
1130
1130
|
### Return type
|
|
@@ -1315,7 +1315,7 @@ This endpoint does not need any parameter.
|
|
|
1315
1315
|
|
|
1316
1316
|
List payment wallet balances
|
|
1317
1317
|
|
|
1318
|
-
This operation retrieves the information
|
|
1318
|
+
This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the `wallet_ids` parameter, the balance information for all payment wallets will be returned.
|
|
1319
1319
|
|
|
1320
1320
|
### Example
|
|
1321
1321
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**order_id** | **String** | The order ID. |
|
|
9
9
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
10
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` |
|
|
@@ -60,6 +60,8 @@ Name | Type | Description | Notes
|
|
|
60
60
|
|
|
61
61
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
62
62
|
|
|
63
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
64
|
+
|
|
63
65
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
64
66
|
|
|
65
67
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**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]
|
|
@@ -58,6 +58,8 @@ Name | Type | Description | Notes
|
|
|
58
58
|
|
|
59
59
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
60
60
|
|
|
61
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
62
|
+
|
|
61
63
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
62
64
|
|
|
63
65
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**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) | |
|
|
@@ -51,6 +51,8 @@ Name | Type | Description | Notes
|
|
|
51
51
|
|
|
52
52
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
53
53
|
|
|
54
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
55
|
+
|
|
54
56
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
55
57
|
|
|
56
58
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
@@ -77,6 +77,8 @@ Name | Type | Description | Notes
|
|
|
77
77
|
|
|
78
78
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
79
79
|
|
|
80
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
81
|
+
|
|
80
82
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
81
83
|
|
|
82
84
|
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**wallet_id** | **String** | The unique identifier of the wallet. |
|
|
8
|
-
**token_id** | **String** | The ID
|
|
9
|
-
**swept_balance** | **String** | The payment wallet
|
|
10
|
-
**available_balance** | **String** | The
|
|
11
|
-
**total_balance** | **String** | The payment wallet
|
|
12
|
-
**above_sweep_threshold_balance** | **String** | The payment wallet
|
|
8
|
+
**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}`. |
|
|
9
|
+
**swept_balance** | **String** | The total amount of the token on the sweep-to address of the payment wallet. | [optional]
|
|
10
|
+
**available_balance** | **String** | The balance available for settlement or refund, in the specified cryptocurrency. | [optional]
|
|
11
|
+
**total_balance** | **String** | The total balance of the token for the payment wallet. | [optional]
|
|
12
|
+
**above_sweep_threshold_balance** | **String** | The total amount of funds that exceed the sweep threshold across all receiving addresses in the payment wallet. When the balance on a receiving address exceeds the sweep threshold, those funds become eligible for automatic sweeping and are included in this balance. | [optional]
|
|
13
13
|
|
|
14
14
|
|
package/docs/PspBalance.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_id** | **String** | The ID
|
|
8
|
-
**developer_fee_amount** | **String** | The
|
|
9
|
-
**settled_amount** | **String** | The
|
|
10
|
-
**refunded_amount** | **String** | The
|
|
11
|
-
**total_balance** | **String** | The
|
|
12
|
-
**available_balance** | **String** | The
|
|
7
|
+
**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}`. |
|
|
8
|
+
**developer_fee_amount** | **String** | The total amount of the token that has been received as developer fee. | [optional]
|
|
9
|
+
**settled_amount** | **String** | The total amount of the token that has been settled from the developer's balance. | [optional]
|
|
10
|
+
**refunded_amount** | **String** | The total amount of the token that has been refunded from the developer's balance. | [optional]
|
|
11
|
+
**total_balance** | **String** | The total balance of the token for the developer. | [optional]
|
|
12
|
+
**available_balance** | **String** | The balance available for settlement or refund, in the specified cryptocurrency. | [optional]
|
|
13
13
|
|
|
14
14
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**address** | **String** |
|
|
8
|
-
**total_received_amount** | **String** |
|
|
7
|
+
**address** | **String** | The receiving address. |
|
|
8
|
+
**total_received_amount** | **String** | The total amount of the token that has been received at this address. |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.RefundDisposition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_id** | **String** | The UUID of the transaction whose funds are to be refunded. This identifies the original transaction that requires refund processing. |
|
|
8
|
+
**destination_address** | **String** | The blockchain address to receive the refunded funds. |
|
|
9
|
+
**disposition_amount** | **String** | The amount to be refunded from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction. |
|
|
10
|
+
**category_names** | **[String]** | Custom categories to identify and track this refund transaction. Used for transaction classification and reporting. | [optional]
|
|
11
|
+
**description** | **String** | Additional notes or description for the refund. | [optional]
|
|
12
|
+
|
|
13
|
+
|
package/docs/RoleDetail.md
CHANGED
|
@@ -5,7 +5,10 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**result** | [**ApprovalTransactionResult**](ApprovalTransactionResult.md) | | [optional]
|
|
8
|
-
**
|
|
8
|
+
**review_threshold** | **Number** | Minimum number of approvals required for this role. | [optional]
|
|
9
|
+
**initiator** | **String** | The initiator of the transaction. | [optional]
|
|
10
|
+
**is_upgraded** | **Boolean** | Indicates whether the transaction approval has been upgraded. | [optional]
|
|
11
|
+
**complete_time** | **String** | Time when the role completed the approval. | [optional]
|
|
9
12
|
**user_details** | [**[ApprovalUserDetail]**](ApprovalUserDetail.md) | | [optional]
|
|
10
13
|
|
|
11
14
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**token_ids** | **String** | A list of token IDs, separated by comma. |
|
|
9
9
|
**operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
|
|
10
10
|
|
|
@@ -43,6 +43,8 @@ Name | Type | Description | Notes
|
|
|
43
43
|
|
|
44
44
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
45
45
|
|
|
46
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
47
|
+
|
|
46
48
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
47
49
|
|
|
48
50
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**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]
|
|
@@ -48,6 +48,8 @@ Name | Type | Description | Notes
|
|
|
48
48
|
|
|
49
49
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
50
50
|
|
|
51
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
52
|
+
|
|
51
53
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
52
54
|
|
|
53
55
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**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. |
|
|
@@ -52,6 +52,8 @@ Name | Type | Description | Notes
|
|
|
52
52
|
|
|
53
53
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
54
54
|
|
|
55
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
56
|
+
|
|
55
57
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
56
58
|
|
|
57
59
|
|
package/docs/TokenizationApi.md
CHANGED
|
@@ -13,7 +13,7 @@ Method | HTTP request | Description
|
|
|
13
13
|
[**listIssuedTokens**](TokenizationApi.md#listIssuedTokens) | **GET** /tokenization/tokens | List issued tokens
|
|
14
14
|
[**listTokenizationActivities**](TokenizationApi.md#listTokenizationActivities) | **GET** /tokenization/activities | List tokenization activities
|
|
15
15
|
[**listTokenizationAllowlistAddresses**](TokenizationApi.md#listTokenizationAllowlistAddresses) | **GET** /tokenization/tokens/{token_id}/allowlist/addresses | List addresses on allowlist
|
|
16
|
-
[**listTokenizationBlocklistAddresses**](TokenizationApi.md#listTokenizationBlocklistAddresses) | **GET** /tokenization/tokens/{token_id}/blocklist/addresses |
|
|
16
|
+
[**listTokenizationBlocklistAddresses**](TokenizationApi.md#listTokenizationBlocklistAddresses) | **GET** /tokenization/tokens/{token_id}/blocklist/addresses | List addresses on blocklist
|
|
17
17
|
[**listTokenizationHoldings**](TokenizationApi.md#listTokenizationHoldings) | **GET** /tokenization/tokens/{token_id}/holdings | Get token holdings information
|
|
18
18
|
[**listTokenizationSupportedChains**](TokenizationApi.md#listTokenizationSupportedChains) | **GET** /tokenization/enabled_chains | List supported chains for tokenization
|
|
19
19
|
[**mintTokenization**](TokenizationApi.md#mintTokenization) | **POST** /tokenization/tokens/{token_id}/mint | Mint tokens
|
|
@@ -522,7 +522,7 @@ Name | Type | Description | Notes
|
|
|
522
522
|
|
|
523
523
|
> ListTokenizationBlocklistAddresses200Response listTokenizationBlocklistAddresses(token_id, opts)
|
|
524
524
|
|
|
525
|
-
|
|
525
|
+
List addresses on blocklist
|
|
526
526
|
|
|
527
527
|
This operation lists addresses on the blocklist.
|
|
528
528
|
|
package/docs/TokensEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**tokens** | [**[TokenInfo]**](TokenInfo.md) | The enabled tokens. |
|
|
9
9
|
**wallet_type** | [**WalletType**](WalletType.md) | | [optional]
|
|
10
10
|
**wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | | [optional]
|
|
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
|
|
|
44
44
|
|
|
45
45
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
46
46
|
|
|
47
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
48
|
+
|
|
47
49
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
48
50
|
|
|
49
51
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
@@ -72,6 +72,8 @@ Name | Type | Description | Notes
|
|
|
72
72
|
|
|
73
73
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
74
74
|
|
|
75
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
76
|
+
|
|
75
77
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
76
78
|
|
|
77
79
|
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -14,9 +14,9 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**estimateFee**](TransactionsApi.md#estimateFee) | **POST** /transactions/estimate_fee | Estimate transaction fee
|
|
15
15
|
[**getTransactionApprovalDetail**](TransactionsApi.md#getTransactionApprovalDetail) | **GET** /transactions/{transaction_id}/approval_detail | Get transaction approval details
|
|
16
16
|
[**getTransactionById**](TransactionsApi.md#getTransactionById) | **GET** /transactions/{transaction_id} | Get transaction information
|
|
17
|
-
[**listApprovalDetails**](TransactionsApi.md#listApprovalDetails) | **GET** /transactions/approval/details | List
|
|
17
|
+
[**listApprovalDetails**](TransactionsApi.md#listApprovalDetails) | **GET** /transactions/approval/details | List approval details
|
|
18
18
|
[**listTransactionApprovalDetails**](TransactionsApi.md#listTransactionApprovalDetails) | **GET** /transactions/approval_details | List transaction approval details
|
|
19
|
-
[**listTransactionTemplates**](TransactionsApi.md#listTransactionTemplates) | **GET** /transactions/templates |
|
|
19
|
+
[**listTransactionTemplates**](TransactionsApi.md#listTransactionTemplates) | **GET** /transactions/templates | List transaction templates
|
|
20
20
|
[**listTransactions**](TransactionsApi.md#listTransactions) | **GET** /transactions | List all transactions
|
|
21
21
|
[**resendTransactionById**](TransactionsApi.md#resendTransactionById) | **POST** /transactions/{transaction_id}/resend | Resend transaction
|
|
22
22
|
[**signAndBroadcastTransactionById**](TransactionsApi.md#signAndBroadcastTransactionById) | **POST** /transactions/{transaction_id}/sign_and_broadcast | Sign and broadcast transaction
|
|
@@ -238,7 +238,7 @@ Name | Type | Description | Notes
|
|
|
238
238
|
|
|
239
239
|
Sign message
|
|
240
240
|
|
|
241
|
-
This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note>This operation only
|
|
241
|
+
This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note> This operation only supports message signing transactions from the following wallets and chains: - MPC Wallets: BTC, EVM-compatible chains, Cosmos, and Solana. - Web3 Wallets: EVM-compatible chains. </Note>
|
|
242
242
|
|
|
243
243
|
### Example
|
|
244
244
|
|
|
@@ -546,9 +546,9 @@ Name | Type | Description | Notes
|
|
|
546
546
|
|
|
547
547
|
> [ApprovalDetail] listApprovalDetails(opts)
|
|
548
548
|
|
|
549
|
-
List
|
|
549
|
+
List approval details
|
|
550
550
|
|
|
551
|
-
This operation retrieves
|
|
551
|
+
This operation retrieves comprehensive approval information for transactions, including approval status, reviewer details, signatures, and approval history. You can filter the results by transaction IDs, Cobo IDs, or request IDs. This operation is commonly used to monitor approval progress and identify delays in multi-signature workflows.
|
|
552
552
|
|
|
553
553
|
### Example
|
|
554
554
|
|
|
@@ -656,9 +656,9 @@ Name | Type | Description | Notes
|
|
|
656
656
|
|
|
657
657
|
> [ApprovalTemplate] listTransactionTemplates(template_key, opts)
|
|
658
658
|
|
|
659
|
-
|
|
659
|
+
List transaction templates
|
|
660
660
|
|
|
661
|
-
This operation retrieves
|
|
661
|
+
This operation retrieves approval templates based on the specified template key and template version. These templates define the content used to generate approval messages displayed to users, including messages for transaction approvals and other approval workflows.
|
|
662
662
|
|
|
663
663
|
### Example
|
|
664
664
|
|
|
@@ -689,8 +689,8 @@ apiInstance.listTransactionTemplates(template_key, opts).then((data) => {
|
|
|
689
689
|
|
|
690
690
|
Name | Type | Description | Notes
|
|
691
691
|
------------- | ------------- | ------------- | -------------
|
|
692
|
-
**template_key** | **String**|
|
|
693
|
-
**template_version** | **String**|
|
|
692
|
+
**template_key** | **String**| Key of the transaction template used to create an approval message. |
|
|
693
|
+
**template_version** | **String**| Version of the template. | [optional]
|
|
694
694
|
|
|
695
695
|
### Return type
|
|
696
696
|
|
|
@@ -774,7 +774,7 @@ Name | Type | Description | Notes
|
|
|
774
774
|
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). | [optional]
|
|
775
775
|
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
776
776
|
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
777
|
-
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
777
|
+
**project_id** | **String**| (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
778
778
|
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
|
|
779
779
|
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change. | [optional]
|
|
780
780
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.UpdateAddressBookParam
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**chain_ids** | **[String]** | A list of chain IDs. |
|
|
8
|
+
**memo** | **String** | Optional memo or tag required by some chains. | [optional]
|
|
9
|
+
**label** | **String** | A user-defined label for the address. | [optional]
|
|
10
|
+
**email** | **String** | Email of the address owner. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The merchant name. | [optional]
|
|
8
|
-
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. | [optional]
|
|
8
|
+
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. If you are a merchant (directly serving the payer), you do not need to configure the developer fee rate. | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
42
42
|
|
|
43
43
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
44
44
|
|
|
45
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
46
|
+
|
|
45
47
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
46
48
|
|
|
47
49
|
|
package/docs/WalletsApi.md
CHANGED
|
@@ -834,7 +834,7 @@ Name | Type | Description | Notes
|
|
|
834
834
|
|
|
835
835
|
List wallet addresses
|
|
836
836
|
|
|
837
|
-
This operation retrieves a list of addresses within a specified wallet.
|
|
837
|
+
This operation retrieves a list of addresses within a specified wallet. <Note> For Web3 Wallets, Asset Wallets, and MPC Wallets, addresses created on one EVM chain automatically work on all other supported EVM chains. Currently, query results for EVM chain addresses differ between interfaces: - API: Query results are limited by chain_id, so only addresses from that specific chain are returned. - Cobo Portal: Displays addresses from all supported EVM chains, so the number of addresses may be larger than the API results. </Note>
|
|
838
838
|
|
|
839
839
|
### Example
|
|
840
840
|
|
|
@@ -1428,7 +1428,7 @@ Name | Type | Description | Notes
|
|
|
1428
1428
|
------------- | ------------- | ------------- | -------------
|
|
1429
1429
|
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
1430
1430
|
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
1431
|
-
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
1431
|
+
**project_id** | **String**| (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
1432
1432
|
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). | [optional]
|
|
1433
1433
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1434
1434
|
**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]
|
|
@@ -862,7 +862,7 @@ apiInstance.listMpcVaults(vault_type, opts).then((data) => {
|
|
|
862
862
|
Name | Type | Description | Notes
|
|
863
863
|
------------- | ------------- | ------------- | -------------
|
|
864
864
|
**vault_type** | [**MPCVaultType**](.md)| The vault type. Possible values include: - `Org-Controlled`: This vault is a collection of [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#organization-controlled-wallets). - `User-Controlled`: This vault is a collection of [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#user-controlled-wallets). |
|
|
865
|
-
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
865
|
+
**project_id** | **String**| (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
866
866
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
867
867
|
**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]
|
|
868
868
|
**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]
|
package/docs/WebhookEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. |
|
|
@@ -35,7 +35,7 @@ Name | Type | Description | Notes
|
|
|
35
35
|
**extra** | **[String]** | A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\"). | [optional]
|
|
36
36
|
**fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
|
|
37
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
|
|
38
|
+
**updated_timestamp** | **Number** | The time when the disposition was updated, in Unix timestamp format, measured in milliseconds. |
|
|
39
39
|
**tss_request_id** | **String** | The TSS request ID. | [optional]
|
|
40
40
|
**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
|
|
41
41
|
**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
|
|
@@ -89,6 +89,10 @@ Name | Type | Description | Notes
|
|
|
89
89
|
**chain** | **String** | The chain ID. |
|
|
90
90
|
**previous_address** | **String** | The previous top-up address that was assigned to the payer. |
|
|
91
91
|
**updated_address** | **String** | The new top-up address that has been assigned to the payer. |
|
|
92
|
+
**disposition_type** | [**DispositionType**](DispositionType.md) | |
|
|
93
|
+
**disposition_status** | [**DispositionStatus**](DispositionStatus.md) | |
|
|
94
|
+
**destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional]
|
|
95
|
+
**disposition_amount** | **String** | The amount to be refunded/isolated from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction. | [optional]
|
|
92
96
|
|
|
93
97
|
|
|
94
98
|
|
|
@@ -125,6 +129,8 @@ Name | Type | Description | Notes
|
|
|
125
129
|
|
|
126
130
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
127
131
|
|
|
132
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
133
|
+
|
|
128
134
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
129
135
|
|
|
130
136
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
@@ -41,6 +41,8 @@ Name | Type | Description | Notes
|
|
|
41
41
|
|
|
42
42
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
43
43
|
|
|
44
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
45
|
+
|
|
44
46
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
45
47
|
|
|
46
48
|
|
package/docs/WebhookEventType.md
CHANGED