@cobo/cobo-waas2 1.28.0 → 1.30.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 +88 -16
- package/dist/ApiClient.js +1 -1
- package/dist/api/AutoSweepApi.js +2 -2
- package/dist/api/ComplianceApi.js +144 -4
- package/dist/api/FeeStationApi.js +2 -2
- package/dist/api/GraphQLApi.js +85 -0
- package/dist/api/PaymentApi.js +1161 -154
- package/dist/api/StakingsApi.js +2 -2
- package/dist/api/SwapsApi.js +3 -0
- package/dist/api/TransactionsApi.js +6 -6
- package/dist/api/WalletsApi.js +18 -18
- package/dist/index.js +357 -28
- package/dist/model/AddressRiskLevel.js +71 -0
- package/dist/model/AddressesEventData.js +13 -3
- package/dist/model/{AllocationRecord.js → AllocationItem.js} +38 -35
- package/dist/model/{AllocationRequest.js → AllocationParam.js} +29 -26
- package/dist/model/BalanceUpdateInfoEventData.js +13 -3
- package/dist/model/BatchAllocation.js +12 -12
- package/dist/model/BatchAllocationDetail.js +15 -17
- package/dist/model/BridgingFee.js +3 -3
- package/dist/model/ChainsEventData.js +13 -3
- package/dist/model/CommissionFee.js +2 -2
- package/dist/model/ComplianceDispositionUpdateEventData.js +13 -3
- package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +346 -0
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +13 -3
- package/dist/model/ContractCallParams.js +3 -3
- package/dist/model/CounterpartyWalletAddressDetail.js +2 -2
- package/dist/model/CreateBatchAllocationRequest.js +19 -19
- package/dist/model/CreateBulkSendRequest.js +167 -0
- package/dist/model/CreateBulkSendRequestPayoutParamsInner.js +153 -0
- package/dist/model/CreateCounterpartyEntry201Response.js +143 -0
- package/dist/model/CreateCounterpartyEntryRequest.js +141 -0
- package/dist/model/CreateDestinationEntry201Response.js +172 -0
- package/dist/model/CreateDestinationEntryRequest.js +172 -0
- package/dist/model/CreateKyaScreeningsBody.js +129 -0
- package/dist/model/CreateMerchantRequest.js +1 -1
- package/dist/model/CreatePaymentOrderRequest.js +17 -15
- package/dist/model/CreatePayoutRequest.js +35 -28
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateReportRequest.js +156 -0
- package/dist/model/CreateTopUpAddresses.js +139 -0
- package/dist/model/CreateTopUpAddresses201Response.js +107 -0
- package/dist/model/CreateWalletAddress.js +2 -2
- package/dist/model/DeleteCounterpartyById200Response.js +110 -0
- package/dist/model/DeleteCounterpartyEntry200Response.js +110 -0
- package/dist/model/DeleteDestinationById200Response.js +110 -0
- package/dist/model/DeleteDestinationEntry200Response.js +110 -0
- package/dist/model/EntryType.js +61 -0
- package/dist/model/GetCounterpartyEntry200Response.js +90 -0
- package/dist/model/GetDestinationEntry200Response.js +106 -0
- package/dist/model/{ListPayoutItems200Response.js → GetReports200Response.js} +22 -22
- package/dist/model/KyaRiskAssessment.js +151 -0
- package/dist/model/KyaRiskDetail.js +126 -0
- package/dist/model/KyaRiskLevel.js +66 -0
- package/dist/model/KyaScreeningRequest.js +154 -0
- package/dist/model/KyaScreeningResult.js +222 -0
- package/dist/model/KyaScreeningResultRiskAssessment.js +171 -0
- package/dist/model/KyaScreeningStatus.js +71 -0
- package/dist/model/KyaScreeningsEventData.js +174 -0
- package/dist/model/LinkDisplayInfo.js +1 -1
- package/dist/model/{ListAllocations200Response.js → ListAllocationItems200Response.js} +22 -22
- package/dist/model/ListBulkSendItems200Response.js +123 -0
- package/dist/model/ListCounterpartyEntries200Response.js +123 -0
- package/dist/model/ListDestinationEntries200Response.js +153 -0
- package/dist/model/ListKyaScreenings200Response.js +145 -0
- package/dist/model/MPCVaultEventData.js +13 -3
- package/dist/model/MerchantBalance.js +4 -4
- package/dist/model/Order.js +10 -10
- package/dist/model/OrderLinkBusinessInfo.js +22 -16
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +2 -4
- package/dist/model/OrderLinkBusinessInfoPayableAmountsInner.js +4 -4
- package/dist/model/PaymentAddressUpdateEventData.js +13 -3
- package/dist/model/PaymentAllocationAmount.js +2 -2
- package/dist/model/PaymentBulkSend.js +182 -0
- package/dist/model/PaymentBulkSendEvent.js +359 -0
- package/dist/model/PaymentBulkSendExecutionMode.js +61 -0
- package/dist/model/PaymentBulkSendItem.js +190 -0
- package/dist/model/{PaymentPayoutItemStatus.js → PaymentBulkSendItemStatus.js} +11 -11
- package/dist/model/PaymentBulkSendItemValidationStatus.js +66 -0
- package/dist/model/PaymentBulkSendStatus.js +81 -0
- package/dist/model/PaymentEstimateFeeRequest.js +13 -0
- package/dist/model/PaymentFeeType.js +15 -0
- package/dist/model/PaymentOrderEventData.js +31 -21
- package/dist/model/PaymentPayout.js +64 -46
- package/dist/model/PaymentPayoutDetail.js +166 -52
- package/dist/model/PaymentPayoutEvent.js +152 -80
- package/dist/model/PaymentPayoutItem.js +9 -166
- package/dist/model/PaymentPayoutParam.js +6 -46
- package/dist/model/PaymentPayoutRecipientInfo.js +126 -0
- package/dist/model/PaymentPayoutStatus.js +9 -4
- package/dist/model/PaymentRefundEventData.js +13 -3
- package/dist/model/PaymentSettlementEvent.js +13 -3
- package/dist/model/PaymentTransactionEventData.js +13 -3
- package/dist/model/PspBalance.js +4 -4
- package/dist/model/RefundLinkBusinessInfo.js +1 -1
- package/dist/model/Report.js +209 -0
- package/dist/model/ReportExportFormat.js +66 -0
- package/dist/model/ReportStatus.js +61 -0
- package/dist/model/ReportType.js +121 -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/TokensEventData.js +13 -3
- package/dist/model/TransactionCoboCategory.js +5 -0
- package/dist/model/TransactionExtraType.js +5 -0
- package/dist/model/TransactionWalletConnectInfo.js +146 -0
- package/dist/model/TransactionWebhookEventData.js +13 -3
- package/dist/model/TransferParams.js +2 -2
- package/dist/model/UpdateCounterpartyRequest.js +160 -0
- package/dist/model/UpdateDestinationEntry200Response.js +90 -0
- package/dist/model/UpdateDestinationEntryRequest.js +135 -0
- package/dist/model/UpdateDestinationRequest.js +173 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/WalletAddress.js +20 -2
- package/dist/model/WalletInfoEventData.js +13 -3
- package/dist/model/WebhookEventData.js +121 -28
- package/dist/model/WebhookEventDataType.js +12 -2
- package/dist/model/WebhookEventType.js +15 -0
- package/docs/AddressRiskLevel.md +16 -0
- package/docs/AddressesEventData.md +5 -1
- package/docs/AllocationItem.md +15 -0
- package/docs/AllocationParam.md +13 -0
- package/docs/AutoSweepApi.md +1 -1
- package/docs/BalanceUpdateInfoEventData.md +5 -1
- package/docs/BatchAllocation.md +2 -2
- package/docs/BatchAllocationDetail.md +1 -1
- package/docs/BridgingFee.md +2 -2
- package/docs/ChainsEventData.md +5 -1
- package/docs/CommissionFee.md +1 -1
- package/docs/ComplianceApi.md +163 -0
- package/docs/ComplianceDispositionUpdateEventData.md +5 -1
- package/docs/ComplianceKyaScreeningsUpdateEventData.md +64 -0
- package/docs/ComplianceKytScreeningsUpdateEventData.md +5 -1
- package/docs/ContractCallParams.md +2 -2
- package/docs/CounterpartyWalletAddressDetail.md +1 -1
- package/docs/CreateBatchAllocationRequest.md +2 -2
- package/docs/CreateBulkSendRequest.md +12 -0
- package/docs/CreateBulkSendRequestPayoutParamsInner.md +12 -0
- package/docs/CreateCounterpartyEntry201Response.md +10 -0
- package/docs/CreateCounterpartyEntryRequest.md +10 -0
- package/docs/CreateDestinationEntry201Response.md +11 -0
- package/docs/CreateDestinationEntryRequest.md +11 -0
- package/docs/CreateKyaScreeningsBody.md +9 -0
- package/docs/CreateMerchantRequest.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +11 -11
- package/docs/CreatePayoutRequest.md +4 -4
- package/docs/CreateRefundRequest.md +2 -2
- package/docs/CreateReportRequest.md +13 -0
- package/docs/CreateTopUpAddresses.md +11 -0
- package/docs/CreateTopUpAddresses201Response.md +9 -0
- package/docs/CreateWalletAddress.md +1 -1
- package/docs/DeleteCounterpartyById200Response.md +9 -0
- package/docs/DeleteCounterpartyEntry200Response.md +9 -0
- package/docs/DeleteDestinationById200Response.md +9 -0
- package/docs/DeleteDestinationEntry200Response.md +9 -0
- package/docs/EntryType.md +12 -0
- package/docs/FeeStationApi.md +1 -1
- package/docs/GetCounterpartyEntry200Response.md +9 -0
- package/docs/GetDestinationEntry200Response.md +10 -0
- package/docs/{ListAllocations200Response.md → GetReports200Response.md} +2 -2
- package/docs/GraphQLApi.md +61 -0
- package/docs/KyaRiskAssessment.md +11 -0
- package/docs/KyaRiskDetail.md +10 -0
- package/docs/KyaRiskLevel.md +14 -0
- package/docs/KyaScreeningRequest.md +12 -0
- package/docs/KyaScreeningResult.md +17 -0
- package/docs/KyaScreeningResultRiskAssessment.md +11 -0
- package/docs/KyaScreeningStatus.md +16 -0
- package/docs/KyaScreeningsEventData.md +14 -0
- package/docs/LinkDisplayInfo.md +1 -1
- package/docs/{ListPayoutItems200Response.md → ListAllocationItems200Response.md} +2 -2
- package/docs/ListBulkSendItems200Response.md +10 -0
- package/docs/ListCounterpartyEntries200Response.md +10 -0
- package/docs/ListDestinationEntries200Response.md +11 -0
- package/docs/ListKyaScreenings200Response.md +10 -0
- package/docs/MPCVaultEventData.md +5 -1
- package/docs/MerchantBalance.md +4 -4
- package/docs/Order.md +8 -8
- package/docs/OrderLinkBusinessInfo.md +11 -11
- package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +2 -2
- package/docs/OrderLinkBusinessInfoPayableAmountsInner.md +2 -2
- package/docs/PaymentAddressUpdateEventData.md +5 -1
- package/docs/PaymentAllocationAmount.md +1 -1
- package/docs/PaymentApi.md +1296 -198
- package/docs/PaymentBulkSend.md +15 -0
- package/docs/PaymentBulkSendEvent.md +65 -0
- package/docs/PaymentBulkSendExecutionMode.md +12 -0
- package/docs/PaymentBulkSendItem.md +15 -0
- package/docs/{PaymentPayoutItemStatus.md → PaymentBulkSendItemStatus.md} +3 -3
- package/docs/PaymentBulkSendItemValidationStatus.md +14 -0
- package/docs/PaymentBulkSendStatus.md +20 -0
- package/docs/PaymentEstimateFeeRequest.md +1 -0
- package/docs/PaymentFeeType.md +6 -0
- package/docs/PaymentOrderEventData.md +13 -9
- package/docs/PaymentPayout.md +8 -7
- package/docs/PaymentPayoutDetail.md +10 -8
- package/docs/PaymentPayoutEvent.md +15 -9
- package/docs/PaymentPayoutItem.md +2 -13
- package/docs/PaymentPayoutParam.md +1 -4
- package/docs/PaymentPayoutRecipientInfo.md +12 -0
- package/docs/PaymentPayoutStatus.md +4 -2
- package/docs/PaymentRefundEventData.md +5 -1
- package/docs/PaymentSettlementEvent.md +5 -1
- package/docs/PaymentTransactionEventData.md +5 -1
- package/docs/PspBalance.md +4 -4
- package/docs/RefundLinkBusinessInfo.md +1 -1
- package/docs/Report.md +17 -0
- package/docs/ReportExportFormat.md +14 -0
- package/docs/ReportStatus.md +12 -0
- package/docs/ReportType.md +36 -0
- package/docs/StakingsApi.md +1 -1
- package/docs/SuspendedTokenEventData.md +5 -1
- package/docs/SwapsApi.md +2 -0
- package/docs/TSSRequestWebhookEventData.md +5 -1
- package/docs/TokenListingEventData.md +5 -1
- package/docs/TokensEventData.md +5 -1
- package/docs/TransactionCoboCategory.md +2 -0
- package/docs/TransactionExtraType.md +2 -0
- package/docs/TransactionWalletConnectInfo.md +12 -0
- package/docs/TransactionWebhookEventData.md +5 -1
- package/docs/TransactionsApi.md +3 -3
- package/docs/TransferParams.md +1 -1
- package/docs/UpdateCounterpartyRequest.md +13 -0
- package/docs/UpdateDestinationEntry200Response.md +9 -0
- package/docs/UpdateDestinationEntryRequest.md +11 -0
- package/docs/UpdateDestinationRequest.md +14 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/WalletAddress.md +3 -1
- package/docs/WalletInfoEventData.md +5 -1
- package/docs/WalletsApi.md +9 -9
- package/docs/WebhookEventData.md +28 -18
- package/docs/WebhookEventDataType.md +5 -1
- package/docs/WebhookEventType.md +6 -0
- package/package.json +1 -1
- package/dist/model/PaymentPayoutItemDetail.js +0 -298
- package/docs/AllocationRecord.md +0 -15
- package/docs/AllocationRequest.md +0 -13
- package/docs/PaymentPayoutItemDetail.md +0 -22
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# CoboWaas2.ReportType
|
|
2
|
+
|
|
3
|
+
## Enum
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
* `Order` (value: `"Order"`)
|
|
7
|
+
|
|
8
|
+
* `OrderTransaction` (value: `"OrderTransaction"`)
|
|
9
|
+
|
|
10
|
+
* `TopUpTransaction` (value: `"TopUpTransaction"`)
|
|
11
|
+
|
|
12
|
+
* `PayinWeeklyStatement` (value: `"PayinWeeklyStatement"`)
|
|
13
|
+
|
|
14
|
+
* `PayinDailyStatement` (value: `"PayinDailyStatement"`)
|
|
15
|
+
|
|
16
|
+
* `CryptoPayout` (value: `"CryptoPayout"`)
|
|
17
|
+
|
|
18
|
+
* `OffRamp` (value: `"OffRamp"`)
|
|
19
|
+
|
|
20
|
+
* `Refund` (value: `"Refund"`)
|
|
21
|
+
|
|
22
|
+
* `PayoutWeeklyStatement` (value: `"PayoutWeeklyStatement"`)
|
|
23
|
+
|
|
24
|
+
* `PayoutDailyStatement` (value: `"PayoutDailyStatement"`)
|
|
25
|
+
|
|
26
|
+
* `PayinCommissionFee` (value: `"PayinCommissionFee"`)
|
|
27
|
+
|
|
28
|
+
* `PayoutCommissionFee` (value: `"PayoutCommissionFee"`)
|
|
29
|
+
|
|
30
|
+
* `BalanceChange` (value: `"BalanceChange"`)
|
|
31
|
+
|
|
32
|
+
* `Summary` (value: `"Summary"`)
|
|
33
|
+
|
|
34
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
35
|
+
|
|
36
|
+
|
package/docs/StakingsApi.md
CHANGED
|
@@ -86,7 +86,7 @@ Name | Type | Description | Notes
|
|
|
86
86
|
|
|
87
87
|
Expand Babylon BTC staking
|
|
88
88
|
|
|
89
|
-
This operation initiates a Babylon BTC staking expansion request. Before calling this operation, please ensure the following: - The BTC staking position is active. - The finality provider public keys are valid. Each BSN chain
|
|
89
|
+
This operation initiates a Babylon BTC staking expansion request. Before calling this operation, please ensure the following: - The BTC staking position is active. - The finality provider public keys are valid. Each BSN chain can have at most one finality provider public key. The system first checks whether the provided BTC staking position is active. If active, it creates a new BTC staking position for the Phase-3 expansion. The expansion is processed asynchronously and may take some time to complete. For more information, refer to [Babylon's official doc](https://github.com/babylonlabs-io/babylon/tree/main/docs).
|
|
90
90
|
|
|
91
91
|
### Example
|
|
92
92
|
|
|
@@ -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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**token_ids** | **String** | A list of token IDs, separated by comma. |
|
|
9
9
|
**operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
|
|
10
10
|
|
|
@@ -41,6 +41,8 @@ Name | Type | Description | Notes
|
|
|
41
41
|
|
|
42
42
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
43
43
|
|
|
44
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
45
|
+
|
|
44
46
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
45
47
|
|
|
46
48
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -49,6 +51,8 @@ Name | Type | Description | Notes
|
|
|
49
51
|
|
|
50
52
|
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
51
53
|
|
|
54
|
+
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
55
|
+
|
|
52
56
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
53
57
|
|
|
54
58
|
|
package/docs/SwapsApi.md
CHANGED
|
@@ -244,6 +244,7 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
244
244
|
// Call the API
|
|
245
245
|
const apiInstance = new CoboWaas2.SwapsApi();
|
|
246
246
|
const opts = {
|
|
247
|
+
'request_id': "web_send_by_user_327_1610444045047",
|
|
247
248
|
'type': new CoboWaas2.SwapType(),
|
|
248
249
|
'status': new CoboWaas2.SwapActivityStatus(),
|
|
249
250
|
'min_updated_timestamp': 1635744000000,
|
|
@@ -268,6 +269,7 @@ apiInstance.listSwapActivities(opts).then((data) => {
|
|
|
268
269
|
|
|
269
270
|
Name | Type | Description | Notes
|
|
270
271
|
------------- | ------------- | ------------- | -------------
|
|
272
|
+
**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]
|
|
271
273
|
**type** | [**SwapType**](.md)| | [optional]
|
|
272
274
|
**status** | [**SwapActivityStatus**](.md)| | [optional]
|
|
273
275
|
**min_updated_timestamp** | **Number**| The start time of the query. All swap activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [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. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings 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]
|
|
@@ -46,6 +46,8 @@ Name | Type | Description | Notes
|
|
|
46
46
|
|
|
47
47
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
48
48
|
|
|
49
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
50
|
+
|
|
49
51
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
50
52
|
|
|
51
53
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -54,6 +56,8 @@ Name | Type | Description | Notes
|
|
|
54
56
|
|
|
55
57
|
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
56
58
|
|
|
59
|
+
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
60
|
+
|
|
57
61
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
58
62
|
|
|
59
63
|
|
|
@@ -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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings 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. |
|
|
@@ -50,6 +50,8 @@ Name | Type | Description | Notes
|
|
|
50
50
|
|
|
51
51
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
52
52
|
|
|
53
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
54
|
+
|
|
53
55
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
54
56
|
|
|
55
57
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -58,6 +60,8 @@ Name | Type | Description | Notes
|
|
|
58
60
|
|
|
59
61
|
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
60
62
|
|
|
63
|
+
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
64
|
+
|
|
61
65
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
62
66
|
|
|
63
67
|
|
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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings 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]
|
|
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
42
42
|
|
|
43
43
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
44
44
|
|
|
45
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
46
|
+
|
|
45
47
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
46
48
|
|
|
47
49
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -50,6 +52,8 @@ Name | Type | Description | Notes
|
|
|
50
52
|
|
|
51
53
|
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
52
54
|
|
|
55
|
+
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
56
|
+
|
|
53
57
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
54
58
|
|
|
55
59
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TransactionWalletConnectInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**extra_type** | [**TransactionExtraType**](TransactionExtraType.md) | |
|
|
8
|
+
**dapp_name** | **String** | The dapp name that initiated this transaction. | [optional]
|
|
9
|
+
**dapp_domain** | **String** | The dapp domain that initiated this transaction | [optional]
|
|
10
|
+
**session_id** | **String** | The session id that initiated this transaction | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings 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]
|
|
@@ -70,6 +70,8 @@ Name | Type | Description | Notes
|
|
|
70
70
|
|
|
71
71
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
72
72
|
|
|
73
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
74
|
+
|
|
73
75
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
74
76
|
|
|
75
77
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -78,6 +80,8 @@ Name | Type | Description | Notes
|
|
|
78
80
|
|
|
79
81
|
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
80
82
|
|
|
83
|
+
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
84
|
+
|
|
81
85
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
82
86
|
|
|
83
87
|
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -30,7 +30,7 @@ Method | HTTP request | Description
|
|
|
30
30
|
|
|
31
31
|
Broadcast signed transactions
|
|
32
32
|
|
|
33
|
-
<Note>This operation is only applicable to the staking scenarios.</Note> This operation broadcasts a list of signed transactions. If you set `auto_broadcast` to `false` when [creating a staking activity](https://www.cobo.com/developers/v2/api-references/
|
|
33
|
+
<Note>This operation is only applicable to the staking scenarios.</Note> This operation broadcasts a list of signed transactions. If you set `auto_broadcast` to `false` when [creating a staking activity](https://www.cobo.com/developers/v2/api-references/stakings/create-stake-activity), the transaction will not be submitted to the blockchain automatically after being signed. In such cases, you can call this operation to broadcast the transaction to the blockchain. A transaction can only be broadcast if its status is `Broadcasting`.
|
|
34
34
|
|
|
35
35
|
### Example
|
|
36
36
|
|
|
@@ -186,7 +186,7 @@ Name | Type | Description | Notes
|
|
|
186
186
|
|
|
187
187
|
Call smart contract
|
|
188
188
|
|
|
189
|
-
This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. For smart contract call examples, you can refer to [Batch transfers using smart contracts](/v2/guides/transactions/batch-transfer) and [Swap tokens on Solana using Jupiter](/v2/guides/transactions/sol-jupiter-swap). <Info> Supported actions vary by blockchain: - EVM chains — Support deploying contracts and calling contract functions. - Solana — Supports calling contract functions only. - TRON — Supports calling contract functions only. - Stellar — Supports XLM trustline creation only. </Info> <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets. Refer to the `destination` property for supported contract types.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
|
|
189
|
+
This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. For smart contract call examples, you can refer to [Batch transfers using smart contracts](/v2/guides/transactions/batch-transfer) and [Swap tokens on Solana using Jupiter](/v2/guides/transactions/sol-jupiter-swap). <Note>This operation uses `request_id` to prevent duplicate contract call requests. The `request_id` must be unique within the same organization. Duplicate requests with the same `request_id` will be rejected with an error and will not be executed again.</Note> <Info> Supported actions vary by blockchain: - EVM chains — Support deploying contracts and calling contract functions. - Solana — Supports calling contract functions only. - TRON — Supports calling contract functions only. - Stellar — Supports XLM trustline creation only. - Cosmos — Supports initiating Cosmos native message-based transactions, such as transfers and staking operations. </Info> <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets. Refer to the `destination` property for supported contract types.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
|
|
190
190
|
|
|
191
191
|
### Example
|
|
192
192
|
|
|
@@ -290,7 +290,7 @@ Name | Type | Description | Notes
|
|
|
290
290
|
|
|
291
291
|
Transfer token
|
|
292
292
|
|
|
293
|
-
The operation transfers your assets from a wallet created on Cobo Portal to another address. You need to specify details such as the sender address and recipient address, token ID, and the amount to transfer. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>If you make transfers from Custodial Wallets (Asset Wallets) and Exchange Wallets, do not set the fee-related properties, as they will not take effects.</Note> <Note>You can transfer tokens to multiple addresses only if you use MPC Wallets as the transaction source. To do this, you should use the <code>utxo_outputs</code> property to specify the destination addresses.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
|
|
293
|
+
The operation transfers your assets from a wallet created on Cobo Portal to another address. You need to specify details such as the sender address and recipient address, token ID, and the amount to transfer. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>This operation uses `request_id` to prevent duplicate transfer requests. The `request_id` must be unique within the same organization. Duplicate requests with the same `request_id` will be rejected with an error and will not be executed again.</Note> <Note>If you make transfers from Custodial Wallets (Asset Wallets) and Exchange Wallets, do not set the fee-related properties, as they will not take effects.</Note> <Note>You can transfer tokens to multiple addresses only if you use MPC Wallets as the transaction source. To do this, you should use the <code>utxo_outputs</code> property to specify the destination addresses.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
|
|
294
294
|
|
|
295
295
|
### Example
|
|
296
296
|
|
package/docs/TransferParams.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**request_id** | **String** |
|
|
7
|
+
**request_id** | **String** | A client-defined unique request identifier (idempotency key) used to prevent duplicate transfer requests. It must be unique within the same organization. Requests with the same request ID will be rejected with an error. |
|
|
8
8
|
**source** | [**TransferSource**](TransferSource.md) | |
|
|
9
9
|
**token_id** | **String** | The token ID of the transferred 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). For transfers from Exchange Wallets, this property value represents the asset ID. |
|
|
10
10
|
**destination** | [**TransferDestination**](TransferDestination.md) | |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.UpdateCounterpartyRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**updated_counterparty_name** | **String** | The updated counterparty name. |
|
|
8
|
+
**updated_counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**updated_country** | **String** | The updated country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
10
|
+
**updated_email** | **String** | The updated email of the counterparty. | [optional]
|
|
11
|
+
**updated_contact_address** | **String** | The updated contact address of the counterparty. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.UpdateDestinationEntryRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**entry_type** | [**EntryType**](EntryType.md) | | [optional]
|
|
8
|
+
**destination_id** | **String** | The destination ID. |
|
|
9
|
+
**bank_account** | [**UpdateDestinationBankAccount**](UpdateDestinationBankAccount.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.UpdateDestinationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**updated_destination_name** | **String** | The updated destination name. |
|
|
8
|
+
**updated_destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**updated_merchant_id** | **String** | The updated ID of the merchant linked to the destination. | [optional]
|
|
10
|
+
**updated_country** | **String** | The updated country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**updated_email** | **String** | The updated email of the destination. | [optional]
|
|
12
|
+
**updated_contact_address** | **String** | The updated contact address of the destination. | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -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. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [
|
|
8
|
+
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances). | [optional]
|
|
9
9
|
|
|
10
10
|
|
package/docs/WalletAddress.md
CHANGED
|
@@ -6,7 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**wallet_address_id** | **String** | The wallet address ID. |
|
|
8
8
|
**address** | **String** | The wallet address. |
|
|
9
|
-
**chain_id** | **String** | The chain ID of the
|
|
9
|
+
**chain_id** | **String** | The chain ID of the address. |
|
|
10
|
+
**risk_level** | [**AddressRiskLevel**](AddressRiskLevel.md) | | [optional]
|
|
11
|
+
**screening_timestamp** | **Number** | UNIX timestamp (in seconds) when the address was last screened for compliance. | [optional]
|
|
10
12
|
**updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. |
|
|
11
13
|
|
|
12
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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -40,6 +40,8 @@ Name | Type | Description | Notes
|
|
|
40
40
|
|
|
41
41
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
42
42
|
|
|
43
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
44
|
+
|
|
43
45
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
44
46
|
|
|
45
47
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -48,6 +50,8 @@ Name | Type | Description | Notes
|
|
|
48
50
|
|
|
49
51
|
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
50
52
|
|
|
53
|
+
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
54
|
+
|
|
51
55
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
52
56
|
|
|
53
57
|
|
package/docs/WalletsApi.md
CHANGED
|
@@ -932,7 +932,7 @@ Name | Type | Description | Notes
|
|
|
932
932
|
------------- | ------------- | ------------- | -------------
|
|
933
933
|
**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]
|
|
934
934
|
**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]
|
|
935
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
935
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
936
936
|
**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]
|
|
937
937
|
**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]
|
|
938
938
|
|
|
@@ -994,9 +994,9 @@ Name | Type | Description | Notes
|
|
|
994
994
|
------------- | ------------- | ------------- | -------------
|
|
995
995
|
**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]
|
|
996
996
|
**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]
|
|
997
|
-
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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]
|
|
998
|
-
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID 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]
|
|
999
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
997
|
+
**chain_ids** | **String**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID 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]
|
|
998
|
+
**token_ids** | **String**| A list of token IDs(Supports up to 500), separated by comma. The token ID 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]
|
|
999
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
1000
1000
|
**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]
|
|
1001
1001
|
**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]
|
|
1002
1002
|
|
|
@@ -1057,8 +1057,8 @@ Name | Type | Description | Notes
|
|
|
1057
1057
|
------------- | ------------- | ------------- | -------------
|
|
1058
1058
|
**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]
|
|
1059
1059
|
**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]
|
|
1060
|
-
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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]
|
|
1061
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
1060
|
+
**chain_ids** | **String**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID 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]
|
|
1061
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
1062
1062
|
**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]
|
|
1063
1063
|
**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]
|
|
1064
1064
|
|
|
@@ -1120,9 +1120,9 @@ Name | Type | Description | Notes
|
|
|
1120
1120
|
------------- | ------------- | ------------- | -------------
|
|
1121
1121
|
**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]
|
|
1122
1122
|
**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]
|
|
1123
|
-
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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]
|
|
1124
|
-
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID 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]
|
|
1125
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
1123
|
+
**chain_ids** | **String**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID 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]
|
|
1124
|
+
**token_ids** | **String**| A list of token IDs(Supports up to 500), separated by comma. The token ID 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]
|
|
1125
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
1126
1126
|
**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]
|
|
1127
1127
|
**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]
|
|
1128
1128
|
|
package/docs/WebhookEventData.md
CHANGED
|
@@ -4,16 +4,16 @@
|
|
|
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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings 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 provided by you when creating the payout. |
|
|
11
11
|
**wallet_id** | **String** | For deposit transactions, this property represents the wallet ID of the transaction destination. For transactions of other types, this property represents the wallet ID of the transaction source. |
|
|
12
12
|
**type** | [**TransactionType**](TransactionType.md) | | [optional]
|
|
13
|
-
**status** | [**
|
|
13
|
+
**status** | [**KyaScreeningStatus**](KyaScreeningStatus.md) | |
|
|
14
14
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
15
15
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
16
|
-
**chain_id** | **String** | The chain
|
|
16
|
+
**chain_id** | **String** | The chain identifier. |
|
|
17
17
|
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
18
18
|
**asset_id** | **String** | (This concept applies to Exchange Wallets only) The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional]
|
|
19
19
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
@@ -29,13 +29,13 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**raw_tx_info** | [**TransactionRawTxInfo**](TransactionRawTxInfo.md) | | [optional]
|
|
30
30
|
**replacement** | [**TransactionReplacement**](TransactionReplacement.md) | | [optional]
|
|
31
31
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
32
|
-
**description** | **String** | The description for
|
|
32
|
+
**description** | **String** | The description for the entire bulk send batch. | [optional]
|
|
33
33
|
**is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer. | [optional]
|
|
34
34
|
**cobo_category** | **[String]** | The transaction category defined by Cobo. For more details, refer to [Cobo-defined categories](/v2/guides/transactions/manage-transactions#cobo-defined-categories). | [optional]
|
|
35
35
|
**extra** | **[String]** | A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\"). | [optional]
|
|
36
36
|
**fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
|
|
37
|
-
**created_timestamp** | **Number** | The
|
|
38
|
-
**updated_timestamp** | **Number** | The time when the
|
|
37
|
+
**created_timestamp** | **Number** | The time when the screening request was created, in Unix timestamp format, measured in milliseconds. |
|
|
38
|
+
**updated_timestamp** | **Number** | The time when the screening status 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]
|
|
@@ -53,7 +53,7 @@ Name | Type | Description | Notes
|
|
|
53
53
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
54
54
|
**token** | [**TokenInfo**](TokenInfo.md) | | [optional]
|
|
55
55
|
**feedback** | **String** | The feedback provided by Cobo when a token listing request is rejected. | [optional]
|
|
56
|
-
**address** | **String** | The
|
|
56
|
+
**address** | **String** | The screened blockchain address. |
|
|
57
57
|
**wallet_uuid** | **String** | The wallet ID. |
|
|
58
58
|
**balance** | [**Balance**](Balance.md) | |
|
|
59
59
|
**token_ids** | **String** | A list of token IDs, separated by comma. |
|
|
@@ -62,19 +62,19 @@ Name | Type | Description | Notes
|
|
|
62
62
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
63
63
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
|
|
64
64
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
65
|
-
**pricing_currency** | **String** | The
|
|
66
|
-
**pricing_amount** | **String** | The base amount of the order
|
|
67
|
-
**fee_amount** | **String** | The developer fee for the order
|
|
65
|
+
**pricing_currency** | **String** | The pricing currency of the order. | [optional]
|
|
66
|
+
**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). | [optional]
|
|
67
|
+
**fee_amount** | **String** | The developer fee for the order. It is added to the base amount to determine the final charge. |
|
|
68
68
|
**payable_currency** | **String** | The ID of the cryptocurrency used for payment. | [optional]
|
|
69
69
|
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
70
|
-
**exchange_rate** | **String** | The exchange rate between
|
|
71
|
-
**amount_tolerance** | **String** |
|
|
70
|
+
**exchange_rate** | **String** | The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`. <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note> |
|
|
71
|
+
**amount_tolerance** | **String** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional]
|
|
72
72
|
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
73
73
|
**received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
|
74
74
|
**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional]
|
|
75
|
-
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions
|
|
76
|
-
**currency** | **String** | The fiat currency for the
|
|
77
|
-
**order_amount** | **String** |
|
|
75
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional]
|
|
76
|
+
**currency** | **String** | The fiat currency for the off-ramp. | [optional]
|
|
77
|
+
**order_amount** | **String** | This field has been deprecated. Please use `pricing_amount` instead. | [optional]
|
|
78
78
|
**settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
79
79
|
**refund_id** | **String** | The refund order ID. |
|
|
80
80
|
**amount** | **String** | The amount in cryptocurrency to be returned for this refund order. |
|
|
@@ -87,7 +87,7 @@ Name | Type | Description | Notes
|
|
|
87
87
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
|
|
88
88
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
89
89
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
|
|
90
|
-
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
90
|
+
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
91
91
|
**settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
|
|
92
92
|
**received_amount_fiat** | **String** | The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. | [optional]
|
|
93
93
|
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
@@ -97,8 +97,13 @@ Name | Type | Description | Notes
|
|
|
97
97
|
**previous_address** | **String** | The previous top-up address that was assigned to the payer. |
|
|
98
98
|
**updated_address** | **String** | The new top-up address that has been assigned to the payer. |
|
|
99
99
|
**payout_id** | **String** | The payout ID generated by Cobo. |
|
|
100
|
-
**
|
|
101
|
-
**
|
|
100
|
+
**source_account** | **String** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. |
|
|
101
|
+
**payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
|
|
102
|
+
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
103
|
+
**actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
|
|
104
|
+
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
105
|
+
**bulk_send_id** | **String** | The bulk send ID. |
|
|
106
|
+
**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | |
|
|
102
107
|
**disposition_type** | [**DispositionType**](DispositionType.md) | |
|
|
103
108
|
**disposition_status** | [**DispositionStatus**](DispositionStatus.md) | |
|
|
104
109
|
**destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional]
|
|
@@ -106,6 +111,7 @@ Name | Type | Description | Notes
|
|
|
106
111
|
**transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) | |
|
|
107
112
|
**review_status** | [**ReviewStatusType**](ReviewStatusType.md) | |
|
|
108
113
|
**funds_status** | [**FundsStatusType**](FundsStatusType.md) | |
|
|
114
|
+
**screening_id** | **String** | The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). |
|
|
109
115
|
|
|
110
116
|
|
|
111
117
|
|
|
@@ -140,6 +146,8 @@ Name | Type | Description | Notes
|
|
|
140
146
|
|
|
141
147
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
142
148
|
|
|
149
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
150
|
+
|
|
143
151
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
144
152
|
|
|
145
153
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -148,6 +156,8 @@ Name | Type | Description | Notes
|
|
|
148
156
|
|
|
149
157
|
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
150
158
|
|
|
159
|
+
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
160
|
+
|
|
151
161
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
152
162
|
|
|
153
163
|
|