@cobo/cobo-waas2 1.29.0 → 1.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -9
- package/dist/ApiClient.js +1 -1
- package/dist/api/ComplianceApi.js +2 -2
- package/dist/api/GraphQLApi.js +85 -0
- package/dist/api/PaymentApi.js +218 -86
- package/dist/api/SwapsApi.js +3 -0
- package/dist/api/WalletsApi.js +18 -18
- package/dist/index.js +112 -28
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/{AllocationRecord.js → AllocationItem.js} +42 -42
- package/dist/model/{AllocationRequest.js → AllocationParam.js} +33 -33
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/BatchAllocation.js +11 -11
- package/dist/model/BatchAllocationDetail.js +15 -17
- package/dist/model/BridgingFee.js +3 -3
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
- package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +8 -3
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +8 -3
- package/dist/model/ContractCallParams.js +1 -1
- package/dist/model/CreateBatchAllocationRequest.js +17 -17
- package/dist/model/CreateBulkSendRequest.js +167 -0
- package/dist/model/CreateBulkSendRequestPayoutParamsInner.js +153 -0
- package/dist/model/CreateKyaScreeningsBody.js +3 -3
- package/dist/model/CreatePaymentOrderRequest.js +7 -5
- package/dist/model/CreatePayoutRequest.js +33 -26
- package/dist/model/CreateTopUpAddresses.js +139 -0
- package/dist/model/CreateTopUpAddresses201Response.js +107 -0
- package/dist/model/{ListAllocations200Response.js → ListAllocationItems200Response.js} +22 -22
- package/dist/model/{ListPayoutItems200Response.js → ListBulkSendItems200Response.js} +22 -22
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/OrderLinkBusinessInfo.js +10 -4
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentBulkSend.js +182 -0
- package/dist/model/PaymentBulkSendEvent.js +359 -0
- package/dist/model/PaymentBulkSendExecutionMode.js +61 -0
- package/dist/model/PaymentBulkSendItem.js +190 -0
- package/dist/model/{PaymentPayoutItemStatus.js → PaymentBulkSendItemStatus.js} +11 -11
- package/dist/model/PaymentBulkSendItemValidationStatus.js +66 -0
- package/dist/model/PaymentBulkSendStatus.js +81 -0
- package/dist/model/PaymentEstimateFeeRequest.js +13 -0
- package/dist/model/PaymentFeeType.js +15 -0
- package/dist/model/PaymentOrderEventData.js +8 -3
- package/dist/model/PaymentPayout.js +64 -46
- package/dist/model/PaymentPayoutDetail.js +166 -52
- package/dist/model/PaymentPayoutEvent.js +149 -82
- package/dist/model/PaymentPayoutItem.js +9 -167
- package/dist/model/PaymentPayoutParam.js +6 -47
- package/dist/model/PaymentPayoutRecipientInfo.js +126 -0
- package/dist/model/PaymentPayoutStatus.js +9 -4
- package/dist/model/PaymentRefundEventData.js +8 -3
- package/dist/model/PaymentSettlementEvent.js +8 -3
- package/dist/model/PaymentTransactionEventData.js +8 -3
- package/dist/model/SuspendedTokenEventData.js +8 -3
- 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/TransactionExtraType.js +5 -0
- package/dist/model/TransactionWalletConnectInfo.js +146 -0
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEventData.js +76 -17
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +10 -0
- package/docs/AddressesEventData.md +3 -1
- package/docs/AllocationItem.md +15 -0
- package/docs/AllocationParam.md +13 -0
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/BatchAllocation.md +1 -1
- package/docs/BatchAllocationDetail.md +1 -1
- package/docs/BridgingFee.md +2 -2
- package/docs/ChainsEventData.md +3 -1
- package/docs/ComplianceApi.md +1 -1
- package/docs/ComplianceDispositionUpdateEventData.md +3 -1
- package/docs/ComplianceKyaScreeningsUpdateEventData.md +3 -1
- package/docs/ComplianceKytScreeningsUpdateEventData.md +3 -1
- package/docs/ContractCallParams.md +1 -1
- package/docs/CreateBatchAllocationRequest.md +1 -1
- package/docs/CreateBulkSendRequest.md +12 -0
- package/docs/CreateBulkSendRequestPayoutParamsInner.md +12 -0
- package/docs/CreateKyaScreeningsBody.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +2 -2
- package/docs/CreatePayoutRequest.md +3 -3
- package/docs/CreateTopUpAddresses.md +11 -0
- package/docs/CreateTopUpAddresses201Response.md +9 -0
- package/docs/GraphQLApi.md +61 -0
- package/docs/{ListAllocations200Response.md → ListAllocationItems200Response.md} +2 -2
- package/docs/{ListPayoutItems200Response.md → ListBulkSendItems200Response.md} +2 -2
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/OrderLinkBusinessInfo.md +3 -3
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentApi.md +231 -76
- package/docs/PaymentBulkSend.md +15 -0
- package/docs/PaymentBulkSendEvent.md +65 -0
- package/docs/PaymentBulkSendExecutionMode.md +12 -0
- package/docs/PaymentBulkSendItem.md +15 -0
- package/docs/{PaymentPayoutItemStatus.md → PaymentBulkSendItemStatus.md} +3 -3
- package/docs/PaymentBulkSendItemValidationStatus.md +14 -0
- package/docs/PaymentBulkSendStatus.md +20 -0
- package/docs/PaymentEstimateFeeRequest.md +1 -0
- package/docs/PaymentFeeType.md +6 -0
- package/docs/PaymentOrderEventData.md +3 -1
- package/docs/PaymentPayout.md +8 -7
- package/docs/PaymentPayoutDetail.md +10 -8
- package/docs/PaymentPayoutEvent.md +13 -9
- package/docs/PaymentPayoutItem.md +2 -13
- package/docs/PaymentPayoutParam.md +1 -4
- package/docs/PaymentPayoutRecipientInfo.md +12 -0
- package/docs/PaymentPayoutStatus.md +4 -2
- package/docs/PaymentRefundEventData.md +3 -1
- package/docs/PaymentSettlementEvent.md +3 -1
- package/docs/PaymentTransactionEventData.md +3 -1
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/SwapsApi.md +2 -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/TransactionExtraType.md +2 -0
- package/docs/TransactionWalletConnectInfo.md +12 -0
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletsApi.md +9 -9
- package/docs/WebhookEventData.md +15 -8
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +4 -0
- package/package.json +1 -1
- package/dist/model/PaymentPayoutItemDetail.js +0 -299
- package/docs/AllocationRecord.md +0 -15
- package/docs/AllocationRequest.md +0 -13
- package/docs/PaymentPayoutItemDetail.md +0 -22
package/docs/BatchAllocation.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**batch_allocation_id** | **String** | The batch allocation ID generated by Cobo. |
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the batch allocation. |
|
|
9
|
-
**
|
|
9
|
+
**allocation_params** | [**[AllocationParam]**](AllocationParam.md) | | [optional]
|
|
10
10
|
**initiator** | **String** | The initiator of this batch allocation, usually the API key you used to create the batch allocation. | [optional]
|
|
11
11
|
**created_timestamp** | **Number** | The created time of the batch allocation, represented as a UNIX timestamp in seconds. |
|
|
12
12
|
**updated_timestamp** | **Number** | The updated time of the batch allocation, represented as a UNIX timestamp in seconds. |
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**batch_allocation_id** | **String** | The batch allocation ID generated by Cobo. |
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the batch allocation. |
|
|
9
|
-
**
|
|
9
|
+
**allocation_items** | [**[AllocationItem]**](AllocationItem.md) | | [optional]
|
|
10
10
|
**initiator** | **String** | The initiator of this batch allocation, usually the user's API key. | [optional]
|
|
11
11
|
**created_timestamp** | **Number** | The created time of the batch allocation, represented as a UNIX timestamp in seconds. | [optional]
|
|
12
12
|
**updated_timestamp** | **Number** | The updated time of the batch allocation, represented as a UNIX timestamp in seconds. | [optional]
|
package/docs/BridgingFee.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**fee_amount** | **String** | The fee charged for bridging tokens to another
|
|
7
|
+
**fee_amount** | **String** | The fee charged for bridging tokens to another chain. |
|
|
8
8
|
**received_token_id** | **String** | The ID of the destination token received after bridging. | [optional]
|
|
9
|
-
**received_amount** | **String** | The final amount of
|
|
9
|
+
**received_amount** | **String** | The final amount of the token received after bridging. | [optional]
|
|
10
10
|
|
|
11
11
|
|
package/docs/ChainsEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**chains** | [**[ChainInfo]**](ChainInfo.md) | The enabled chains. |
|
|
9
9
|
**wallet_type** | [**WalletType**](WalletType.md) | | [optional]
|
|
10
10
|
**wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | | [optional]
|
|
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
42
42
|
|
|
43
43
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
44
44
|
|
|
45
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
46
|
+
|
|
45
47
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
46
48
|
|
|
47
49
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/ComplianceApi.md
CHANGED
|
@@ -23,7 +23,7 @@ Method | HTTP request | Description
|
|
|
23
23
|
|
|
24
24
|
Create KYA address screening requests
|
|
25
25
|
|
|
26
|
-
This operation submits up to 50 address screening requests in one
|
|
26
|
+
This operation submits up to 50 address screening requests in one call to assess address compliance and risk levels. <Note>This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries.</Note>
|
|
27
27
|
|
|
28
28
|
### Example
|
|
29
29
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**disposition_type** | [**DispositionType**](DispositionType.md) | |
|
|
10
10
|
**disposition_status** | [**DispositionStatus**](DispositionStatus.md) | |
|
|
@@ -45,6 +45,8 @@ Name | Type | Description | Notes
|
|
|
45
45
|
|
|
46
46
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
47
47
|
|
|
48
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
49
|
+
|
|
48
50
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
49
51
|
|
|
50
52
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**screening_id** | **String** | The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). |
|
|
9
9
|
**address** | **String** | The screened blockchain address. |
|
|
10
10
|
**chain_id** | **String** | The chain identifier. |
|
|
@@ -45,6 +45,8 @@ Name | Type | Description | Notes
|
|
|
45
45
|
|
|
46
46
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
47
47
|
|
|
48
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
49
|
+
|
|
48
50
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
49
51
|
|
|
50
52
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) | |
|
|
10
10
|
**review_status** | [**ReviewStatusType**](ReviewStatusType.md) | |
|
|
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
|
|
|
44
44
|
|
|
45
45
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
46
46
|
|
|
47
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
48
|
+
|
|
47
49
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
48
50
|
|
|
49
51
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**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). |
|
|
9
9
|
**source** | [**ContractCallSource**](ContractCallSource.md) | |
|
|
10
10
|
**destination** | [**ContractCallDestination**](ContractCallDestination.md) | |
|
|
11
|
-
**description** | **String** | The description of the contract call transaction. | [optional]
|
|
11
|
+
**description** | **String** | The description of the contract call transaction. Maximum length is 2048 characters for MPC Wallets and Custodial Wallets (Web3 Wallets), and 1000 characters for Custodial Wallets (Asset Wallets). | [optional]
|
|
12
12
|
**category_names** | **[String]** | The custom category for you to identify your transactions. | [optional]
|
|
13
13
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
14
14
|
**transaction_process_type** | [**TransactionProcessType**](TransactionProcessType.md) | | [optional]
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**request_id** | **String** | The request ID that is used to track a batch allocation request. The request ID is provided by you and must be unique. |
|
|
8
|
-
**
|
|
8
|
+
**allocation_params** | [**[AllocationParam]**](AllocationParam.md) | |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.CreateBulkSendRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**source_account** | **String** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. |
|
|
8
|
+
**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | |
|
|
9
|
+
**description** | **String** | The description for the entire bulk send batch. | [optional]
|
|
10
|
+
**payout_params** | [**[CreateBulkSendRequestPayoutParamsInner]**](CreateBulkSendRequestPayoutParamsInner.md) | The bulk send items. |
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.CreateBulkSendRequestPayoutParamsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**token_id** | **String** | The token ID of the cryptocurrency to be sent to the recipient. |
|
|
8
|
+
**receiving_address** | **String** | The receiving address. |
|
|
9
|
+
**amount** | **String** | The amount of the cryptocurrency to be sent to the recipient. |
|
|
10
|
+
**description** | **String** | A note or comment about the bulk send item. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**screenings** | [**[KyaScreeningRequest]**](KyaScreeningRequest.md) | List of address screening requests. Maximum 50 addresses per
|
|
7
|
+
**screenings** | [**[KyaScreeningRequest]**](KyaScreeningRequest.md) | List of address screening requests. Maximum 50 addresses per call. |
|
|
8
8
|
|
|
9
9
|
|
|
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. |
|
|
8
8
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
|
|
9
9
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
10
|
-
**pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`.
|
|
10
|
+
**pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com/developers/v2/guides/overview/supported-chains-and-tokens). | [optional]
|
|
11
11
|
**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional]
|
|
12
12
|
**fee_amount** | **String** | The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. |
|
|
13
|
-
**payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
13
|
+
**payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
14
14
|
**payable_amount** | **String** | The total amount the payer needs to pay, denominated in the specified `payable_currency`. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. | [optional]
|
|
15
15
|
**expired_in** | **Number** | The pay-in order will expire after approximately a certain number of seconds: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. | [optional]
|
|
16
16
|
**amount_tolerance** | **String** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional]
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**request_id** | **String** | The request ID that is used to track a payout request. The request ID is provided by you and must be unique. |
|
|
8
|
+
**source_account** | **String** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. |
|
|
8
9
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
9
10
|
**payout_params** | [**[PaymentPayoutParam]**](PaymentPayoutParam.md) | |
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**remark** | **String** | The remark for the payout. | [optional]
|
|
11
|
+
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | |
|
|
12
|
+
**remark** | **String** | An optional note or comment about the payout for your internal reference. | [optional]
|
|
13
13
|
|
|
14
14
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.CreateTopUpAddresses
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**merchant_id** | **String** | The merchant ID. If not provided, the default merchant created during organization initialization will be used. | [optional]
|
|
8
|
+
**token_id** | **String** | The token ID, which identifies the cryptocurrency. |
|
|
9
|
+
**custom_payer_ids** | **[String]** | A list of unique custom payer IDs required to create top-up addresses. The maximum number of items is 50. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# CoboWaas2.GraphQLApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**executeGraphql**](GraphQLApi.md#executeGraphql) | **POST** /graphql | Execute a GraphQL query or mutation
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## executeGraphql
|
|
12
|
+
|
|
13
|
+
> GraphQLResponse executeGraphql(opts)
|
|
14
|
+
|
|
15
|
+
Execute a GraphQL query or mutation
|
|
16
|
+
|
|
17
|
+
This endpoint executes a GraphQL query or mutation. The request body must include a valid GraphQL query string.
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```javascript
|
|
22
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
23
|
+
// Initialize the API client
|
|
24
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
25
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
26
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
27
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
28
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
29
|
+
// Call the API
|
|
30
|
+
const apiInstance = new CoboWaas2.GraphQLApi();
|
|
31
|
+
const opts = {
|
|
32
|
+
'GraphQLRequest': new CoboWaas2.GraphQLRequest()
|
|
33
|
+
};
|
|
34
|
+
apiInstance.executeGraphql(opts).then((data) => {
|
|
35
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
36
|
+
}, (error) => {
|
|
37
|
+
console.error(error);
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
Name | Type | Description | Notes
|
|
46
|
+
------------- | ------------- | ------------- | -------------
|
|
47
|
+
**GraphQLRequest** | [**GraphQLRequest**](GraphQLRequest.md)| The request body to generate addresses within a specified wallet. | [optional]
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
[**GraphQLResponse**](GraphQLResponse.md)
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[CoboNonce](../README.md#CoboNonce), [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth), [CoboSignature](../README.md#CoboSignature)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: application/json
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# CoboWaas2.
|
|
1
|
+
# CoboWaas2.ListAllocationItems200Response
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data** | [**[
|
|
7
|
+
**data** | [**[AllocationItem]**](AllocationItem.md) | | [optional]
|
|
8
8
|
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# CoboWaas2.
|
|
1
|
+
# CoboWaas2.ListBulkSendItems200Response
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data** | [**[
|
|
7
|
+
**data** | [**[PaymentBulkSendItem]**](PaymentBulkSendItem.md) | | [optional]
|
|
8
8
|
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
9
|
|
|
10
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. - `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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**vault_id** | **String** | The vault ID. | [optional]
|
|
9
9
|
**project_id** | **String** | The project ID. | [optional]
|
|
10
10
|
**name** | **String** | The vault name. | [optional]
|
|
@@ -45,6 +45,8 @@ Name | Type | Description | Notes
|
|
|
45
45
|
|
|
46
46
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
47
47
|
|
|
48
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
49
|
+
|
|
48
50
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
49
51
|
|
|
50
52
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. |
|
|
8
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]
|
|
9
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 pricing currency that denominates `pricing_amount` and `fee_amount`. Currently, only `USD`/`USDT`/`USDC` are supported. This field is required. |
|
|
11
|
-
**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. |
|
|
10
|
+
**pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. Currently, only `USD`/`USDT`/`USDC` are supported. This field is required. |
|
|
11
|
+
**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. |
|
|
12
12
|
**fee_amount** | **String** | The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. |
|
|
13
|
-
**payable_currencies** | **[String]** | The IDs of the cryptocurrencies used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
13
|
+
**payable_currencies** | **[String]** | The IDs of the cryptocurrencies used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
14
14
|
**payable_amounts** | [**[OrderLinkBusinessInfoPayableAmountsInner]**](OrderLinkBusinessInfoPayableAmountsInner.md) | The total amounts the payer needs to pay for each currency in `payable_currencies`. If this field is left blank, the system will automatically calculate the amounts at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. | [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
16
|
**amount_tolerance** | **String** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
9
9
|
**payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. |
|
|
10
10
|
**chain** | **String** | The chain ID. |
|
|
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
|
|
|
44
44
|
|
|
45
45
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
46
46
|
|
|
47
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
48
|
+
|
|
47
49
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
48
50
|
|
|
49
51
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|