@cobo/cobo-waas2 1.23.0 → 1.25.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 +68 -6
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +6 -6
- package/dist/api/ComplianceApi.js +132 -2
- package/dist/api/DevelopersWebhooksApi.js +2 -2
- package/dist/api/FeeStationApi.js +47 -4
- package/dist/api/PaymentApi.js +246 -56
- package/dist/api/SwapsApi.js +374 -0
- package/dist/api/TransactionsApi.js +4 -4
- package/dist/index.js +336 -14
- package/dist/model/AddressInfo.js +13 -0
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/AddressesEventDataAllOfAddresses.js +18 -0
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/BridgingFee.js +136 -0
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/CommissionFee.js +110 -0
- package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +305 -0
- package/dist/model/ContractCallDestination.js +48 -8
- package/dist/model/ContractCallDestinationType.js +5 -0
- package/dist/model/CreateMerchantRequest.js +15 -8
- package/dist/model/CreateOrderLinkRequest.js +129 -0
- package/dist/model/CreatePaymentOrderRequest.js +27 -1
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateSettlement.js +3 -29
- package/dist/model/CreateSettlementRequestRequest.js +39 -0
- package/dist/model/CreateSwapActivityRequest.js +193 -0
- package/dist/model/CustodialTransferDestination.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +1 -1
- package/dist/model/EstimateFeeParams.js +1 -1
- package/dist/model/EstimateTransferFeeParams.js +1 -1
- package/dist/model/EstimatedEvmEip1559Fee.js +1 -1
- package/dist/model/EstimatedEvmLegacyFee.js +1 -1
- package/dist/model/EstimatedFILFee.js +1 -1
- package/dist/model/EstimatedFixedFee.js +1 -1
- package/dist/model/EstimatedSOLFee.js +1 -1
- package/dist/model/EstimatedUtxoFee.js +1 -1
- package/dist/model/FeeStationCheckFeeStationUsage.js +186 -0
- package/dist/model/FeeStationCheckFeeStationUsageResponse.js +200 -0
- package/dist/model/FeeStationGasStationType.js +61 -0
- package/dist/model/FundsStatusType.js +111 -0
- package/dist/model/KytScreeningsDecisionsType.js +71 -0
- package/dist/model/KytScreeningsEventData.js +155 -0
- package/dist/model/KytScreeningsReviewType.js +61 -0
- package/dist/model/KytScreeningsTransaction.js +144 -0
- package/dist/model/KytScreeningsTransactionType.js +61 -0
- package/dist/model/Link.js +125 -0
- package/dist/model/LinkDisplayInfo.js +100 -0
- package/dist/model/ListSwapActivities200Response.js +123 -0
- package/dist/model/ListSwapEnabledTokens200Response.js +123 -0
- package/dist/model/ListTopUpPayerAccounts200Response.js +123 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/Merchant.js +12 -3
- package/dist/model/MerchantBalance.js +3 -3
- package/dist/model/MessageSignDestination.js +8 -70
- package/dist/model/Order.js +13 -0
- package/dist/model/OrderLinkBusinessInfo.js +261 -0
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +125 -0
- package/dist/model/OtcFee.js +123 -0
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentEstimateFee.js +125 -0
- package/dist/model/PaymentEstimateFee201Response.js +108 -0
- package/dist/model/PaymentEstimateFeeRequest.js +137 -0
- package/dist/model/PaymentEstimatedFee.js +173 -0
- package/dist/model/PaymentFeeType.js +71 -0
- package/dist/model/PaymentOrderEventData.js +26 -3
- package/dist/model/PaymentRefundEventData.js +30 -5
- package/dist/model/PaymentSettlementEvent.js +70 -9
- package/dist/model/PaymentTransactionEventData.js +8 -3
- package/dist/model/PspBalance.js +3 -3
- package/dist/model/Refund.js +17 -1
- package/dist/model/ReviewStatusType.js +91 -0
- package/dist/model/SettleRequestStatus.js +5 -0
- package/dist/model/Settlement.js +45 -3
- package/dist/model/SettlementDetail.js +33 -1
- package/dist/model/SettlementInfo.js +7 -7
- package/dist/model/SolContractCallAddressLookupTableAccount.js +126 -0
- package/dist/model/SolContractCallDestination.js +30 -0
- package/dist/model/StellarContractCallContractParam.js +164 -0
- package/dist/model/StellarContractCallContractType.js +56 -0
- package/dist/model/StellarContractCallDestination.js +125 -0
- package/dist/model/StellarContractCallTrustLineOperationType.js +56 -0
- package/dist/model/StellarContractCallTrustLineParam.js +133 -0
- package/dist/model/SubmitKytResponse.js +122 -0
- package/dist/model/SubmitKytScreeningsDecisionsBody.js +122 -0
- package/dist/model/{RawMessageSignDestination.js → SubmitKytScreeningsReviewBody.js} +36 -36
- package/dist/model/SupportedToken.js +9 -0
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/SwapActivity.js +9 -9
- package/dist/model/SwapActivityApprovers.js +1 -1
- package/dist/model/SwapActivityDetail.js +34 -18
- package/dist/model/SwapActivitySigners.js +2 -2
- package/dist/model/SwapActivityTimeline.js +5 -5
- package/dist/model/SwapEstimateFee.js +147 -0
- package/dist/model/SwapQuote.js +18 -31
- package/dist/model/SwapReceivingTransaction.js +133 -0
- package/dist/model/SwapToken.js +9 -9
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TransactionCoboCategory.js +5 -0
- package/dist/model/TransactionDestination.js +48 -8
- package/dist/model/TransactionDestinationType.js +5 -0
- package/dist/model/TransactionEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionEvmLegacyFee.js +1 -1
- package/dist/model/TransactionFILFee.js +1 -1
- package/dist/model/TransactionFixedFee.js +1 -1
- package/dist/model/TransactionFuelingInfo.js +13 -0
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFILFee.js +1 -1
- package/dist/model/TransactionRequestSOLFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionSOLFee.js +1 -1
- package/dist/model/TransactionSolContractAddressLookupTableAccount.js +126 -0
- package/dist/model/TransactionSolContractDestination.js +30 -0
- package/dist/model/TransactionStellarContractParam.js +164 -0
- package/dist/model/TransactionStellarContractType.js +56 -0
- package/dist/model/{BTCEIP191MessageSignDestination.js → TransactionStellarDestination.js} +38 -35
- package/dist/model/TransactionStellarTrustLineOperationType.js +56 -0
- package/dist/model/TransactionStellarTrustLineParam.js +133 -0
- package/dist/model/TransactionUtxoFee.js +1 -1
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/UpdateBankAccountByIdRequest.js +108 -0
- package/dist/model/UpdateTopUpAddress.js +4 -6
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WalletSetup.js +66 -0
- package/dist/model/WebhookEventData.js +81 -11
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +10 -0
- package/docs/AddressBooksApi.md +3 -3
- package/docs/AddressInfo.md +1 -0
- package/docs/AddressesEventData.md +3 -1
- package/docs/AddressesEventDataAllOfAddresses.md +1 -0
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/BridgingFee.md +11 -0
- package/docs/ChainsEventData.md +3 -1
- package/docs/CommissionFee.md +9 -0
- package/docs/ComplianceApi.md +158 -1
- package/docs/ComplianceDispositionUpdateEventData.md +3 -1
- package/docs/ComplianceKytScreeningsUpdateEventData.md +57 -0
- package/docs/ContractCallDestination.md +2 -0
- package/docs/ContractCallDestinationType.md +2 -0
- package/docs/CreateMerchantRequest.md +3 -2
- package/docs/CreateOrderLinkRequest.md +10 -0
- package/docs/CreatePaymentOrderRequest.md +3 -1
- package/docs/CreateRefundRequest.md +2 -2
- package/docs/CreateSettlement.md +2 -4
- package/docs/CreateSettlementRequestRequest.md +3 -0
- package/docs/CreateSwapActivityRequest.md +15 -0
- package/docs/DevelopersWebhooksApi.md +1 -1
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +1 -1
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/FeeStationApi.md +53 -0
- package/docs/FeeStationCheckFeeStationUsage.md +14 -0
- package/docs/FeeStationCheckFeeStationUsageResponse.md +16 -0
- package/docs/FeeStationGasStationType.md +12 -0
- package/docs/FundsStatusType.md +32 -0
- package/docs/KytScreeningsDecisionsType.md +16 -0
- package/docs/KytScreeningsEventData.md +13 -0
- package/docs/KytScreeningsReviewType.md +12 -0
- package/docs/KytScreeningsTransaction.md +12 -0
- package/docs/KytScreeningsTransactionType.md +12 -0
- package/docs/Link.md +10 -0
- package/docs/LinkDisplayInfo.md +10 -0
- package/docs/ListSwapActivities200Response.md +10 -0
- package/docs/ListSwapEnabledTokens200Response.md +10 -0
- package/docs/ListTopUpPayerAccounts200Response.md +10 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/Merchant.md +3 -2
- package/docs/MerchantBalance.md +3 -3
- package/docs/MessageSignDestination.md +0 -1
- package/docs/Order.md +1 -0
- package/docs/OrderLinkBusinessInfo.md +19 -0
- package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +10 -0
- package/docs/OtcFee.md +10 -0
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentApi.md +253 -25
- package/docs/PaymentEstimateFee.md +10 -0
- package/docs/PaymentEstimateFee201Response.md +9 -0
- package/docs/PaymentEstimateFeeRequest.md +10 -0
- package/docs/PaymentEstimatedFee.md +13 -0
- package/docs/PaymentFeeType.md +16 -0
- package/docs/PaymentOrderEventData.md +4 -1
- package/docs/PaymentRefundEventData.md +5 -2
- package/docs/PaymentSettlementEvent.md +9 -4
- package/docs/PaymentTransactionEventData.md +3 -1
- package/docs/PspBalance.md +3 -3
- package/docs/Refund.md +2 -1
- package/docs/ReviewStatusType.md +24 -0
- package/docs/SettleRequestStatus.md +2 -0
- package/docs/Settlement.md +6 -3
- package/docs/SettlementDetail.md +3 -1
- package/docs/SettlementInfo.md +6 -6
- package/docs/SolContractCallAddressLookupTableAccount.md +10 -0
- package/docs/SolContractCallDestination.md +1 -0
- package/docs/StellarContractCallContractParam.md +11 -0
- package/docs/StellarContractCallContractType.md +10 -0
- package/docs/StellarContractCallDestination.md +10 -0
- package/docs/StellarContractCallTrustLineOperationType.md +10 -0
- package/docs/StellarContractCallTrustLineParam.md +11 -0
- package/docs/SubmitKytResponse.md +10 -0
- package/docs/SubmitKytScreeningsDecisionsBody.md +10 -0
- package/docs/SubmitKytScreeningsReviewBody.md +10 -0
- package/docs/SupportedToken.md +1 -0
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/SwapActivity.md +9 -9
- package/docs/SwapActivityDetail.md +10 -9
- package/docs/SwapActivitySigners.md +1 -1
- package/docs/SwapActivityTimeline.md +3 -3
- package/docs/SwapEstimateFee.md +12 -0
- package/docs/SwapQuote.md +10 -11
- package/docs/SwapReceivingTransaction.md +11 -0
- package/docs/SwapToken.md +6 -6
- package/docs/SwapsApi.md +356 -0
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokensEventData.md +3 -1
- package/docs/TransactionCoboCategory.md +2 -0
- package/docs/TransactionDestination.md +2 -0
- package/docs/TransactionDestinationType.md +2 -0
- package/docs/TransactionFuelingInfo.md +1 -0
- package/docs/TransactionSolContractAddressLookupTableAccount.md +10 -0
- package/docs/TransactionSolContractDestination.md +1 -0
- package/docs/TransactionStellarContractParam.md +11 -0
- package/docs/TransactionStellarContractType.md +10 -0
- package/docs/TransactionStellarDestination.md +10 -0
- package/docs/TransactionStellarTrustLineOperationType.md +10 -0
- package/docs/TransactionStellarTrustLineParam.md +11 -0
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +2 -2
- package/docs/UpdateBankAccountByIdRequest.md +9 -0
- package/docs/UpdateTopUpAddress.md +1 -1
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletSetup.md +14 -0
- package/docs/WebhookEventData.md +12 -3
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +4 -0
- package/package.json +1 -1
- package/docs/BTCEIP191MessageSignDestination.md +0 -10
- package/docs/RawMessageSignDestination.md +0 -10
|
@@ -4,17 +4,20 @@
|
|
|
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. |
|
|
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. |
|
|
8
8
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
|
|
9
9
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
10
10
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
11
11
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
12
|
-
**created_timestamp** | **Number** | The
|
|
13
|
-
**updated_timestamp** | **Number** | The
|
|
14
|
-
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the
|
|
12
|
+
**created_timestamp** | **Number** | The created time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
**updated_timestamp** | **Number** | The updated time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
14
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payments App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. | [optional]
|
|
15
15
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
16
16
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
17
17
|
**settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
|
|
18
|
+
**currency** | **String** | The fiat currency for the off-ramp. | [optional]
|
|
19
|
+
**received_amount_fiat** | **String** | The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. | [optional]
|
|
20
|
+
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
18
21
|
|
|
19
22
|
|
|
20
23
|
|
|
@@ -53,6 +56,8 @@ Name | Type | Description | Notes
|
|
|
53
56
|
|
|
54
57
|
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
55
58
|
|
|
59
|
+
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
60
|
+
|
|
56
61
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
57
62
|
|
|
58
63
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `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]
|
|
@@ -79,6 +79,8 @@ Name | Type | Description | Notes
|
|
|
79
79
|
|
|
80
80
|
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
81
81
|
|
|
82
|
+
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
83
|
+
|
|
82
84
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
83
85
|
|
|
84
86
|
|
package/docs/PspBalance.md
CHANGED
|
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. |
|
|
8
8
|
**developer_fee_amount** | **String** | The total amount of the token that has been received as developer fee. | [optional]
|
|
9
|
-
**settled_amount** | **String** | The total amount of the token that has been
|
|
9
|
+
**settled_amount** | **String** | The total amount of the token that has been paid out from the developer's balance. | [optional]
|
|
10
10
|
**refunded_amount** | **String** | The total amount of the token that has been refunded from the developer's balance. | [optional]
|
|
11
|
-
**total_balance** | **String** |
|
|
12
|
-
**available_balance** | **String** |
|
|
11
|
+
**total_balance** | **String** | The total balance of the token available for payout or refund for the developer. `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount` For more information, please refer to [Amounts and Balances](/v2_cn/payments/amounts-and-balances) | [optional]
|
|
12
|
+
**available_balance** | **String** | This field has been deprecated. | [optional]
|
|
13
13
|
|
|
14
14
|
|
package/docs/Refund.md
CHANGED
|
@@ -16,10 +16,11 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
17
17
|
**created_timestamp** | **Number** | The creation time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
18
|
**updated_timestamp** | **Number** | The last update time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
19
|
-
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the
|
|
19
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payments App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. | [optional]
|
|
20
20
|
**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]
|
|
21
21
|
**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund. - `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. | [optional]
|
|
22
22
|
**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional]
|
|
23
23
|
**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional]
|
|
24
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
|
|
24
25
|
|
|
25
26
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CoboWaas2.ReviewStatusType
|
|
2
|
+
|
|
3
|
+
## Enum
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
* `PendingScreening` (value: `"PendingScreening"`)
|
|
7
|
+
|
|
8
|
+
* `Screened` (value: `"Screened"`)
|
|
9
|
+
|
|
10
|
+
* `PendingDecision` (value: `"PendingDecision"`)
|
|
11
|
+
|
|
12
|
+
* `PendingReview` (value: `"PendingReview"`)
|
|
13
|
+
|
|
14
|
+
* `Approved` (value: `"Approved"`)
|
|
15
|
+
|
|
16
|
+
* `Rejected` (value: `"Rejected"`)
|
|
17
|
+
|
|
18
|
+
* `Unsupported` (value: `"Unsupported"`)
|
|
19
|
+
|
|
20
|
+
* `Bypassed` (value: `"Bypassed"`)
|
|
21
|
+
|
|
22
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
23
|
+
|
|
24
|
+
|
package/docs/Settlement.md
CHANGED
|
@@ -8,11 +8,14 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
9
9
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
10
10
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
11
|
-
**created_timestamp** | **Number** | The
|
|
12
|
-
**updated_timestamp** | **Number** | The
|
|
13
|
-
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the
|
|
11
|
+
**created_timestamp** | **Number** | The created time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
12
|
+
**updated_timestamp** | **Number** | The updated time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payments App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. | [optional]
|
|
14
14
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
15
15
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
16
16
|
**settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
|
|
17
|
+
**currency** | **String** | The fiat currency for the off-ramp. | [optional]
|
|
18
|
+
**received_amount_fiat** | **String** | The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. | [optional]
|
|
19
|
+
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
17
20
|
|
|
18
21
|
|
package/docs/SettlementDetail.md
CHANGED
|
@@ -15,10 +15,12 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this settlement request. Each transaction represents a separate blockchain operation related to the settlement process. | [optional]
|
|
16
16
|
**created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
17
17
|
**updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
|
-
**crypto_address_id** | **String** | The ID of the crypto address used for crypto
|
|
18
|
+
**crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. | [optional]
|
|
19
19
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
20
20
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
21
21
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. | [optional]
|
|
22
22
|
**order_ids** | **[String]** | A list of unique order IDs to be included in this settlement. - This field is only applicable when `settlement_type` is set to `Merchant`. - If provided, the settlement will only apply to the specified orders. | [optional]
|
|
23
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
|
|
24
|
+
**bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional]
|
|
23
25
|
|
|
24
26
|
|
package/docs/SettlementInfo.md
CHANGED
|
@@ -6,13 +6,13 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. For developer balance, this field will be empty. | [optional]
|
|
8
8
|
**token_id** | **String** | The ID of the cryptocurrency. | [optional]
|
|
9
|
-
**available_amount** | **String** | This field
|
|
10
|
-
**available_currency_balance** | **String** | This field
|
|
11
|
-
**pending_amount** | **String** | This field
|
|
12
|
-
**pending_currency_balance** | **String** | This field
|
|
9
|
+
**available_amount** | **String** | This field has been deprecated. |
|
|
10
|
+
**available_currency_balance** | **String** | This field has been deprecated. | [optional]
|
|
11
|
+
**pending_amount** | **String** | This field has been deprecated. | [optional]
|
|
12
|
+
**pending_currency_balance** | **String** | This field has been deprecated. | [optional]
|
|
13
13
|
**settled_amount** | **String** | The amount already settled, in the specified cryptocurrency. | [optional]
|
|
14
|
-
**available_balance** | **String** |
|
|
15
|
-
**total_balance** | **String** |
|
|
14
|
+
**available_balance** | **String** | This field has been deprecated. | [optional]
|
|
15
|
+
**total_balance** | **String** | The total balance in the specified cryptocurrency. | [optional]
|
|
16
16
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
17
17
|
**created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
18
|
**updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SolContractCallAddressLookupTableAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**alt_account_key** | **String** | The on-chain public key of the Address Lookup Table (ALT) account, identifying the specific lookup table. |
|
|
8
|
+
**addresses** | **[String]** | An array of stored account addresses within the lookup table, which can be referenced in transactions by index. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
8
|
**instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
|
|
9
|
+
**address_lookup_table_accounts** | [**[SolContractCallAddressLookupTableAccount]**](SolContractCallAddressLookupTableAccount.md) | | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.StellarContractCallContractParam
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**contract_type** | [**StellarContractCallContractType**](StellarContractCallContractType.md) | |
|
|
8
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. |
|
|
9
|
+
**operation_type** | [**StellarContractCallTrustLineOperationType**](StellarContractCallTrustLineOperationType.md) | |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.StellarContractCallDestination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
|
+
**contract_param** | [**StellarContractCallContractParam**](StellarContractCallContractParam.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.StellarContractCallTrustLineParam
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**contract_type** | [**StellarContractCallContractType**](StellarContractCallContractType.md) | |
|
|
8
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. |
|
|
9
|
+
**operation_type** | [**StellarContractCallTrustLineOperationType**](StellarContractCallTrustLineOperationType.md) | |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SubmitKytResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_id** | **String** | The UUID of the transaction being processed for KYT screening. |
|
|
8
|
+
**submitted** | **Boolean** | Indicates whether the KYT review result was successfully submitted. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SubmitKytScreeningsDecisionsBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_id** | **String** | The UUID of the transaction for KYT result submission. This identifies the specific transaction that the external KYT result applies to. |
|
|
8
|
+
**result** | [**KytScreeningsDecisionsType**](KytScreeningsDecisionsType.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SubmitKytScreeningsReviewBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**transaction_id** | **String** | The UUID of the transaction that requires a manual KYT review. |
|
|
8
|
+
**result** | [**KytScreeningsReviewType**](KytScreeningsReviewType.md) | |
|
|
9
|
+
|
|
10
|
+
|
package/docs/SupportedToken.md
CHANGED
|
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**chain_symbol** | **String** | Symbol of the underlying blockchain |
|
|
14
14
|
**chain_icon_url** | **String** | URL to the blockchain's icon image | [optional]
|
|
15
15
|
**token_icon_url** | **String** | URL to the token's icon image | [optional]
|
|
16
|
+
**can_off_ramp** | **Boolean** | Whether the token is supported by the off-ramp service. | [optional]
|
|
16
17
|
|
|
17
18
|
|
|
@@ -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. |
|
|
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. |
|
|
8
8
|
**token_ids** | **String** | A list of token IDs, separated by comma. |
|
|
9
9
|
**operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
|
|
10
10
|
|
|
@@ -45,6 +45,8 @@ Name | Type | Description | Notes
|
|
|
45
45
|
|
|
46
46
|
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
47
47
|
|
|
48
|
+
* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
|
|
49
|
+
|
|
48
50
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
49
51
|
|
|
50
52
|
|
package/docs/SwapActivity.md
CHANGED
|
@@ -7,20 +7,20 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**activity_id** | **String** | The unique identifier of the swap activity. | [optional]
|
|
8
8
|
**swap_type** | [**SwapType**](SwapType.md) | | [optional]
|
|
9
9
|
**status** | [**SwapActivityStatus**](SwapActivityStatus.md) | | [optional]
|
|
10
|
-
**request_id** | **String** | The request
|
|
11
|
-
**wallet_id** | **String** | The
|
|
12
|
-
**pay_token_id** | **String** | The token
|
|
13
|
-
**receive_token_id** | **String** | The token
|
|
14
|
-
**pay_amount** | **String** | The amount of
|
|
15
|
-
**receive_amount** | **String** | The amount of
|
|
16
|
-
**fee_token_id** | **String** | The
|
|
17
|
-
**fee_amount** | **String** | The amount of fee. | [optional]
|
|
10
|
+
**request_id** | **String** | The request ID of the swap transaction. | [optional]
|
|
11
|
+
**wallet_id** | **String** | The ID of the wallet used to pay. | [optional]
|
|
12
|
+
**pay_token_id** | **String** | The ID of the token to pay. | [optional]
|
|
13
|
+
**receive_token_id** | **String** | The ID of the token to receive. | [optional]
|
|
14
|
+
**pay_amount** | **String** | The amount of the token to pay. | [optional]
|
|
15
|
+
**receive_amount** | **String** | The amount of the token to receive. | [optional]
|
|
16
|
+
**fee_token_id** | **String** | The ID of the token used for paying the service fee. | [optional]
|
|
17
|
+
**fee_amount** | **String** | The amount of the service fee. | [optional]
|
|
18
18
|
**initiator** | **String** | The initiator of the swap activity. | [optional]
|
|
19
19
|
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | | [optional]
|
|
20
20
|
**description** | **String** | The description of the swap activity. | [optional]
|
|
21
21
|
**created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
22
22
|
**updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
23
23
|
**network_fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
24
|
-
**destination_address** | **String** |
|
|
24
|
+
**destination_address** | **String** | The address of an MPC Wallet or Web3 Wallet that receives the swapped or bridged assets. | [optional]
|
|
25
25
|
|
|
26
26
|
|
|
@@ -7,23 +7,24 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**activity_id** | **String** | The unique identifier of the swap activity. | [optional]
|
|
8
8
|
**swap_type** | [**SwapType**](SwapType.md) | | [optional]
|
|
9
9
|
**status** | [**SwapActivityStatus**](SwapActivityStatus.md) | | [optional]
|
|
10
|
-
**request_id** | **String** | The request
|
|
11
|
-
**wallet_id** | **String** | The
|
|
12
|
-
**pay_token_id** | **String** | The token
|
|
13
|
-
**receive_token_id** | **String** | The token
|
|
14
|
-
**pay_amount** | **String** | The amount of
|
|
15
|
-
**receive_amount** | **String** | The amount of
|
|
16
|
-
**fee_token_id** | **String** | The
|
|
17
|
-
**fee_amount** | **String** | The amount of fee. | [optional]
|
|
10
|
+
**request_id** | **String** | The request ID of the swap transaction. | [optional]
|
|
11
|
+
**wallet_id** | **String** | The ID of the wallet used to pay. | [optional]
|
|
12
|
+
**pay_token_id** | **String** | The ID of the token to pay. | [optional]
|
|
13
|
+
**receive_token_id** | **String** | The ID of the token to receive. | [optional]
|
|
14
|
+
**pay_amount** | **String** | The amount of the token to pay. | [optional]
|
|
15
|
+
**receive_amount** | **String** | The amount of the token to receive. | [optional]
|
|
16
|
+
**fee_token_id** | **String** | The ID of the token used for paying the service fee. | [optional]
|
|
17
|
+
**fee_amount** | **String** | The amount of the service fee. | [optional]
|
|
18
18
|
**initiator** | **String** | The initiator of the swap activity. | [optional]
|
|
19
19
|
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | | [optional]
|
|
20
20
|
**description** | **String** | The description of the swap activity. | [optional]
|
|
21
21
|
**created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
22
22
|
**updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
23
23
|
**network_fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
24
|
-
**destination_address** | **String** |
|
|
24
|
+
**destination_address** | **String** | The address of an MPC Wallet or Web3 Wallet that receives the swapped or bridged assets. | [optional]
|
|
25
25
|
**timeline** | [**[SwapActivityTimeline]**](SwapActivityTimeline.md) | | [optional]
|
|
26
26
|
**approvers** | [**[SwapActivityApprovers]**](SwapActivityApprovers.md) | | [optional]
|
|
27
27
|
**signers** | [**[SwapActivitySigners]**](SwapActivitySigners.md) | | [optional]
|
|
28
|
+
**receiving_transaction** | [**SwapReceivingTransaction**](SwapReceivingTransaction.md) | | [optional]
|
|
28
29
|
|
|
29
30
|
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**signer** | **String** | The signer name. | [optional]
|
|
8
8
|
**status** | [**SwapSingingStatus**](SwapSingingStatus.md) | | [optional]
|
|
9
|
-
**failed_reason** | **String** |
|
|
9
|
+
**failed_reason** | **String** | The reason for the signing failure. | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**action** | **String** | The action
|
|
8
|
-
**status** | **String** | The status of the action. Possible values include: - `Success`: The action
|
|
9
|
-
**timestamp** | **Number** | The time when the action
|
|
7
|
+
**action** | **String** | The action in the swap activity. Possible values include: - `Submitted`: The swap request has been submitted. - `Pending Authorization`: The swap request is pending authorization. - `Bridge {Token}`: The token is being bridged to the destination chain. - `Swap {Token}`: The token is being exchanged to the destination token. - `Cobo Confirmation`: The swap result is pending Cobo's final confirmation. |
|
|
8
|
+
**status** | **String** | The status of the action. Possible values include: - `Success`: The action completed successfully. - `Processing`: The action is being processed. - `Failed`: The action failed. |
|
|
9
|
+
**timestamp** | **Number** | The time when the action occurred, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.SwapEstimateFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**wallet_id** | **String** | The ID of the wallet to pay. |
|
|
8
|
+
**address** | **String** | The wallet address. This property is required when the wallet to pay is not a Custodial Wallet (Asset Wallet). | [optional]
|
|
9
|
+
**quote_id** | **String** | The ID of the swap quote. |
|
|
10
|
+
**fee_type** | [**FeeType**](FeeType.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
package/docs/SwapQuote.md
CHANGED
|
@@ -4,16 +4,15 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**quote_id** | **String** | The unique
|
|
8
|
-
**pay_token_id** | **String** | The token
|
|
9
|
-
**pay_amount** | **String** | The amount of
|
|
10
|
-
**receive_token_id** | **String** | The token
|
|
11
|
-
**receive_amount** | **String** | The amount of
|
|
12
|
-
**fee_token_id** | **String** | The token
|
|
13
|
-
**fee_amount** | **String** | The amount of
|
|
14
|
-
**
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**quote_expired_timestamp** | **Number** | The time when the quote will expire, in Unix timestamp format, measured in milliseconds. |
|
|
7
|
+
**quote_id** | **String** | The unique identifier of the swap quote. |
|
|
8
|
+
**pay_token_id** | **String** | The ID of the token to pay. |
|
|
9
|
+
**pay_amount** | **String** | The amount of the token to pay. |
|
|
10
|
+
**receive_token_id** | **String** | The ID of the token to receive. |
|
|
11
|
+
**receive_amount** | **String** | The amount of the token to receive. |
|
|
12
|
+
**fee_token_id** | **String** | The ID of the token for the service fee. |
|
|
13
|
+
**fee_amount** | **String** | The amount of the token for the service fee. |
|
|
14
|
+
**min_receive_amount** | **String** | The minimum amount of the token to receive if `pay_amount` is specified. | [optional]
|
|
15
|
+
**max_pay_amount** | **String** | The maximum amount of the token to pay if `receive_amount` is specified. | [optional]
|
|
16
|
+
**quote_expired_timestamp** | **Number** | The time when the swap quote expires, in Unix timestamp format, measured in milliseconds. |
|
|
18
17
|
|
|
19
18
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.SwapReceivingTransaction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**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). |
|
|
8
|
+
**transaction_hash** | **String** | The transaction hash. | [optional]
|
|
9
|
+
**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]
|
|
10
|
+
|
|
11
|
+
|
package/docs/SwapToken.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_id** | **String** | The token
|
|
8
|
-
**chain_id** | **String** | The chain
|
|
9
|
-
**asset_id** | **String** | The asset
|
|
10
|
-
**token_address** | **String** | The
|
|
11
|
-
**min_amount** | **String** | The minimum amount. | [optional]
|
|
12
|
-
**max_amount** | **String** | The maximum amount. | [optional]
|
|
7
|
+
**token_id** | **String** | The token ID. |
|
|
8
|
+
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. |
|
|
9
|
+
**asset_id** | **String** | The asset ID. |
|
|
10
|
+
**token_address** | **String** | The on-chain contract address of the token. | [optional]
|
|
11
|
+
**min_amount** | **String** | The minimum amount allowed for a swap. | [optional]
|
|
12
|
+
**max_amount** | **String** | The maximum amount allowed for a swap. | [optional]
|
|
13
13
|
|
|
14
14
|
|