@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
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
10
10
|
**settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
|
|
11
11
|
**settlements** | [**[CreateSettlement]**](CreateSettlement.md) | |
|
|
12
|
-
**bank_account_id** | **String** | The ID of the bank account where the funds will be deposited. You can call [List all bank accounts](https://www.cobo.com/
|
|
12
|
+
**bank_account_id** | **String** | The ID of the bank account where the funds will be deposited. You can call [List all bank accounts](https://www.cobo.com/payments/en/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts. This field is only applicable for off-ramp. | [optional]
|
|
13
13
|
**currency** | **String** | The fiat currency to receive after off-ramping. Currently, only `USD` is supported. Specify this field when `payout_channel` is set to `OffRamp`. | [optional]
|
|
14
14
|
**remark** | **String** | The remark for the payout request. | [optional]
|
|
15
15
|
|
|
@@ -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]
|
|
@@ -6,9 +6,11 @@ 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
|
**provider_name** | **String** | The name of the provider. |
|
|
13
15
|
**timelock** | **Number** | The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. |
|
|
14
16
|
**change_address** | **String** | The change address on the Bitcoin chain. If not provided, the source wallet's address will be used as the change address. | [optional]
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.CreateWalletAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**address** | **String** | The wallet address. |
|
|
8
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -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
|
**exchange_id** | [**ExchangeId**](ExchangeId.md) | |
|
|
13
13
|
**apikey** | **String** | The API key of your exchange account. |
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.DeleteCounterpartyWalletAddress200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**wallet_address_id** | **String** | The wallet address ID under the counterparty. |
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# CoboWaas2.Destination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. | [optional]
|
|
8
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**destination_name** | **String** | The destination name. |
|
|
10
|
+
**country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the destination. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the destination. | [optional]
|
|
13
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
14
|
+
**created_timestamp** | **Number** | The created time of the destination, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
**updated_timestamp** | **Number** | The updated time of the destination, represented as a UNIX timestamp in seconds. |
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CoboWaas2.DestinationBankAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**bank_account_id** | **String** | The destination bank account 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
|
+
**bank_account_status** | [**BankAccountStatus**](BankAccountStatus.md) | |
|
|
20
|
+
**created_timestamp** | **Number** | The created time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
21
|
+
**updated_timestamp** | **Number** | The updated time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# CoboWaas2.DestinationBankAccountDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**destination_name** | **String** | The name of the destination. |
|
|
9
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
10
|
+
**destination_email** | **String** | The email of the destination. | [optional]
|
|
11
|
+
**destination_country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
12
|
+
**destination_contact_address** | **String** | The contact address of the destination. | [optional]
|
|
13
|
+
**destination_merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
14
|
+
**bank_account_id** | **String** | The destination bank account ID. |
|
|
15
|
+
**account_alias** | **String** | The alias of the bank account. |
|
|
16
|
+
**account_number** | **String** | The bank account number. |
|
|
17
|
+
**swift_code** | **String** | The SWIFT or BIC code of the bank. |
|
|
18
|
+
**currency** | **String** | The currency of the bank account. |
|
|
19
|
+
**beneficiary_name** | **String** | The name of the account holder. |
|
|
20
|
+
**beneficiary_address** | **String** | The address of the account holder. |
|
|
21
|
+
**bank_name** | **String** | The name of the bank. |
|
|
22
|
+
**bank_address** | **String** | The address of the bank. |
|
|
23
|
+
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
24
|
+
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
25
|
+
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
26
|
+
**bank_account_status** | [**BankAccountStatus**](BankAccountStatus.md) | |
|
|
27
|
+
**created_timestamp** | **Number** | The created time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
28
|
+
**updated_timestamp** | **Number** | The updated time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CoboWaas2.DestinationDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**destination_name** | **String** | The destination name. |
|
|
10
|
+
**country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the destination. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the destination. | [optional]
|
|
13
|
+
**wallet_addresses** | [**[WalletAddress]**](WalletAddress.md) | The wallet addresses of the destination. | [optional]
|
|
14
|
+
**bank_accounts** | [**[DestinationBankAccount]**](DestinationBankAccount.md) | The bank accounts of the destination. | [optional]
|
|
15
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
16
|
+
**created_timestamp** | **Number** | The created time of the destination, represented as a UNIX timestamp in seconds. |
|
|
17
|
+
**updated_timestamp** | **Number** | The updated time of the destination, represented as a UNIX timestamp in seconds. |
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.DestinationWalletAddressDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**destination_name** | **String** | The name of the destination. |
|
|
9
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
10
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
11
|
+
**wallet_address_id** | **String** | The wallet address ID. |
|
|
12
|
+
**address** | **String** | The wallet address. |
|
|
13
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
14
|
+
**updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
|
|
16
|
+
|
|
@@ -457,7 +457,7 @@ Name | Type | Description | Notes
|
|
|
457
457
|
|
|
458
458
|
Trigger test event
|
|
459
459
|
|
|
460
|
-
This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload. <Note>Currently, you can only trigger test webhook events with the event data types `Transaction` and `TSSRequest`
|
|
460
|
+
This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload. <Note>Currently, you can only trigger test webhook events with the event data types [`Transaction`](https://www.cobo.com/developers/v2/guides/webhooks-callbacks/webhook-event-type#transaction-events-deposits%2Fwithdrawals%2Fcontract-calls%2Fmessage-signing) and [`TSSRequest`](https://www.cobo.com/developers/v2/guides/webhooks-callbacks/webhook-event-type#mpc-tss-request-events).</Note>
|
|
461
461
|
|
|
462
462
|
### Example
|
|
463
463
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.EnableDestinationWhitelistRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**enable_destination_whitelist** | **Boolean** | Indicates whether to enable the destination whitelist. |
|
|
8
|
+
|
|
9
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
|
-
**address** | **String** | The destination address. |
|
|
8
|
+
**address** | **String** | The destination address. If you are deploying a new contract on an EVM chain, set this address to `0x0000000000000000000000000000000000000000`. |
|
|
9
9
|
**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
|
|
10
10
|
**calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters. |
|
|
11
11
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.ExchangeRate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**token_id** | **String** | The token ID, which identifies the cryptocurrency. |
|
|
8
|
+
**currency** | **String** | The fiat currency. |
|
|
9
|
+
**rate** | **String** | The current exchange rate between the specified currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_id** | **String** | The token ID, which
|
|
7
|
+
**token_id** | **String** | The token ID, which identifies the cryptocurrency. |
|
|
8
8
|
**currency** | **String** | The fiat currency. |
|
|
9
9
|
**rate** | **String** | The current exchange rate between the specified currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
|
|
10
10
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.IntermediaryBankInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**bank_name** | **String** | The name of the intermediary bank. |
|
|
8
|
+
**bank_address** | **String** | The address of the intermediary bank. |
|
|
9
|
+
**bank_swift_code** | **String** | The SWIFT or BIC code of the intermediary bank. |
|
|
10
|
+
|
|
11
|
+
|
package/docs/Link.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**url** | **String** | The base URL of the
|
|
8
|
-
**token** | **String** | The
|
|
7
|
+
**url** | **String** | The base URL of the page. This URL should be combined with the `token` parameter to form the complete link. |
|
|
8
|
+
**token** | **String** | The token appended to the URL as a query parameter. This token identifies and authenticates a specific payment or refund session. The complete link should be constructed as: `[url]?token=[token]` |
|
|
9
9
|
|
|
10
10
|
|
package/docs/LinkDisplayInfo.md
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**developer_name** | **String** | The brand name to display to end users
|
|
8
|
-
**logo** | **String** | The URL of
|
|
7
|
+
**developer_name** | **String** | The brand name to display to end users on the page. This helps users identify who is providing the payment service. | [optional]
|
|
8
|
+
**logo** | **String** | The URL of the logo image to display to end users on the page. | [optional]
|
|
9
|
+
**return_url** | **String** | The URL to redirect to after the operation completes. | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListAllocations200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[AllocationRecord]**](AllocationRecord.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListBatchAllocations200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[BatchAllocation]**](BatchAllocation.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListCounterparties200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[Counterparty]**](Counterparty.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListCounterpartyWalletAddress200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[CounterpartyWalletAddressDetail]**](CounterpartyWalletAddressDetail.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListDestinationBankAccounts200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[DestinationBankAccountDetail]**](DestinationBankAccountDetail.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListDestinationWalletAddresses200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[DestinationWalletAddressDetail]**](DestinationWalletAddressDetail.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListDestinations200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[Destination]**](Destination.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListPayoutItems200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListPayouts200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[PaymentPayout]**](PaymentPayout.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `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
|
**vault_id** | **String** | The vault ID. | [optional]
|
|
9
9
|
**project_id** | **String** | The project ID. | [optional]
|
|
10
10
|
**name** | **String** | The vault name. | [optional]
|
|
@@ -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"`)
|
package/docs/MerchantBalance.md
CHANGED
|
@@ -9,8 +9,10 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
|
|
10
10
|
**total_received_amount** | **String** | The total amount of the token that has been received by the merchant. | [optional]
|
|
11
11
|
**settled_amount** | **String** | The total amount of the token that has been paid out from the merchant's balance. | [optional]
|
|
12
|
+
**payout_amount** | **String** | The merchant payout amount. | [optional]
|
|
12
13
|
**refunded_amount** | **String** | The total amount of the token that has been refunded from the merchant's balance. | [optional]
|
|
13
|
-
**total_balance** | **String** | The
|
|
14
|
-
**available_balance** | **String** |
|
|
14
|
+
**total_balance** | **String** | The current balance of this token available to the merchant for payouts or refunds. `total_balance` = `total_received_amount` - `settled_amount` - `refunded_amount` For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances) | [optional]
|
|
15
|
+
**available_balance** | **String** | The merchant available balance. | [optional]
|
|
16
|
+
**locked_balance** | **String** | The merchant locked balance. | [optional]
|
|
15
17
|
|
|
16
18
|
|
package/docs/OAuthApi.md
CHANGED
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
|
|
18
18
|
Get Access Token
|
|
19
19
|
|
|
20
|
-
This operation acquires an Access Token and a Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk). For security purposes, an Access Token expires after a certain period. Once it expires, you need to call the [Refresh Access Token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-access-token) operation to get a new Access Token and a new Refresh Token.
|
|
20
|
+
<Warning>This operation has been deprecated.</Warning> This operation acquires an Access Token and a Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk). For security purposes, an Access Token expires after a certain period. Once it expires, you need to call the [Refresh Access Token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-access-token) operation to get a new Access Token and a new Refresh Token.
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
|
|
@@ -121,7 +121,7 @@ Name | Type | Description | Notes
|
|
|
121
121
|
|
|
122
122
|
Refresh Access Token
|
|
123
123
|
|
|
124
|
-
This operation refreshes the Access Token and Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk). For security purposes, an Access Token expires after a certain period. Once it expires, you need to call this operation to get a new Access Token and Refresh Token.
|
|
124
|
+
<Warning>This operation has been deprecated.</Warning> This operation refreshes the Access Token and Refresh Token for the [Checkout SDK](https://www.cobo.com/developers/v2_cn/payments/checkout-sdk). For security purposes, an Access Token expires after a certain period. Once it expires, you need to call this operation to get a new Access Token and Refresh Token.
|
|
125
125
|
|
|
126
126
|
### Example
|
|
127
127
|
|
package/docs/Order.md
CHANGED
|
@@ -6,23 +6,26 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**order_id** | **String** | The order ID. |
|
|
8
8
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
9
|
-
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
10
|
-
**chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. Supported chains: - USDC: `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` - USDT: `TRON`, `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` |
|
|
11
|
-
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
12
|
-
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
13
|
-
**currency** | **String** | The fiat currency of the order. |
|
|
14
|
-
**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). |
|
|
15
|
-
**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. |
|
|
16
|
-
**exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
|
|
17
|
-
**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
9
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
|
|
19
10
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
11
|
+
**pricing_currency** | **String** | The fiat currency of the order. | [optional]
|
|
12
|
+
**pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional]
|
|
13
|
+
**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. |
|
|
14
|
+
**payable_currency** | **String** | The ID of the cryptocurrency used for payment. | [optional]
|
|
15
|
+
**chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. |
|
|
16
|
+
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
17
|
+
**exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
|
|
18
|
+
**amount_tolerance** | **String** | Allowed amount deviation. | [optional]
|
|
19
|
+
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
20
20
|
**status** | [**OrderStatus**](OrderStatus.md) | |
|
|
21
21
|
**received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
|
22
|
-
**
|
|
23
|
-
**
|
|
24
|
-
**
|
|
22
|
+
**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional]
|
|
23
|
+
**created_timestamp** | **Number** | The created time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
24
|
+
**updated_timestamp** | **Number** | The updated time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
25
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the settlement process. | [optional]
|
|
26
|
+
**currency** | **String** | The fiat currency of the order. | [optional]
|
|
27
|
+
**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional]
|
|
28
|
+
**token_id** | **String** | The ID of the cryptocurrency used for payment. | [optional]
|
|
25
29
|
**settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
26
|
-
**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur. When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`. | [optional]
|
|
27
30
|
|
|
28
31
|
|
|
@@ -4,16 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_ids** | **[String]** | An array of token IDs representing the cryptocurrencies and chains available for payment. These options will be shown to users on the payment page for them to choose from. Supported token IDs include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
8
|
-
**custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) | A list of custom exchange rates defining how much one unit of a specific cryptocurrency (`token_id`) is valued in the selected fiat or crypto currency (`currency`). If this field is omitted, the system’s default exchange rates will apply. Each item specifies a `token_id` and its corresponding `exchange_rate`. For example, to treat 1 USDT (on Ethereum) as equivalent to 0.99 USD, provide: ```json { \"custom_exchange_rates\": [ { \"token_id\": \"ETH_USDT\", \"exchange_rate\": \"0.99\" } ], \"currency\": \"USD\" } ``` | [optional]
|
|
9
|
-
**currency** | **String** | The currency in which both the order amount (`order_amount`) and the developer fee (`fee_amount`) are denominated. Only the following values are supported: `USD`, `USDT`, or `USDC`. |
|
|
10
|
-
**fee_amount** | **String** | The developer fee for the order, denominated in the currency specified by `currency`. If you are a merchant directly serving payers, set this field to `0`. Developer fees are only relevant for platforms like payment service providers (PSPs) that charge fees to their downstream merchants. The developer fee is added to the base amount (`order_amount`) to determine the final charge. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\" - Total charged to customer: \"102.00\" Values can contain up to two decimal places. |
|
|
11
7
|
**merchant_id** | **String** | The merchant ID. |
|
|
12
|
-
**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), denominated in the currency specified by `currency`. Values must be greater than `0` and contain two decimal places. |
|
|
13
8
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters. | [optional]
|
|
14
9
|
**psp_order_code** | **String** | A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters. |
|
|
10
|
+
**pricing_currency** | **String** | The currency for the base order amount and the developer fee. Currently, only `USD`/`USDT`/`USDC` are supported. | [optional]
|
|
11
|
+
**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`. If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`. Values must be greater than `0` and contain two decimal places. | [optional]
|
|
12
|
+
**fee_amount** | **String** | The developer fee for the order, in the currency specified by `currency`. If `currency` is not specified, the fee is in the cryptocurrency specified by `token_id`. If you are a merchant directly serving payers, set this field to `0`. Developer fees are only relevant for platforms like payment service providers (PSPs) that charge fees to their downstream merchants. The developer fee is added to the base amount (`order_amount`) to determine the final charge. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\" - Total charged to customer: \"102.00\" Values can contain up to two decimal places. |
|
|
13
|
+
**payable_currencies** | **[String]** | List of supported cryptocurrency token IDs for this payment. Each token ID must be from the supported values. | [optional]
|
|
14
|
+
**payable_amounts** | [**[OrderLinkBusinessInfoPayableAmountsInner]**](OrderLinkBusinessInfoPayableAmountsInner.md) | Optional list of payable amounts for different tokens. If provided, these amounts will be used instead of calculating the amounts based on the exchange rate. | [optional]
|
|
15
15
|
**expired_in** | **Number** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration: - 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] [default to 1800]
|
|
16
|
-
**
|
|
17
|
-
**
|
|
16
|
+
**amount_tolerance** | **String** | Allowed amount deviation, precision to 1 decimal place. | [optional]
|
|
17
|
+
**currency** | **String** | The currency for the base order amount and the developer fee. Currently, only `USD`/`USDT`/`USDC` are supported. | [optional]
|
|
18
|
+
**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`. If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`. Values must be greater than `0` and contain two decimal places. | [optional]
|
|
19
|
+
**token_ids** | **[String]** | List of supported cryptocurrency token IDs for this payment. Each token ID must be from the supported values. | [optional]
|
|
20
|
+
**custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) | Optional list of final exchange rates for different tokens. If provided, these rates will be used instead of real-time market rates. | [optional]
|
|
21
|
+
**use_dedicated_address** | **Boolean** | Whether to allocate a dedicated address for this order. - `true`: A dedicated address will be allocated for this order. - `false`: A shared address from the address pool will be used. | [optional]
|
|
18
22
|
|
|
19
23
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_id** | **String** | The token ID
|
|
8
|
-
**exchange_rate** | **String** | The exchange rate to use for this token
|
|
7
|
+
**token_id** | **String** | The cryptocurrency token ID |
|
|
8
|
+
**exchange_rate** | **String** | The fixed exchange rate to use for this token |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.OrderLinkBusinessInfoPayableAmountsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**token_id** | **String** | The cryptocurrency token ID |
|
|
8
|
+
**amount** | **String** | The actual payable amount of the order in the cryptocurrency. |
|
|
9
|
+
|
|
10
|
+
|