@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/PaymentPayout.md
CHANGED
|
@@ -7,13 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**payout_id** | **String** | The payout ID generated by Cobo. |
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the payout. |
|
|
9
9
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
10
|
-
**
|
|
10
|
+
**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\"`. | [optional]
|
|
11
|
+
**payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
|
|
12
|
+
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
13
|
+
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
14
|
+
**actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
|
|
11
15
|
**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**currency** | **String** | The fiat currency you will receive from the payout. | [optional]
|
|
16
|
-
**actual_payout_amount** | **String** | The total amount of cryptocurrency actually paid out for this payout. | [optional]
|
|
17
|
-
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
16
|
+
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
17
|
+
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
18
|
+
**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
|
|
18
19
|
|
|
19
20
|
|
|
@@ -6,14 +6,16 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**payout_id** | **String** | The payout ID generated by Cobo. |
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the payout. |
|
|
9
|
+
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
10
|
+
**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\"`. | [optional]
|
|
11
|
+
**payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
|
|
12
|
+
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
13
|
+
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
14
|
+
**actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
|
|
9
15
|
**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
|
|
10
|
-
**
|
|
11
|
-
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
12
|
-
**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
|
|
13
|
-
**
|
|
14
|
-
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
15
|
-
**currency** | **String** | The fiat currency you will receive from the payout. | [optional]
|
|
16
|
-
**actual_payout_amount** | **String** | The total amount of cryptocurrency actually paid out for this payout. | [optional]
|
|
17
|
-
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
16
|
+
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
17
|
+
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
18
|
+
**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
|
|
19
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional]
|
|
18
20
|
|
|
19
21
|
|
|
@@ -4,18 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `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
|
**payout_id** | **String** | The payout ID generated by Cobo. |
|
|
9
9
|
**request_id** | **String** | The request ID provided by you when creating the payout. |
|
|
10
|
+
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
11
|
+
**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\"`. | [optional]
|
|
12
|
+
**payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
|
|
13
|
+
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
14
|
+
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
15
|
+
**actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
|
|
10
16
|
**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
|
|
11
|
-
**
|
|
12
|
-
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
13
|
-
**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
|
|
14
|
-
**
|
|
15
|
-
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
16
|
-
**currency** | **String** | The fiat currency you will receive from the payout. | [optional]
|
|
17
|
-
**actual_payout_amount** | **String** | The total amount of cryptocurrency actually paid out for this payout. | [optional]
|
|
18
|
-
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
17
|
+
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
18
|
+
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
19
|
+
**updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
|
|
20
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional]
|
|
19
21
|
|
|
20
22
|
|
|
21
23
|
|
|
@@ -50,6 +52,8 @@ Name | Type | Description | Notes
|
|
|
50
52
|
|
|
51
53
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
52
54
|
|
|
55
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
56
|
+
|
|
53
57
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
54
58
|
|
|
55
59
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -4,19 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**token_id** | **String** | The ID of the cryptocurrency paid out. | [optional]
|
|
10
|
-
**chain_id** | **String** | The ID of the blockchain network on which the payout occurred. | [optional]
|
|
11
|
-
**amount** | **String** | The amount of the cryptocurrency to pay out. |
|
|
12
|
-
**status** | [**PaymentPayoutItemStatus**](PaymentPayoutItemStatus.md) | |
|
|
13
|
-
**source_account** | **String** | The source account from which the payout was 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\"`. |
|
|
14
|
-
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this payout item. Each transaction represents a separate blockchain operation related to the payout item process. | [optional]
|
|
15
|
-
**created_timestamp** | **Number** | The created time of the payout item, represented as a UNIX timestamp in seconds. | [optional]
|
|
16
|
-
**updated_timestamp** | **Number** | The updated time of the payout item, represented as a UNIX timestamp in seconds. | [optional]
|
|
17
|
-
**crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. | [optional]
|
|
18
|
-
**crypto_address** | **String** | The actual blockchain address to which funds were transferred. | [optional]
|
|
19
|
-
**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
|
|
7
|
+
**token_id** | **String** | The token ID of the payout item. |
|
|
8
|
+
**amount** | **String** | The amount of the payout item. |
|
|
20
9
|
**bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional]
|
|
21
10
|
|
|
22
11
|
|
|
@@ -4,10 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**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
7
|
**token_id** | **String** | The ID of the cryptocurrency you want to pay out. Specify this field when `payout_channel` is set to `Crypto`. 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` |
|
|
9
|
-
**amount** | **String** | The
|
|
10
|
-
**crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. Specify this field when `payout_channel` is set to `Crypto`. Call [List crypto addresses](https://www.cobo.com/payments/en/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses. | [optional]
|
|
11
|
-
**crypto_address** | **String** | The actual blockchain address to which funds will be transferred. Specify this field when `payout_channel` is set to `Crypto`. <Note> If you have enabled the *Use Destinations as Payout Whitelist* toggle in *Destinations*, you can only transfer to registered destinations. For more details, see [Destinations](https://www.cobo.com/payments/en/guides/destinations). </Note> | [optional]
|
|
8
|
+
**amount** | **String** | The payout cryptocurrency amount. |
|
|
12
9
|
|
|
13
10
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.PaymentPayoutRecipientInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**address** | **String** | The recipient's wallet address where the payout will be sent. | [optional]
|
|
8
|
+
**token_id** | **String** | The token ID for the cryptocurrency to be sent to the recipient. If `recipient_info.token_id` is on a different chain than `payout_param.token_id`, the token will be automatically bridged to the chain specified in `recipient_info.token_id`. | [optional]
|
|
9
|
+
**currency** | **String** | The fiat currency of the bank account to which the payout will be sent. | [optional]
|
|
10
|
+
**bank_account_id** | **String** | The ID of the bank account to which the payout will be sent. You can retrieve the bank account ID by calling [List destination entries](https://www.cobo.com/payments/en/api-references/payment/list-destination-entries). | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -5,7 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
* `Pending` (value: `"Pending"`)
|
|
7
7
|
|
|
8
|
-
* `
|
|
8
|
+
* `Preparing` (value: `"Preparing"`)
|
|
9
|
+
|
|
10
|
+
* `Transferring` (value: `"Transferring"`)
|
|
9
11
|
|
|
10
12
|
* `Completed` (value: `"Completed"`)
|
|
11
13
|
|
|
@@ -13,7 +15,7 @@
|
|
|
13
15
|
|
|
14
16
|
* `Failed` (value: `"Failed"`)
|
|
15
17
|
|
|
16
|
-
* `
|
|
18
|
+
* `RejectedByBank` (value: `"RejectedByBank"`)
|
|
17
19
|
|
|
18
20
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
19
21
|
|
|
@@ -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
|
**request_id** | **String** | The request ID provided by you when creating the refund request. | [optional]
|
|
9
9
|
**refund_id** | **String** | The refund order ID. |
|
|
10
10
|
**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional]
|
|
@@ -57,6 +57,8 @@ Name | Type | Description | Notes
|
|
|
57
57
|
|
|
58
58
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
59
59
|
|
|
60
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
61
|
+
|
|
60
62
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
61
63
|
|
|
62
64
|
* `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
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
|
|
9
9
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
10
10
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
@@ -52,6 +52,8 @@ Name | Type | Description | Notes
|
|
|
52
52
|
|
|
53
53
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
54
54
|
|
|
55
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
56
|
+
|
|
55
57
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
56
58
|
|
|
57
59
|
* `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
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
@@ -75,6 +75,8 @@ Name | Type | Description | Notes
|
|
|
75
75
|
|
|
76
76
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
77
77
|
|
|
78
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
79
|
+
|
|
78
80
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
79
81
|
|
|
80
82
|
* `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
|
**token_ids** | **String** | A list of token IDs, separated by comma. |
|
|
9
9
|
**operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
|
|
10
10
|
|
|
@@ -41,6 +41,8 @@ Name | Type | Description | Notes
|
|
|
41
41
|
|
|
42
42
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
43
43
|
|
|
44
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
45
|
+
|
|
44
46
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
45
47
|
|
|
46
48
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/SwapsApi.md
CHANGED
|
@@ -244,6 +244,7 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
244
244
|
// Call the API
|
|
245
245
|
const apiInstance = new CoboWaas2.SwapsApi();
|
|
246
246
|
const opts = {
|
|
247
|
+
'request_id': "web_send_by_user_327_1610444045047",
|
|
247
248
|
'type': new CoboWaas2.SwapType(),
|
|
248
249
|
'status': new CoboWaas2.SwapActivityStatus(),
|
|
249
250
|
'min_updated_timestamp': 1635744000000,
|
|
@@ -268,6 +269,7 @@ apiInstance.listSwapActivities(opts).then((data) => {
|
|
|
268
269
|
|
|
269
270
|
Name | Type | Description | Notes
|
|
270
271
|
------------- | ------------- | ------------- | -------------
|
|
272
|
+
**request_id** | **String**| The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
271
273
|
**type** | [**SwapType**](.md)| | [optional]
|
|
272
274
|
**status** | [**SwapActivityStatus**](.md)| | [optional]
|
|
273
275
|
**min_updated_timestamp** | **Number**| The start time of the query. All swap activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [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
|
**tss_request_id** | **String** | The TSS request ID. | [optional]
|
|
9
9
|
**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
|
|
10
10
|
**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
|
|
@@ -46,6 +46,8 @@ Name | Type | Description | Notes
|
|
|
46
46
|
|
|
47
47
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
48
48
|
|
|
49
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
50
|
+
|
|
49
51
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
50
52
|
|
|
51
53
|
* `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
|
**request_id** | **String** | The unique identifier of the token listing request. |
|
|
9
9
|
**chain_id** | **String** | The ID of the blockchain where the token is deployed. |
|
|
10
10
|
**contract_address** | **String** | The token's contract address on the specified blockchain. |
|
|
@@ -50,6 +50,8 @@ Name | Type | Description | Notes
|
|
|
50
50
|
|
|
51
51
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
52
52
|
|
|
53
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
54
|
+
|
|
53
55
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
54
56
|
|
|
55
57
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/TokensEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `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
|
**tokens** | [**[TokenInfo]**](TokenInfo.md) | The enabled tokens. |
|
|
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"`)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TransactionWalletConnectInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**extra_type** | [**TransactionExtraType**](TransactionExtraType.md) | |
|
|
8
|
+
**dapp_name** | **String** | The dapp name that initiated this transaction. | [optional]
|
|
9
|
+
**dapp_domain** | **String** | The dapp domain that initiated this transaction | [optional]
|
|
10
|
+
**session_id** | **String** | The session id that initiated this transaction | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `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
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
@@ -70,6 +70,8 @@ Name | Type | Description | Notes
|
|
|
70
70
|
|
|
71
71
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
72
72
|
|
|
73
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
74
|
+
|
|
73
75
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
74
76
|
|
|
75
77
|
* `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
|
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -40,6 +40,8 @@ Name | Type | Description | Notes
|
|
|
40
40
|
|
|
41
41
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
42
42
|
|
|
43
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
44
|
+
|
|
43
45
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
44
46
|
|
|
45
47
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
package/docs/WalletsApi.md
CHANGED
|
@@ -932,7 +932,7 @@ Name | Type | Description | Notes
|
|
|
932
932
|
------------- | ------------- | ------------- | -------------
|
|
933
933
|
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
934
934
|
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
935
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
935
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
936
936
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
937
937
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
938
938
|
|
|
@@ -994,9 +994,9 @@ Name | Type | Description | Notes
|
|
|
994
994
|
------------- | ------------- | ------------- | -------------
|
|
995
995
|
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
996
996
|
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
997
|
-
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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). | [optional]
|
|
998
|
-
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
999
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
997
|
+
**chain_ids** | **String**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID 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). | [optional]
|
|
998
|
+
**token_ids** | **String**| A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
999
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
1000
1000
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
1001
1001
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
1002
1002
|
|
|
@@ -1057,8 +1057,8 @@ Name | Type | Description | Notes
|
|
|
1057
1057
|
------------- | ------------- | ------------- | -------------
|
|
1058
1058
|
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
1059
1059
|
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
1060
|
-
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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). | [optional]
|
|
1061
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
1060
|
+
**chain_ids** | **String**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID 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). | [optional]
|
|
1061
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
1062
1062
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
1063
1063
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
1064
1064
|
|
|
@@ -1120,9 +1120,9 @@ Name | Type | Description | Notes
|
|
|
1120
1120
|
------------- | ------------- | ------------- | -------------
|
|
1121
1121
|
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
1122
1122
|
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
1123
|
-
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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). | [optional]
|
|
1124
|
-
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
1125
|
-
**limit** | **Number**| The maximum number of objects to return.
|
|
1123
|
+
**chain_ids** | **String**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID 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). | [optional]
|
|
1124
|
+
**token_ids** | **String**| A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
1125
|
+
**limit** | **Number**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10]
|
|
1126
1126
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
1127
1127
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
1128
1128
|
|
package/docs/WebhookEventData.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
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID provided by you when creating the payout. |
|
|
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
21
21
|
**result** | [**TransactionResult**](TransactionResult.md) | | [optional]
|
|
22
22
|
**fee** | [**TransactionFee**](TransactionFee.md) | | [optional]
|
|
23
|
-
**initiator** | **String** | The initiator of this payout, usually the API key
|
|
23
|
+
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
24
24
|
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | |
|
|
25
25
|
**confirmed_num** | **Number** | The number of confirmations this transaction has received. | [optional]
|
|
26
26
|
**confirming_threshold** | **Number** | The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. | [optional]
|
|
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**raw_tx_info** | [**TransactionRawTxInfo**](TransactionRawTxInfo.md) | | [optional]
|
|
30
30
|
**replacement** | [**TransactionReplacement**](TransactionReplacement.md) | | [optional]
|
|
31
31
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
32
|
-
**description** | **String** | The description for
|
|
32
|
+
**description** | **String** | The description for the entire bulk send batch. | [optional]
|
|
33
33
|
**is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer. | [optional]
|
|
34
34
|
**cobo_category** | **[String]** | The transaction category defined by Cobo. For more details, refer to [Cobo-defined categories](/v2/guides/transactions/manage-transactions#cobo-defined-categories). | [optional]
|
|
35
35
|
**extra** | **[String]** | A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\"). | [optional]
|
|
@@ -72,8 +72,8 @@ Name | Type | Description | Notes
|
|
|
72
72
|
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
73
73
|
**received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
|
74
74
|
**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional]
|
|
75
|
-
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions
|
|
76
|
-
**currency** | **String** | The fiat currency
|
|
75
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional]
|
|
76
|
+
**currency** | **String** | The fiat currency for the off-ramp. | [optional]
|
|
77
77
|
**order_amount** | **String** | This field has been deprecated. Please use `pricing_amount` instead. | [optional]
|
|
78
78
|
**settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
79
79
|
**refund_id** | **String** | The refund order ID. |
|
|
@@ -87,7 +87,7 @@ Name | Type | Description | Notes
|
|
|
87
87
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
|
|
88
88
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
89
89
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
|
|
90
|
-
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
90
|
+
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
91
91
|
**settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
|
|
92
92
|
**received_amount_fiat** | **String** | The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. | [optional]
|
|
93
93
|
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
@@ -97,8 +97,13 @@ Name | Type | Description | Notes
|
|
|
97
97
|
**previous_address** | **String** | The previous top-up address that was assigned to the payer. |
|
|
98
98
|
**updated_address** | **String** | The new top-up address that has been assigned to the payer. |
|
|
99
99
|
**payout_id** | **String** | The payout ID generated by Cobo. |
|
|
100
|
-
**
|
|
101
|
-
**
|
|
100
|
+
**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\"`. |
|
|
101
|
+
**payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
|
|
102
|
+
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
103
|
+
**actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
|
|
104
|
+
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
105
|
+
**bulk_send_id** | **String** | The bulk send ID. |
|
|
106
|
+
**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | |
|
|
102
107
|
**disposition_type** | [**DispositionType**](DispositionType.md) | |
|
|
103
108
|
**disposition_status** | [**DispositionStatus**](DispositionStatus.md) | |
|
|
104
109
|
**destination_address** | **String** | The blockchain address to receive the refunded/isolated funds. | [optional]
|
|
@@ -141,6 +146,8 @@ Name | Type | Description | Notes
|
|
|
141
146
|
|
|
142
147
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
143
148
|
|
|
149
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
150
|
+
|
|
144
151
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
145
152
|
|
|
146
153
|
* `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
|
|
|
9
9
|
|
|
10
10
|
|
|
@@ -39,6 +39,8 @@ Name | Type | Description | Notes
|
|
|
39
39
|
|
|
40
40
|
* `PaymentPayout` (value: `"PaymentPayout"`)
|
|
41
41
|
|
|
42
|
+
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
43
|
+
|
|
42
44
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
43
45
|
|
|
44
46
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|