@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
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CoboWaas2.AllocationRecord
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**allocation_record_id** | **String** | The allocation record ID generated by Cobo. |
|
|
8
|
+
**batch_allocation_id** | **String** | The batch allocation ID generated by Cobo. |
|
|
9
|
+
**token_id** | **String** | The ID of the cryptocurrency you want to allocation. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
10
|
+
**amount** | **String** | The allocation amount. |
|
|
11
|
+
**source_account** | **String** | | [optional]
|
|
12
|
+
**destination_account** | **String** | | [optional]
|
|
13
|
+
**description** | **String** | |
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.AllocationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**token_id** | **String** | The ID of the cryptocurrency you want to allocation. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
8
|
+
**amount** | **String** | The allocation amount. |
|
|
9
|
+
**source_account** | **String** | |
|
|
10
|
+
**destination_account** | **String** | |
|
|
11
|
+
**description** | **String** | |
|
|
12
|
+
|
|
13
|
+
|
package/docs/AutoSweepApi.md
CHANGED
|
@@ -70,7 +70,7 @@ Name | Type | Description | Notes
|
|
|
70
70
|
|
|
71
71
|
Create sweep-to address
|
|
72
72
|
|
|
73
|
-
This operation creates a new sweep-to address for the specified wallet. The previously sweep-to address for the same token becomes invalid once the new one is created. Use this operation to change the sweep-to address when your setup changes, you switch networks, or the current address is compromised or tainted by suspicious funds. You can withdraw any remaining balances from the old sweep-to addresses to the new address or another designated destination. <Note>Sweep-to addresses are only applicable to MPC Wallets and Web3 Wallets with the auto-sweep feature enabled.</Note>
|
|
73
|
+
This operation creates a new sweep-to address for the specified wallet. The previously sweep-to address for the same token becomes invalid once the new one is created. Use this operation to change the sweep-to address when your setup changes, you switch networks, or the current address is compromised or tainted by suspicious funds. You can withdraw any remaining balances from the old sweep-to addresses to the new address or another designated destination. <Note>Sweep-to addresses are only applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) with the auto-sweep feature enabled.</Note>
|
|
74
74
|
|
|
75
75
|
### Example
|
|
76
76
|
|
|
@@ -240,7 +240,7 @@ Name | Type | Description | Notes
|
|
|
240
240
|
|
|
241
241
|
List sweep-to addresses
|
|
242
242
|
|
|
243
|
-
This operation retrieves a list of sweep-to addresses within your wallet. <Note>Sweep-to addresses are only applicable to MPC Wallets and Web3 Wallets with the auto-sweep feature enabled.</Note>
|
|
243
|
+
This operation retrieves a list of sweep-to addresses within your wallet. <Note>Sweep-to addresses are only applicable to MPC Wallets and Custodial Wallets (Web3 Wallets) with the auto-sweep feature enabled.</Note>
|
|
244
244
|
|
|
245
245
|
### Example
|
|
246
246
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.BabylonCreateStakingExpansion
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**staking_id** | **String** | The ID of the Phase-2 BTC staking position. |
|
|
8
|
+
**finality_provider_public_keys** | **[String]** | The public keys of the finality providers, with each key corresponding to a BSN chain. |
|
|
9
|
+
**request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
10
|
+
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
11
|
+
|
|
12
|
+
|
|
@@ -6,8 +6,10 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
|
|
8
8
|
**finality_provider_public_key** | **String** | The public key of the finality provider. |
|
|
9
|
+
**finality_provider_public_keys** | **[String]** | The public keys of the finality providers, with each key corresponding to a BSN chain. | [optional]
|
|
9
10
|
**stake_block_time** | **Number** | The number of blocks that need to be processed before the locked tokens are unlocked and become accessible. |
|
|
10
11
|
**auto_broadcast** | **Boolean** | Whether to automatically broadcast the transaction. The default value is `true`. - `true`: Automatically broadcast the transaction. - `false`: The transaction will not be submitted to the blockchain automatically. You can call [Broadcast signed transactions](https://www.cobo.com/developers/v2/api-references/transactions/broadcast-signed-transactions) to broadcast the transaction to the blockchain, or retrieve the signed raw transaction data `raw_tx` by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information) and broadcast it yourself. | [optional]
|
|
11
12
|
**babylon_address** | [**StakingSource**](StakingSource.md) | | [optional]
|
|
13
|
+
**original_staking_id** | **String** | The original staking ID to expand. Only set this when you want to expand existing staking. | [optional]
|
|
12
14
|
|
|
13
15
|
|
|
@@ -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
|
**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). |
|
|
9
9
|
**address** | **String** | The wallet address. |
|
|
10
10
|
**wallet_uuid** | **String** | The wallet ID. |
|
|
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
42
42
|
|
|
43
43
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
44
44
|
|
|
45
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
46
|
+
|
|
45
47
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
46
48
|
|
|
47
49
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.BatchAllocation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**batch_allocation_id** | **String** | The batch allocation ID generated by Cobo. |
|
|
8
|
+
**request_id** | **String** | The request ID provided by you when creating the batch allocation. |
|
|
9
|
+
**allocation_requests** | [**[AllocationRequest]**](AllocationRequest.md) | | [optional]
|
|
10
|
+
**initiator** | **String** | The initiator of this batch allocation, usually the user's API key. | [optional]
|
|
11
|
+
**created_timestamp** | **Number** | The created time of the batch allocation, represented as a UNIX timestamp in seconds. |
|
|
12
|
+
**updated_timestamp** | **Number** | The updated time of the batch allocation, represented as a UNIX timestamp in seconds. |
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.BatchAllocationDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**batch_allocation_id** | **String** | The batch allocation ID generated by Cobo. |
|
|
8
|
+
**request_id** | **String** | The request ID provided by you when creating the batch allocation. |
|
|
9
|
+
**allocation_records** | [**[AllocationRecord]**](AllocationRecord.md) | |
|
|
10
|
+
**initiator** | **String** | The initiator of this batch allocation, usually the user's API key. | [optional]
|
|
11
|
+
**created_timestamp** | **Number** | The created time of the batch allocation, represented as a UNIX timestamp in seconds. | [optional]
|
|
12
|
+
**updated_timestamp** | **Number** | The updated time of the batch allocation, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
|
|
14
|
+
|
package/docs/ChainsEventData.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
|
**chains** | [**[ChainInfo]**](ChainInfo.md) | The enabled chains. |
|
|
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"`)
|
|
@@ -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
|
**disposition_type** | [**DispositionType**](DispositionType.md) | |
|
|
10
10
|
**disposition_status** | [**DispositionStatus**](DispositionStatus.md) | |
|
|
@@ -43,6 +43,8 @@ Name | Type | Description | Notes
|
|
|
43
43
|
|
|
44
44
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
45
45
|
|
|
46
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
47
|
+
|
|
46
48
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
47
49
|
|
|
48
50
|
* `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
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) | |
|
|
10
10
|
**review_status** | [**ReviewStatusType**](ReviewStatusType.md) | |
|
|
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
42
42
|
|
|
43
43
|
* `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
|
|
44
44
|
|
|
45
|
+
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
46
|
+
|
|
45
47
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
46
48
|
|
|
47
49
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -6,10 +6,11 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
8
|
**address** | **String** | The destination address. |
|
|
9
|
-
**value** | **String** | The transfer amount. For example, if you trade 1.5
|
|
10
|
-
**calldata** | **String** | The data used to invoke a specific function or method within the specified contract at 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
11
|
**instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
|
|
12
12
|
**address_lookup_table_accounts** | [**[SolContractCallAddressLookupTableAccount]**](SolContractCallAddressLookupTableAccount.md) | | [optional]
|
|
13
13
|
**contract_param** | [**StellarContractCallContractParam**](StellarContractCallContractParam.md) | |
|
|
14
|
+
**cosmos_messages** | [**[CosmosContractCallMessage]**](CosmosContractCallMessage.md) | |
|
|
14
15
|
|
|
15
16
|
|
|
@@ -6,6 +6,5 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
8
|
**cosmos_messages** | [**[CosmosContractCallMessage]**](CosmosContractCallMessage.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
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.Counterparty
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. | [optional]
|
|
8
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**counterparty_name** | **String** | The counterparty name. |
|
|
10
|
+
**country** | **String** | The country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the counterparty. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the counterparty. | [optional]
|
|
13
|
+
**created_timestamp** | **Number** | The created time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
14
|
+
**updated_timestamp** | **Number** | The updated time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# CoboWaas2.CounterpartyDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. | [optional]
|
|
8
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**counterparty_name** | **String** | The counterparty name. |
|
|
10
|
+
**country** | **String** | The country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the counterparty. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the counterparty. | [optional]
|
|
13
|
+
**wallet_addresses** | [**[WalletAddress]**](WalletAddress.md) | The wallet addresses of the counterparty. |
|
|
14
|
+
**created_timestamp** | **Number** | The created time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
**updated_timestamp** | **Number** | The updated time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CoboWaas2.CounterpartyWalletAddressDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. |
|
|
8
|
+
**counterparty_name** | **String** | The name of the counterparty. |
|
|
9
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
10
|
+
**wallet_address_id** | **String** | The wallet address ID. |
|
|
11
|
+
**address** | **String** | The wallet address. |
|
|
12
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
13
|
+
**updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. |
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.CreateBatchAllocationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**request_id** | **String** | The request ID that is used to track a allocation request. The request ID is provided by you and must be unique. |
|
|
8
|
+
**allocation_requests** | [**[AllocationRequest]**](AllocationRequest.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.CreateCounterpartyRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_name** | **String** | The counterparty name. |
|
|
8
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**wallet_addresses** | [**[CreateWalletAddress]**](CreateWalletAddress.md) | The wallet addresses of the counterparty. |
|
|
10
|
+
**country** | **String** | The country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the counterparty. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the counterparty. | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.CreateCounterpartyWalletAddressRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. |
|
|
8
|
+
**address** | **String** | The wallet address. |
|
|
9
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The wallet name. |
|
|
8
8
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
|
-
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional]
|
|
10
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets). | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationBankAccount
|
|
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,20 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationBankAccountRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**account_alias** | **String** | The alias of the bank account. |
|
|
9
|
+
**account_number** | **String** | The bank account number. |
|
|
10
|
+
**swift_code** | **String** | The SWIFT or BIC code of the bank. |
|
|
11
|
+
**currency** | **String** | The currency of the bank account. |
|
|
12
|
+
**beneficiary_name** | **String** | The name of the account holder. |
|
|
13
|
+
**beneficiary_address** | **String** | The address of the account holder. |
|
|
14
|
+
**bank_name** | **String** | The name of the bank. |
|
|
15
|
+
**bank_address** | **String** | The address of the bank. |
|
|
16
|
+
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
17
|
+
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
18
|
+
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_name** | **String** | The destination name. |
|
|
8
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**wallet_addresses** | [**[CreateWalletAddress]**](CreateWalletAddress.md) | The wallet addresses of the destination. | [optional]
|
|
10
|
+
**bank_accounts** | [**[CreateDestinationBankAccount]**](CreateDestinationBankAccount.md) | The bank accounts of the destination. | [optional]
|
|
11
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
12
|
+
**country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
13
|
+
**email** | **String** | The email of the destination. | [optional]
|
|
14
|
+
**contact_address** | **String** | The contact address of the destination. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationWalletAddressRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**address** | **String** | The wallet address. |
|
|
9
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The wallet name. |
|
|
8
8
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
|
-
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional]
|
|
10
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets). | [optional]
|
|
11
11
|
**exchange_id** | [**ExchangeId**](ExchangeId.md) | |
|
|
12
12
|
**apikey** | **String** | The API key of your exchange account. |
|
|
13
13
|
**secret** | **String** | The API secret of your exchange account. |
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Key share holder's name. | [optional]
|
|
8
8
|
**type** | [**KeyShareHolderType**](KeyShareHolderType.md) | | [optional]
|
|
9
|
-
**tss_node_id** | **String** | Key share holder's TSS Node ID.
|
|
9
|
+
**tss_node_id** | **String** | Key share holder's TSS Node ID. For detailed information about signer types and their setup, see the [**Signer Type** table](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/holder-group-main-group). Mobile signers can view their TSS Node ID in the [Cobo Guard app](https://manuals.cobo.com/en/guard/manage). | [optional]
|
|
10
10
|
**signer** | **Boolean** | Whether the key share holder has been selected as the designated transaction signer. For example, in a 2-3 [Threshold Signature Scheme (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss), Cobo will serve as one signer, and you can choose one of the other two key share holders to act as the second transaction signer. - `true`: The key share holder is a designated transaction signer. - `false`: The key share holder is not a designated transaction signer. | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The merchant name. |
|
|
8
8
|
**wallet_id** | **String** | This field has been deprecated. | [optional]
|
|
9
|
-
**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/
|
|
9
|
+
**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]
|
|
10
10
|
**wallet_setup** | [**WalletSetup**](WalletSetup.md) | | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The wallet name. |
|
|
8
8
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
|
-
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional]
|
|
10
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets). | [optional]
|
|
11
11
|
**vault_id** | **String** | The ID of the owning vault. You can call [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults) to retrieve all vault IDs under your organization. |
|
|
12
12
|
|
|
13
13
|
|
|
@@ -4,16 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**merchant_id** | **String** | The merchant ID.
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**
|
|
7
|
+
**merchant_id** | **String** | The merchant ID. |
|
|
8
|
+
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
|
|
9
|
+
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
10
|
+
**pricing_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
11
|
+
**pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional]
|
|
12
|
+
**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. For example, if order_amount is \"100.00\" and fee_amount is \"2.00\", the customer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant and \"2.00\" settled to the developer. Values must be greater than 0 and contain two decimal places. |
|
|
13
|
+
**payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
14
|
+
**payable_amount** | **String** | The actual payable amount of the order in the cryptocurrency. | [optional]
|
|
15
|
+
**expired_in** | **Number** | The pay-in order will expire after approximately a certain number of seconds: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. | [optional]
|
|
16
|
+
**amount_tolerance** | **String** | Allowed amount deviation, precision to 1 decimal place. | [optional]
|
|
17
|
+
**currency** | **String** | The fiat currency of the order. | [optional] [default to '']
|
|
18
|
+
**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional]
|
|
19
|
+
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
20
|
+
**use_dedicated_address** | **Boolean** | Indicates whether to allocate a dedicated address for this order. If false, a shared address from the address pool will be used. | [optional]
|
|
21
|
+
**custom_exchange_rate** | **String** | A custom exchange rate specified by the merchant. - Only effective when `currency` is `\"USD\"`. - Expressed as the amount of USD per 1 unit of the specified cryptocurrency. - If not provided, the system will use the default internal rate. Example: If the cryptocurrency is USDT and `custom_exchange_rate` = `\"0.99\"`, it means 1 USDT = 0.99 USD. | [optional]
|
|
18
22
|
|
|
19
23
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.CreatePayoutRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**request_id** | **String** | The request ID that is used to track a settlement request. The request ID is provided by you and must be unique. |
|
|
8
|
+
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
9
|
+
**payout_params** | [**[PaymentPayoutParam]**](PaymentPayoutParam.md) | |
|
|
10
|
+
**bank_account_id** | **String** | | Only used in OffRamp payout channel. The ID of the bank account where the settled funds will be deposited. | [optional]
|
|
11
|
+
**currency** | **String** | The fiat currency for the create payouts. | [optional]
|
|
12
|
+
**remark** | **String** | The remark for the create payouts. | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -11,8 +11,8 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**token_id** | **String** | The ID of the cryptocurrency used for refund. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
12
12
|
**refund_type** | [**RefundType**](RefundType.md) | |
|
|
13
13
|
**order_id** | **String** | The ID of the original pay-in order associated with this refund. Use this to track refunds against specific payments. | [optional]
|
|
14
|
-
**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/
|
|
15
|
-
**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/
|
|
16
|
-
**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the
|
|
14
|
+
**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances). - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified. | [optional]
|
|
15
|
+
**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances). This field is required when `charge_merchant_fee` is `true`. Must be: - A positive integer with up to two decimal places. - Less than the refund amount | [optional]
|
|
16
|
+
**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the transaction fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional]
|
|
17
17
|
|
|
18
18
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The wallet name. |
|
|
8
8
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
|
-
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets. | [optional]
|
|
10
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets). | [optional]
|
|
11
11
|
**chain_id** | **String** | The ID of the chain that the wallet operates on. |
|
|
12
12
|
**smart_contract_wallet_type** | [**SmartContractWalletType**](SmartContractWalletType.md) | |
|
|
13
13
|
**safe_address** | **String** | The address of the Smart Contract Wallet. If this is not provided, Cobo will create a new Safe{Wallet} and set up Cobo Safe for you. In that case, the `threshold` and `signers` properties are required. | [optional]
|
package/docs/CreateSettlement.md
CHANGED
|
@@ -7,7 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. Specify this field when `settlement_type` is set to `Merchant`. | [optional]
|
|
8
8
|
**token_id** | **String** | The ID of the cryptocurrency you want to settle. Specify this field when `payout_channel` is set to `Crypto`. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
9
9
|
**amount** | **String** | The amount of cryptocurrency to be settled. When settling merchant balance from orders (`acquiring_type` is `Order` and `settlement_type` is `Merchant`), do not specify this field as the amount will be automatically calculated based on the order amounts. | [optional]
|
|
10
|
-
**crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. Specify this field when `payout_channel` is set to `Crypto`. Call [List crypto addresses](https://www.cobo.com/
|
|
10
|
+
**crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. Specify this field when `payout_channel` is set to `Crypto`. Call [List crypto addresses](https://www.cobo.com/payments/en/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses. | [optional]
|
|
11
|
+
**crypto_address** | **String** | Only used in Crypto payout channel. The actual blockchain address to which funds will be transferred. If enable destination whitelist, this address must be associated with a destination. | [optional]
|
|
11
12
|
**order_ids** | **[String]** | | [optional]
|
|
12
13
|
|
|
13
14
|
|