@cobo/cobo-waas2 1.26.0 → 1.28.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 +96 -4
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +2 -2
- package/dist/api/AutoSweepApi.js +4 -4
- package/dist/api/DevelopersWebhooksApi.js +2 -2
- package/dist/api/OAuthApi.js +4 -4
- package/dist/api/PaymentApi.js +1847 -294
- package/dist/api/StakingsApi.js +44 -2
- package/dist/api/SwapsApi.js +2 -2
- package/dist/api/TransactionsApi.js +6 -6
- package/dist/api/WalletsApi.js +14 -14
- package/dist/index.js +420 -7
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/AllocationRecord.js +193 -0
- package/dist/model/AllocationRequest.js +167 -0
- package/dist/model/BabylonCreateStakingExpansion.js +157 -0
- package/dist/model/BabylonStakeExtra.js +26 -0
- package/dist/model/BabylonStakingRegistration.js +1 -1
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/BankAccountStatus.js +66 -0
- package/dist/model/BatchAllocation.js +190 -0
- package/dist/model/BatchAllocationDetail.js +188 -0
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +8 -3
- package/dist/model/ContractCallDestination.js +72 -10
- package/dist/model/ContractCallDestinationType.js +10 -0
- package/dist/model/CosmosContractCallDestination.js +0 -13
- package/dist/model/Counterparty.js +195 -0
- package/dist/model/CounterpartyDetail.js +228 -0
- package/dist/model/CounterpartyType.js +61 -0
- package/dist/model/CounterpartyWalletAddressDetail.js +192 -0
- package/dist/model/CreateBatchAllocationRequest.js +142 -0
- package/dist/model/CreateCounterpartyRequest.js +193 -0
- package/dist/model/CreateCounterpartyWalletAddressRequest.js +140 -0
- package/dist/model/CreateCustodialWalletParams.js +1 -1
- package/dist/model/CreateDestinationBankAccount.js +257 -0
- package/dist/model/CreateDestinationBankAccountRequest.js +272 -0
- package/dist/model/CreateDestinationRequest.js +235 -0
- package/dist/model/CreateDestinationWalletAddressRequest.js +140 -0
- package/dist/model/CreateExchangeWalletParams.js +2 -2
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreateMerchantRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreatePaymentOrderRequest.js +115 -68
- package/dist/model/CreatePayoutRequest.js +192 -0
- package/dist/model/CreateRefundRequest.js +3 -3
- package/dist/model/CreateSafeWalletParams.js +1 -1
- package/dist/model/CreateSettlement.js +14 -1
- package/dist/model/CreateSettlementRequestRequest.js +1 -1
- package/dist/model/CreateSmartContractWalletParams.js +1 -1
- package/dist/model/CreateStakeActivityExtra.js +12 -0
- package/dist/model/{ReceivedAmountPerAddress.js → CreateWalletAddress.js} +31 -32
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/DeleteCounterparty200Response.js +110 -0
- package/dist/model/DeleteCounterpartyWalletAddress200Response.js +110 -0
- package/dist/model/DeleteDestination200Response.js +110 -0
- package/dist/model/DeleteDestinationBankAccount200Response.js +110 -0
- package/dist/model/DeleteDestinationWalletAddress200Response.js +110 -0
- package/dist/model/Destination.js +208 -0
- package/dist/model/DestinationBankAccount.js +301 -0
- package/dist/model/DestinationBankAccountDetail.js +394 -0
- package/dist/model/DestinationDetail.js +272 -0
- package/dist/model/DestinationType.js +61 -0
- package/dist/model/DestinationWalletAddressDetail.js +205 -0
- package/dist/model/EnableDestinationWhitelistRequest.js +106 -0
- package/dist/model/EvmContractCallDestination.js +2 -2
- package/dist/model/ExchangeRate.js +140 -0
- package/dist/model/GetExchangeRate200Response.js +2 -2
- package/dist/model/IntermediaryBankInfo.js +140 -0
- package/dist/model/Link.js +4 -4
- package/dist/model/LinkDisplayInfo.js +15 -2
- package/dist/model/ListAllocations200Response.js +123 -0
- package/dist/model/ListBatchAllocations200Response.js +123 -0
- package/dist/model/ListCounterparties200Response.js +123 -0
- package/dist/model/ListCounterpartyWalletAddress200Response.js +123 -0
- package/dist/model/ListDestinationBankAccounts200Response.js +123 -0
- package/dist/model/ListDestinationWalletAddresses200Response.js +123 -0
- package/dist/model/ListDestinations200Response.js +123 -0
- package/dist/model/ListPayoutItems200Response.js +123 -0
- package/dist/model/ListPayouts200Response.js +123 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/MerchantBalance.js +28 -2
- package/dist/model/Order.js +135 -102
- package/dist/model/OrderLinkBusinessInfo.js +151 -87
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +4 -4
- package/dist/model/OrderLinkBusinessInfoPayableAmountsInner.js +125 -0
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentAllocationAmount.js +125 -0
- package/dist/model/PaymentOrderEventData.js +198 -145
- package/dist/model/PaymentPayout.js +250 -0
- package/dist/model/PaymentPayoutDetail.js +248 -0
- package/dist/model/PaymentPayoutEvent.js +433 -0
- package/dist/model/PaymentPayoutItem.js +298 -0
- package/dist/model/PaymentPayoutItemDetail.js +298 -0
- package/dist/model/PaymentPayoutItemStatus.js +76 -0
- package/dist/model/PaymentPayoutParam.js +165 -0
- package/dist/model/PaymentPayoutStatus.js +81 -0
- package/dist/model/PaymentRefundEventData.js +8 -3
- package/dist/model/PaymentSettlementEvent.js +8 -3
- package/dist/model/PaymentSourceType.js +61 -0
- package/dist/model/PaymentTransaction.js +32 -0
- package/dist/model/PaymentTransactionEventData.js +10 -5
- package/dist/model/PspBalance.js +28 -2
- package/dist/model/QueryDestinationWhitelistEnabled200Response.js +106 -0
- package/dist/model/RefundLinkBusinessInfo.js +6 -6
- package/dist/model/SettlementDetail.js +13 -0
- package/dist/model/Stakings.js +33 -6
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/SwapActivity.js +1 -1
- package/dist/model/SwapActivityDetail.js +2 -2
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/Transaction.js +1 -1
- package/dist/model/TransactionCosmosContractDestination.js +0 -13
- package/dist/model/TransactionDestination.js +38 -10
- package/dist/model/TransactionDestinationType.js +5 -0
- package/dist/model/TransactionDetail.js +2 -2
- package/dist/model/TransactionDetails.js +2 -2
- package/dist/model/TransactionTronContractDestination.js +150 -0
- package/dist/model/TransactionWebhookEventData.js +10 -5
- package/dist/model/TronContractCallDestination.js +150 -0
- package/dist/model/UpdateCounterpartyByIdRequest.js +160 -0
- package/dist/model/UpdateDestinationBankAccount.js +257 -0
- package/dist/model/UpdateDestinationByIdRequest.js +173 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/WalletAddress.js +151 -0
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEventData.js +107 -43
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +10 -0
- package/docs/AddressBooksApi.md +1 -1
- package/docs/AddressesEventData.md +3 -1
- package/docs/AllocationRecord.md +15 -0
- package/docs/AllocationRequest.md +13 -0
- package/docs/AutoSweepApi.md +2 -2
- package/docs/BabylonCreateStakingExpansion.md +12 -0
- package/docs/BabylonStakeExtra.md +2 -0
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/BankAccountStatus.md +14 -0
- package/docs/BatchAllocation.md +14 -0
- package/docs/BatchAllocationDetail.md +14 -0
- package/docs/ChainsEventData.md +3 -1
- package/docs/ComplianceDispositionUpdateEventData.md +3 -1
- package/docs/ComplianceKytScreeningsUpdateEventData.md +3 -1
- package/docs/ContractCallDestination.md +3 -2
- package/docs/ContractCallDestinationType.md +4 -0
- package/docs/CosmosContractCallDestination.md +0 -1
- package/docs/Counterparty.md +16 -0
- package/docs/CounterpartyDetail.md +17 -0
- package/docs/CounterpartyType.md +12 -0
- package/docs/CounterpartyWalletAddressDetail.md +15 -0
- package/docs/CreateBatchAllocationRequest.md +10 -0
- package/docs/CreateCounterpartyRequest.md +14 -0
- package/docs/CreateCounterpartyWalletAddressRequest.md +11 -0
- package/docs/CreateCustodialWalletParams.md +1 -1
- package/docs/CreateDestinationBankAccount.md +19 -0
- package/docs/CreateDestinationBankAccountRequest.md +20 -0
- package/docs/CreateDestinationRequest.md +16 -0
- package/docs/CreateDestinationWalletAddressRequest.md +11 -0
- package/docs/CreateExchangeWalletParams.md +1 -1
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMerchantRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +15 -11
- package/docs/CreatePayoutRequest.md +14 -0
- package/docs/CreateRefundRequest.md +3 -3
- package/docs/CreateSafeWalletParams.md +1 -1
- package/docs/CreateSettlement.md +2 -1
- package/docs/CreateSettlementRequestRequest.md +1 -1
- package/docs/CreateSmartContractWalletParams.md +1 -1
- package/docs/CreateStakeActivityExtra.md +2 -0
- package/docs/CreateWalletAddress.md +10 -0
- package/docs/CreateWalletParams.md +1 -1
- package/docs/DeleteCounterparty200Response.md +9 -0
- package/docs/DeleteCounterpartyWalletAddress200Response.md +9 -0
- package/docs/DeleteDestination200Response.md +9 -0
- package/docs/DeleteDestinationBankAccount200Response.md +9 -0
- package/docs/DeleteDestinationWalletAddress200Response.md +9 -0
- package/docs/Destination.md +17 -0
- package/docs/DestinationBankAccount.md +23 -0
- package/docs/DestinationBankAccountDetail.md +30 -0
- package/docs/DestinationDetail.md +19 -0
- package/docs/DestinationType.md +12 -0
- package/docs/DestinationWalletAddressDetail.md +16 -0
- package/docs/DevelopersWebhooksApi.md +1 -1
- package/docs/EnableDestinationWhitelistRequest.md +9 -0
- package/docs/EvmContractCallDestination.md +1 -1
- package/docs/ExchangeRate.md +11 -0
- package/docs/GetExchangeRate200Response.md +1 -1
- package/docs/IntermediaryBankInfo.md +11 -0
- package/docs/Link.md +2 -2
- package/docs/LinkDisplayInfo.md +3 -2
- package/docs/ListAllocations200Response.md +10 -0
- package/docs/ListBatchAllocations200Response.md +10 -0
- package/docs/ListCounterparties200Response.md +10 -0
- package/docs/ListCounterpartyWalletAddress200Response.md +10 -0
- package/docs/ListDestinationBankAccounts200Response.md +10 -0
- package/docs/ListDestinationWalletAddresses200Response.md +10 -0
- package/docs/ListDestinations200Response.md +10 -0
- package/docs/ListPayoutItems200Response.md +10 -0
- package/docs/ListPayouts200Response.md +10 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/MerchantBalance.md +4 -2
- package/docs/OAuthApi.md +2 -2
- package/docs/Order.md +16 -13
- package/docs/OrderLinkBusinessInfo.md +11 -7
- package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +2 -2
- package/docs/OrderLinkBusinessInfoPayableAmountsInner.md +10 -0
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentAllocationAmount.md +10 -0
- package/docs/PaymentApi.md +2153 -395
- package/docs/PaymentOrderEventData.md +19 -14
- package/docs/PaymentPayout.md +19 -0
- package/docs/PaymentPayoutDetail.md +19 -0
- package/docs/PaymentPayoutEvent.md +65 -0
- package/docs/PaymentPayoutItem.md +22 -0
- package/docs/PaymentPayoutItemDetail.md +22 -0
- package/docs/PaymentPayoutItemStatus.md +18 -0
- package/docs/PaymentPayoutParam.md +13 -0
- package/docs/PaymentPayoutStatus.md +20 -0
- package/docs/PaymentRefundEventData.md +3 -1
- package/docs/PaymentSettlementEvent.md +3 -1
- package/docs/PaymentSourceType.md +12 -0
- package/docs/PaymentTransaction.md +2 -0
- package/docs/PaymentTransactionEventData.md +4 -2
- package/docs/PspBalance.md +4 -2
- package/docs/QueryDestinationWhitelistEnabled200Response.md +9 -0
- package/docs/RefundLinkBusinessInfo.md +4 -4
- package/docs/SettlementDetail.md +1 -0
- package/docs/Stakings.md +2 -1
- package/docs/StakingsApi.md +54 -1
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/SwapActivity.md +1 -1
- package/docs/SwapActivityDetail.md +1 -1
- package/docs/SwapsApi.md +1 -1
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokensEventData.md +3 -1
- package/docs/Transaction.md +1 -1
- package/docs/TransactionCosmosContractDestination.md +0 -1
- package/docs/TransactionDestination.md +2 -2
- package/docs/TransactionDestinationType.md +2 -0
- package/docs/TransactionDetail.md +1 -1
- package/docs/TransactionDetails.md +1 -1
- package/docs/TransactionTronContractDestination.md +12 -0
- package/docs/TransactionWebhookEventData.md +4 -2
- package/docs/TransactionsApi.md +3 -3
- package/docs/TronContractCallDestination.md +12 -0
- package/docs/UpdateCounterpartyByIdRequest.md +13 -0
- package/docs/UpdateDestinationBankAccount.md +19 -0
- package/docs/UpdateDestinationByIdRequest.md +14 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/WalletAddress.md +12 -0
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletsApi.md +7 -7
- package/docs/WebhookEventData.md +22 -14
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +4 -0
- package/package.json +1 -1
- package/docs/ReceivedAmountPerAddress.md +0 -10
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. - `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. - `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. |
|
|
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]
|
|
@@ -40,6 +40,8 @@ Name | Type | Description | Notes
|
|
|
40
40
|
|
|
41
41
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
42
42
|
|
|
43
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
44
|
+
|
|
43
45
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
44
46
|
|
|
45
47
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/Transaction.md
CHANGED
|
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
31
31
|
**description** | **String** | The description for your transaction. | [optional]
|
|
32
32
|
**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]
|
|
33
|
-
**cobo_category** | **[String]** | The transaction category defined by Cobo.
|
|
33
|
+
**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]
|
|
34
34
|
**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]
|
|
35
35
|
**fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
|
|
36
36
|
**created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. |
|
|
@@ -6,6 +6,5 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) | |
|
|
8
8
|
**cosmos_messages** | [**[TransactionCosmosMessage]**](TransactionCosmosMessage.md) | |
|
|
9
|
-
**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
|
|
10
9
|
|
|
11
10
|
|
|
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**exchange_id** | [**ExchangeId**](ExchangeId.md) | | [optional]
|
|
16
16
|
**amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. |
|
|
17
17
|
**address** | **String** | The destination address. |
|
|
18
|
-
**value** | **String** | The transfer amount. For example, if you trade 1.5
|
|
19
|
-
**calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address
|
|
18
|
+
**value** | **String** | The transfer amount. For example, if you trade 1.5 TRX, then the value is `1.5`. | [optional]
|
|
19
|
+
**calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
|
|
20
20
|
**calldata_info** | [**TransactionEvmCalldataInfo**](TransactionEvmCalldataInfo.md) | | [optional]
|
|
21
21
|
**instructions** | [**[TransactionSolContractInstruction]**](TransactionSolContractInstruction.md) | | [optional]
|
|
22
22
|
**address_lookup_table_accounts** | [**[TransactionSolContractAddressLookupTableAccount]**](TransactionSolContractAddressLookupTableAccount.md) | | [optional]
|
|
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
31
31
|
**description** | **String** | The description for your transaction. | [optional]
|
|
32
32
|
**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]
|
|
33
|
-
**cobo_category** | **[String]** | The transaction category defined by Cobo.
|
|
33
|
+
**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]
|
|
34
34
|
**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]
|
|
35
35
|
**fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
|
|
36
36
|
**created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. |
|
|
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
31
31
|
**description** | **String** | The description for your transaction. | [optional]
|
|
32
32
|
**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]
|
|
33
|
-
**cobo_category** | **[String]** | The transaction category defined by Cobo.
|
|
33
|
+
**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]
|
|
34
34
|
**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]
|
|
35
35
|
**fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
|
|
36
36
|
**created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. |
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TransactionTronContractDestination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) | |
|
|
8
|
+
**address** | **String** | The destination address. |
|
|
9
|
+
**value** | **String** | The transfer amount. For example, if you trade 1.5 TRX, then the value is `1.5`. | [optional]
|
|
10
|
+
**calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
|
|
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. - `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. - `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. |
|
|
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]
|
|
@@ -31,7 +31,7 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
32
32
|
**description** | **String** | The description for your transaction. | [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
|
-
**cobo_category** | **[String]** | The transaction category defined by Cobo.
|
|
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
37
|
**created_timestamp** | **Number** | The time when the transaction was created, in Unix timestamp format, measured in milliseconds. |
|
|
@@ -68,6 +68,8 @@ Name | Type | Description | Notes
|
|
|
68
68
|
|
|
69
69
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
70
70
|
|
|
71
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
72
|
+
|
|
71
73
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
72
74
|
|
|
73
75
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -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. <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets
|
|
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>
|
|
190
190
|
|
|
191
191
|
### Example
|
|
192
192
|
|
|
@@ -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 supports message signing transactions from the following wallets and chains: - MPC Wallets: BTC, EVM-compatible chains, and Cosmos. - Web3 Wallets: EVM-compatible chains. </Note>
|
|
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, and Cosmos. - Custodial Wallets (Web3 Wallets): EVM-compatible chains. </Note>
|
|
242
242
|
|
|
243
243
|
### Example
|
|
244
244
|
|
|
@@ -342,7 +342,7 @@ Name | Type | Description | Notes
|
|
|
342
342
|
|
|
343
343
|
Drop transaction
|
|
344
344
|
|
|
345
|
-
This operation drops a specified transaction. Dropping a transaction leverages RBF to replace the original transaction with a version that effectively cancels it. For more details about dropping a transaction, refer to [Drop a transaction](https://www.cobo.com/developers/v2/guides/transactions/manage-transactions#drop-a-transaction). A transaction can be
|
|
345
|
+
This operation drops a specified transaction. Dropping a transaction leverages RBF to replace the original transaction with a version that effectively cancels it. For more details about dropping a transaction, refer to [Drop a transaction](https://www.cobo.com/developers/v2/guides/transactions/manage-transactions#drop-a-transaction). A transaction can be dropped only if its status is `Broadcasting`. <Note>This operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets and Smart Contract Wallets. It does not apply to transactions on the following chains: VET, TRON, TVET, SOL, and TON.</Note> You can use the `address` or `included_utxos` properties in the request body to specify the address or UTXOs that will cover the transaction fee. Generally, the transaction fee is paid by the original transaction's source. If that source's balance is insufficient, the specified address or UTXOs can be used to cover the fee.
|
|
346
346
|
|
|
347
347
|
### Example
|
|
348
348
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TronContractCallDestination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
|
+
**address** | **String** | The destination address. |
|
|
9
|
+
**value** | **String** | The transfer amount. For example, if you trade 1.5 TRX, then the value is `1.5`. | [optional]
|
|
10
|
+
**calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.UpdateCounterpartyByIdRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_name** | **String** | The counterparty name. |
|
|
8
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**country** | **String** | The country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
10
|
+
**email** | **String** | The email of the counterparty. | [optional]
|
|
11
|
+
**contact_address** | **String** | The contact address of the counterparty. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CoboWaas2.UpdateDestinationBankAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**account_alias** | **String** | The alias of the bank account. |
|
|
8
|
+
**account_number** | **String** | The bank account number. |
|
|
9
|
+
**swift_code** | **String** | The SWIFT or BIC code of the bank. |
|
|
10
|
+
**currency** | **String** | The currency of the bank account. |
|
|
11
|
+
**beneficiary_name** | **String** | The name of the account holder. |
|
|
12
|
+
**beneficiary_address** | **String** | The address of the account holder. |
|
|
13
|
+
**bank_name** | **String** | The name of the bank. |
|
|
14
|
+
**bank_address** | **String** | The address of the bank. |
|
|
15
|
+
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
16
|
+
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
17
|
+
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.UpdateDestinationByIdRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_name** | **String** | The destination name. |
|
|
8
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
10
|
+
**country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the destination. | [optional]
|
|
12
|
+
**contact_address** | **String** | The 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 [Funds allocation and balances](https://www.cobo.com/
|
|
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 [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances). | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.WalletAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**wallet_address_id** | **String** | The wallet address ID. |
|
|
8
|
+
**address** | **String** | The wallet address. |
|
|
9
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
10
|
+
**updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. |
|
|
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. - `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. - `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. |
|
|
8
8
|
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -38,6 +38,8 @@ Name | Type | Description | Notes
|
|
|
38
38
|
|
|
39
39
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
40
40
|
|
|
41
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
42
|
+
|
|
41
43
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
42
44
|
|
|
43
45
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/WalletsApi.md
CHANGED
|
@@ -42,7 +42,7 @@ Method | HTTP request | Description
|
|
|
42
42
|
|
|
43
43
|
Batch check UTXOs
|
|
44
44
|
|
|
45
|
-
This operation verifies the existence and details of specified unspent transaction outputs (UTXOs) for a given wallet and token. A maximum of 100 UTXOs can be verified per request.
|
|
45
|
+
This operation verifies the existence and details of specified **unspent** transaction outputs (UTXOs) for a given wallet and token. A maximum of 100 UTXOs can be verified per request. <Note>This operation returns only UTXOs that are not used by any transaction. It does not return all UTXOs.</Note> <Info>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</Info>
|
|
46
46
|
|
|
47
47
|
### Example
|
|
48
48
|
|
|
@@ -772,7 +772,7 @@ Name | Type | Description | Notes
|
|
|
772
772
|
|
|
773
773
|
List address balances by token
|
|
774
774
|
|
|
775
|
-
This operation retrieves a list of address balances for a specified token within a wallet. <Note>This operation is applicable to MPC Wallets only.</Note>
|
|
775
|
+
This operation retrieves a list of address balances for a specified token within a wallet. <Note>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</Note>
|
|
776
776
|
|
|
777
777
|
### Example
|
|
778
778
|
|
|
@@ -1146,7 +1146,7 @@ Name | Type | Description | Notes
|
|
|
1146
1146
|
|
|
1147
1147
|
List token balances by address
|
|
1148
1148
|
|
|
1149
|
-
The operation retrieves a list of token balances for a specified address within a wallet. <Note>This operation is applicable to MPC Wallets and Smart Contract Wallets only.</Note>
|
|
1149
|
+
The operation retrieves a list of token balances for a specified address within a wallet. <Note>This operation is applicable to MPC Wallets, Custodial Wallets (Web3 Wallets), and Smart Contract Wallets only.</Note>
|
|
1150
1150
|
|
|
1151
1151
|
### Example
|
|
1152
1152
|
|
|
@@ -1326,7 +1326,7 @@ Name | Type | Description | Notes
|
|
|
1326
1326
|
|
|
1327
1327
|
List UTXOs
|
|
1328
1328
|
|
|
1329
|
-
The operation retrieves a list of unspent transaction outputs (UTXOs) for a specified wallet and token. <Note>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</
|
|
1329
|
+
The operation retrieves a list of **unspent** transaction outputs (UTXOs) for a specified wallet and token. <Note>This operation returns only UTXOs that are not used by any transaction. It does not return all UTXOs.</Note> <Info>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</Info>
|
|
1330
1330
|
|
|
1331
1331
|
### Example
|
|
1332
1332
|
|
|
@@ -1364,7 +1364,7 @@ Name | Type | Description | Notes
|
|
|
1364
1364
|
------------- | ------------- | ------------- | -------------
|
|
1365
1365
|
**wallet_id** | **String**| The wallet ID. |
|
|
1366
1366
|
**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). |
|
|
1367
|
-
**address** | **String**|
|
|
1367
|
+
**address** | **String**| | [optional]
|
|
1368
1368
|
**tx_hash** | **String**| | [optional]
|
|
1369
1369
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1370
1370
|
**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]
|
|
@@ -1454,7 +1454,7 @@ Name | Type | Description | Notes
|
|
|
1454
1454
|
|
|
1455
1455
|
Lock UTXOs
|
|
1456
1456
|
|
|
1457
|
-
This operation locks the UTXOs with specified transaction hashes. Locked UTXOs cannot be transferred until unlocked. <Note>This operation is applicable to MPC Wallets only.</Note>
|
|
1457
|
+
This operation locks the UTXOs with specified transaction hashes. Locked UTXOs cannot be transferred until unlocked. <Note>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</Note>
|
|
1458
1458
|
|
|
1459
1459
|
### Example
|
|
1460
1460
|
|
|
@@ -1564,7 +1564,7 @@ Name | Type | Description | Notes
|
|
|
1564
1564
|
|
|
1565
1565
|
Unlock UTXOs
|
|
1566
1566
|
|
|
1567
|
-
This operation unlocks the UTXOs with specified transaction hashes. Locked UTXOs cannot be transferred until unlocked.
|
|
1567
|
+
This operation unlocks the UTXOs with specified transaction hashes. Locked UTXOs cannot be transferred until unlocked. <Note>This operation is applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) only.</Note>
|
|
1568
1568
|
|
|
1569
1569
|
### Example
|
|
1570
1570
|
|
package/docs/WebhookEventData.md
CHANGED
|
@@ -4,13 +4,13 @@
|
|
|
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. - `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. - `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. |
|
|
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
|
-
**request_id** | **String** | The request ID
|
|
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** | [**PaymentPayoutStatus**](PaymentPayoutStatus.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
16
|
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). |
|
|
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
21
21
|
**result** | [**TransactionResult**](TransactionResult.md) | | [optional]
|
|
22
22
|
**fee** | [**TransactionFee**](TransactionFee.md) | | [optional]
|
|
23
|
-
**initiator** | **String** | The
|
|
23
|
+
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
24
24
|
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | |
|
|
25
25
|
**confirmed_num** | **Number** | The number of confirmations this transaction has received. | [optional]
|
|
26
26
|
**confirming_threshold** | **Number** | The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. | [optional]
|
|
@@ -31,10 +31,10 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
32
32
|
**description** | **String** | The description for your transaction. | [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
|
-
**cobo_category** | **[String]** | The transaction category defined by Cobo.
|
|
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 time
|
|
37
|
+
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
38
38
|
**updated_timestamp** | **Number** | The time when the KYT screening information 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]
|
|
@@ -60,19 +60,22 @@ Name | Type | Description | Notes
|
|
|
60
60
|
**operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
|
|
61
61
|
**order_id** | **String** | The pay-in order ID. |
|
|
62
62
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
63
|
-
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
64
|
-
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
65
|
-
**currency** | **String** | The fiat currency for the off-ramp. |
|
|
66
|
-
**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). |
|
|
67
|
-
**fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. |
|
|
68
|
-
**exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
|
|
69
|
-
**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional]
|
|
70
63
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
|
|
71
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 fiat currency of the order. | [optional]
|
|
66
|
+
**pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional]
|
|
67
|
+
**fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. |
|
|
68
|
+
**payable_currency** | **String** | The ID of the cryptocurrency used for payment. | [optional]
|
|
69
|
+
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
70
|
+
**exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
|
|
71
|
+
**amount_tolerance** | **String** | Allowed amount deviation. | [optional]
|
|
72
|
+
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
72
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
|
+
**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional]
|
|
73
75
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional]
|
|
76
|
+
**currency** | **String** | The fiat currency for the payout. | [optional]
|
|
77
|
+
**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional]
|
|
74
78
|
**settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
75
|
-
**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur. When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`. | [optional]
|
|
76
79
|
**refund_id** | **String** | The refund order ID. |
|
|
77
80
|
**amount** | **String** | The amount in cryptocurrency to be returned for this refund order. |
|
|
78
81
|
**to_address** | **String** | The recipient's wallet address where the refund will be sent. |
|
|
@@ -93,6 +96,9 @@ Name | Type | Description | Notes
|
|
|
93
96
|
**chain** | **String** | The chain ID. |
|
|
94
97
|
**previous_address** | **String** | The previous top-up address that was assigned to the payer. |
|
|
95
98
|
**updated_address** | **String** | The new top-up address that has been assigned to the payer. |
|
|
99
|
+
**payout_id** | **String** | The payout ID generated by Cobo. |
|
|
100
|
+
**payout_item_details** | [**[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) | | [optional]
|
|
101
|
+
**actual_payout_amount** | **String** | The actual amount of this payout. | [optional]
|
|
96
102
|
**disposition_type** | [**DispositionType**](DispositionType.md) | |
|
|
97
103
|
**disposition_status** | [**DispositionStatus**](DispositionStatus.md) | |
|
|
98
104
|
**destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional]
|
|
@@ -132,6 +138,8 @@ Name | Type | Description | Notes
|
|
|
132
138
|
|
|
133
139
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
134
140
|
|
|
141
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
142
|
+
|
|
135
143
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
136
144
|
|
|
137
145
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `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. - `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. - `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. |
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
@@ -37,6 +37,8 @@ Name | Type | Description | Notes
|
|
|
37
37
|
|
|
38
38
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
39
39
|
|
|
40
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
41
|
+
|
|
40
42
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
41
43
|
|
|
42
44
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/WebhookEventType.md
CHANGED
|
@@ -69,8 +69,12 @@
|
|
|
69
69
|
|
|
70
70
|
* `payment.settlement.status.updated` (value: `"payment.settlement.status.updated"`)
|
|
71
71
|
|
|
72
|
+
* `payment.payout.status.updated` (value: `"payment.payout.status.updated"`)
|
|
73
|
+
|
|
72
74
|
* `payment.address.updated` (value: `"payment.address.updated"`)
|
|
73
75
|
|
|
76
|
+
* `payment.subscription.status.updated` (value: `"payment.subscription.status.updated"`)
|
|
77
|
+
|
|
74
78
|
* `compliance.disposition.status.updated` (value: `"compliance.disposition.status.updated"`)
|
|
75
79
|
|
|
76
80
|
* `compliance.kyt.screenings.status.updated` (value: `"compliance.kyt.screenings.status.updated"`)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cobo/cobo-waas2",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.28.0",
|
|
4
4
|
"description": "The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's WaaS API offering. It enables you to access Cobo's full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols and streamlining blockchain interactions, this API allows you to concentrate on your core business activities without worrying about the safety of your assets. The WaaS 2.0 API presents the following key features: - A unified API for Cobo's [all four wallet types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform) - Support for 80+ chains and 3000+ tokens - A comprehensive selection of webhook events - Flexible usage models for MPC Wallets, including [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction) and [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction) - Programmatic control of smart contract wallets such as Safe{Wallet} with fine-grained access controls - Seamlessly transfer funds across multiple exchanges, including Binance, OKX, Bybit, Deribit, and more For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](https://www.cobo.com/developers/v2/guides/overview/introduction). ",
|
|
5
5
|
"license": "GPL 2.0",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
# CoboWaas2.ReceivedAmountPerAddress
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
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
|
-
|
|
10
|
-
|