@cobo/cobo-waas2 1.36.0 → 1.38.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 +9 -1
- package/dist/ApiClient.js +1 -1
- package/dist/api/PaymentApi.js +77 -0
- package/dist/index.js +49 -0
- package/dist/model/AddressesEventData.js +18 -3
- package/dist/model/ApprovalUserDetail.js +13 -0
- package/dist/model/BalanceUpdateInfoEventData.js +18 -3
- package/dist/model/ChainsEventData.js +18 -3
- package/dist/model/ComplianceDispositionUpdateEventData.js +18 -3
- package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +18 -3
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +18 -3
- package/dist/model/CreateBulkSendRequest.js +1 -1
- package/dist/model/CreateBulkSendRequestPayoutParamsInner.js +1 -1
- package/dist/model/EstimatedSOLFeeSlow.js +2 -2
- package/dist/model/FiatTransactionEventData.js +436 -0
- package/dist/model/MPCVaultEventData.js +18 -3
- package/dist/model/OrganizationEventData.js +275 -0
- package/dist/model/PaymentAccountBalanceUpdateEventData.js +418 -0
- package/dist/model/PaymentAddressUpdateEventData.js +31 -3
- package/dist/model/PaymentBalanceChange.js +248 -0
- package/dist/model/PaymentBalanceChangeResponse.js +125 -0
- package/dist/model/PaymentBalanceChangeSourceType.js +106 -0
- package/dist/model/PaymentBalanceFlowDirection.js +61 -0
- package/dist/model/PaymentBulkSend.js +17 -0
- package/dist/model/PaymentBulkSendEvent.js +40 -3
- package/dist/model/PaymentBulkSendItem.js +13 -0
- package/dist/model/PaymentOrderEventData.js +18 -3
- package/dist/model/PaymentPayout.js +1 -1
- package/dist/model/PaymentPayoutDetail.js +2 -2
- package/dist/model/PaymentPayoutEvent.js +20 -5
- package/dist/model/PaymentPayoutRecipientInfo.js +1 -1
- package/dist/model/PaymentRefundEventData.js +21 -4
- package/dist/model/PaymentSettlementEvent.js +18 -3
- package/dist/model/PaymentTransactionEventData.js +57 -3
- package/dist/model/Refund.js +2 -1
- package/dist/model/SOLBase.js +1 -1
- package/dist/model/SuspendedTokenEventData.js +18 -3
- package/dist/model/TSSRequestWebhookEventData.js +18 -3
- package/dist/model/TokenListingEventData.js +18 -3
- package/dist/model/TokensEventData.js +18 -3
- package/dist/model/TransactionFee.js +1 -1
- package/dist/model/TransactionSOLFee.js +3 -3
- package/dist/model/TransactionWebhookEventData.js +18 -3
- package/dist/model/WalletInfoEventData.js +18 -3
- package/dist/model/WebhookEventData.js +195 -20
- package/dist/model/WebhookEventDataType.js +17 -2
- package/dist/model/WebhookEventType.js +25 -0
- package/docs/AddressesEventData.md +7 -1
- package/docs/ApprovalUserDetail.md +1 -0
- package/docs/BalanceUpdateInfoEventData.md +7 -1
- package/docs/ChainsEventData.md +7 -1
- package/docs/ComplianceDispositionUpdateEventData.md +7 -1
- package/docs/ComplianceKyaScreeningsUpdateEventData.md +7 -1
- package/docs/ComplianceKytScreeningsUpdateEventData.md +7 -1
- package/docs/CreateBulkSendRequest.md +1 -1
- package/docs/CreateBulkSendRequestPayoutParamsInner.md +1 -1
- package/docs/EstimatedSOLFeeSlow.md +1 -1
- package/docs/FiatTransactionEventData.md +86 -0
- package/docs/MPCVaultEventData.md +7 -1
- package/docs/OrganizationEventData.md +66 -0
- package/docs/PaymentAccountBalanceUpdateEventData.md +76 -0
- package/docs/PaymentAddressUpdateEventData.md +8 -1
- package/docs/PaymentApi.md +71 -0
- package/docs/PaymentBalanceChange.md +19 -0
- package/docs/PaymentBalanceChangeResponse.md +10 -0
- package/docs/PaymentBalanceChangeSourceType.md +30 -0
- package/docs/PaymentBalanceFlowDirection.md +12 -0
- package/docs/PaymentBulkSend.md +1 -0
- package/docs/PaymentBulkSendEvent.md +8 -1
- package/docs/PaymentBulkSendItem.md +1 -0
- package/docs/PaymentOrderEventData.md +7 -1
- package/docs/PaymentPayout.md +1 -1
- package/docs/PaymentPayoutDetail.md +1 -1
- package/docs/PaymentPayoutEvent.md +8 -2
- package/docs/PaymentPayoutRecipientInfo.md +1 -1
- package/docs/PaymentRefundEventData.md +8 -2
- package/docs/PaymentSettlementEvent.md +7 -1
- package/docs/PaymentTransactionEventData.md +10 -1
- package/docs/Refund.md +1 -1
- package/docs/SOLBase.md +1 -1
- package/docs/SuspendedTokenEventData.md +7 -1
- package/docs/TSSRequestWebhookEventData.md +7 -1
- package/docs/TokenListingEventData.md +7 -1
- package/docs/TokensEventData.md +7 -1
- package/docs/TransactionFee.md +1 -1
- package/docs/TransactionSOLFee.md +2 -2
- package/docs/TransactionWebhookEventData.md +7 -1
- package/docs/WalletInfoEventData.md +7 -1
- package/docs/WebhookEventData.md +45 -11
- package/docs/WebhookEventDataType.md +7 -1
- package/docs/WebhookEventType.md +10 -0
- package/package.json +1 -1
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. |
|
|
8
8
|
**order_id** | **String** | The order ID. |
|
|
9
9
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
10
10
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
|
|
@@ -64,6 +64,8 @@ Name | Type | Description | Notes
|
|
|
64
64
|
|
|
65
65
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
66
66
|
|
|
67
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
68
|
+
|
|
67
69
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
68
70
|
|
|
69
71
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -74,6 +76,10 @@ Name | Type | Description | Notes
|
|
|
74
76
|
|
|
75
77
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
76
78
|
|
|
79
|
+
* `Organization` (value: `"Organization"`)
|
|
80
|
+
|
|
81
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
82
|
+
|
|
77
83
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
78
84
|
|
|
79
85
|
|
package/docs/PaymentPayout.md
CHANGED
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
13
13
|
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
14
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]
|
|
15
|
-
**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees
|
|
15
|
+
**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded. | [optional]
|
|
16
16
|
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
17
17
|
**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
|
|
18
18
|
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
13
13
|
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
14
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]
|
|
15
|
-
**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees
|
|
15
|
+
**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded. | [optional]
|
|
16
16
|
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
17
17
|
**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
|
|
18
18
|
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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
10
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
|
|
14
14
|
**initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
|
|
15
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]
|
|
16
|
-
**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees
|
|
16
|
+
**commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded. | [optional]
|
|
17
17
|
**remark** | **String** | A note or comment about the payout. | [optional]
|
|
18
18
|
**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
|
|
19
19
|
**created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
|
|
@@ -55,6 +55,8 @@ Name | Type | Description | Notes
|
|
|
55
55
|
|
|
56
56
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
57
57
|
|
|
58
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
59
|
+
|
|
58
60
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
59
61
|
|
|
60
62
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -65,6 +67,10 @@ Name | Type | Description | Notes
|
|
|
65
67
|
|
|
66
68
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
67
69
|
|
|
70
|
+
* `Organization` (value: `"Organization"`)
|
|
71
|
+
|
|
72
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
73
|
+
|
|
68
74
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
69
75
|
|
|
70
76
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**address** | **String** | The recipient's wallet address where the payout will be sent. | [optional]
|
|
8
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
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]
|
|
10
|
+
**bank_account_id** | **String** | The ID of the bank account to which the payout will be sent. This field is required only when the payout channel is `OffRamp`. 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
11
|
**transfer_via_va** | **Boolean** | For OffRamp payout, whether the payout is transferred to a registered bank account via a virtual account (VA) or directly. - `true`: The payout is transferred to a registered bank account via a VA (virtual account). - `false`: The payout is transferred directly to a registered bank account. | [optional]
|
|
12
12
|
|
|
13
13
|
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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]
|
|
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee. | [optional]
|
|
23
23
|
**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional]
|
|
24
24
|
**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional]
|
|
25
|
-
**commission_fee** | [**CommissionFee**](CommissionFee.md) |
|
|
25
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded. | [optional]
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
@@ -59,6 +59,8 @@ Name | Type | Description | Notes
|
|
|
59
59
|
|
|
60
60
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
61
61
|
|
|
62
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
63
|
+
|
|
62
64
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
63
65
|
|
|
64
66
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -69,6 +71,10 @@ Name | Type | Description | Notes
|
|
|
69
71
|
|
|
70
72
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
71
73
|
|
|
74
|
+
* `Organization` (value: `"Organization"`)
|
|
75
|
+
|
|
76
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
77
|
+
|
|
72
78
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
73
79
|
|
|
74
80
|
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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) | |
|
|
@@ -54,6 +54,8 @@ Name | Type | Description | Notes
|
|
|
54
54
|
|
|
55
55
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
56
56
|
|
|
57
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
58
|
+
|
|
57
59
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
58
60
|
|
|
59
61
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -64,6 +66,10 @@ Name | Type | Description | Notes
|
|
|
64
66
|
|
|
65
67
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
66
68
|
|
|
69
|
+
* `Organization` (value: `"Organization"`)
|
|
70
|
+
|
|
71
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
72
|
+
|
|
67
73
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
68
74
|
|
|
69
75
|
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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]
|
|
@@ -41,6 +41,9 @@ Name | Type | Description | Notes
|
|
|
41
41
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | [optional]
|
|
42
42
|
**payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
43
43
|
**custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. | [optional]
|
|
44
|
+
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
45
|
+
**subscription_id** | **String** | A unique identifier assigned by Cobo to track and identify subscription. | [optional]
|
|
46
|
+
**action_id** | **String** | A unique identifier assigned by Cobo to track and identify subscription action. | [optional]
|
|
44
47
|
|
|
45
48
|
|
|
46
49
|
|
|
@@ -77,6 +80,8 @@ Name | Type | Description | Notes
|
|
|
77
80
|
|
|
78
81
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
79
82
|
|
|
83
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
84
|
+
|
|
80
85
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
81
86
|
|
|
82
87
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -87,6 +92,10 @@ Name | Type | Description | Notes
|
|
|
87
92
|
|
|
88
93
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
89
94
|
|
|
95
|
+
* `Organization` (value: `"Organization"`)
|
|
96
|
+
|
|
97
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
98
|
+
|
|
90
99
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
91
100
|
|
|
92
101
|
|
package/docs/Refund.md
CHANGED
|
@@ -21,6 +21,6 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee. | [optional]
|
|
22
22
|
**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional]
|
|
23
23
|
**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional]
|
|
24
|
-
**commission_fee** | [**CommissionFee**](CommissionFee.md) |
|
|
24
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded. | [optional]
|
|
25
25
|
|
|
26
26
|
|
package/docs/SOLBase.md
CHANGED
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**base_fee** | **String** | A fixed fee charged per signature. The default is 5,000 lamports per signature. | [optional]
|
|
8
|
-
**rent_amount** | **String** | The rent
|
|
8
|
+
**rent_amount** | **String** | The one-time rent required to create and initialize a Solana token Associated Token Account (ATA) — a token sub-address that must be activated before the token can be received or used. This rent is paid by the main (source) address. It is populated only when an ATA must be activated for the transaction; otherwise it is null. | [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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. |
|
|
8
8
|
**token_ids** | **String** | A list of token IDs, separated by comma. |
|
|
9
9
|
**operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | |
|
|
10
10
|
|
|
@@ -43,6 +43,8 @@ Name | Type | Description | Notes
|
|
|
43
43
|
|
|
44
44
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
45
45
|
|
|
46
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
47
|
+
|
|
46
48
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
47
49
|
|
|
48
50
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -53,6 +55,10 @@ Name | Type | Description | Notes
|
|
|
53
55
|
|
|
54
56
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
55
57
|
|
|
58
|
+
* `Organization` (value: `"Organization"`)
|
|
59
|
+
|
|
60
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
61
|
+
|
|
56
62
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
57
63
|
|
|
58
64
|
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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]
|
|
@@ -48,6 +48,8 @@ Name | Type | Description | Notes
|
|
|
48
48
|
|
|
49
49
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
50
50
|
|
|
51
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
52
|
+
|
|
51
53
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
52
54
|
|
|
53
55
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -58,6 +60,10 @@ Name | Type | Description | Notes
|
|
|
58
60
|
|
|
59
61
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
60
62
|
|
|
63
|
+
* `Organization` (value: `"Organization"`)
|
|
64
|
+
|
|
65
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
66
|
+
|
|
61
67
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
62
68
|
|
|
63
69
|
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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. |
|
|
@@ -52,6 +52,8 @@ Name | Type | Description | Notes
|
|
|
52
52
|
|
|
53
53
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
54
54
|
|
|
55
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
56
|
+
|
|
55
57
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
56
58
|
|
|
57
59
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -62,6 +64,10 @@ Name | Type | Description | Notes
|
|
|
62
64
|
|
|
63
65
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
64
66
|
|
|
67
|
+
* `Organization` (value: `"Organization"`)
|
|
68
|
+
|
|
69
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
70
|
+
|
|
65
71
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
66
72
|
|
|
67
73
|
|
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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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]
|
|
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
|
|
|
44
44
|
|
|
45
45
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
46
46
|
|
|
47
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
48
|
+
|
|
47
49
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
48
50
|
|
|
49
51
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -54,6 +56,10 @@ Name | Type | Description | Notes
|
|
|
54
56
|
|
|
55
57
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
56
58
|
|
|
59
|
+
* `Organization` (value: `"Organization"`)
|
|
60
|
+
|
|
61
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
62
|
+
|
|
57
63
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
58
64
|
|
|
59
65
|
|
package/docs/TransactionFee.md
CHANGED
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**max_fee_amount** | **String** | The maximum fee that you are willing to pay for the transaction. Provide the value without applying precision. The transaction will fail if the transaction fee exceeds the maximum fee. | [optional]
|
|
18
18
|
**fee_rate** | **String** | The fee rate in sat/vByte. The fee rate represents the satoshis you are willing to pay for each byte of data that your transaction will consume on the blockchain. | [optional]
|
|
19
19
|
**base_fee** | **String** | A fixed fee charged per signature. The default is 5,000 lamports per signature. | [optional]
|
|
20
|
-
**rent_amount** | **String** | The rent
|
|
20
|
+
**rent_amount** | **String** | The one-time rent required to create and initialize a Solana token Associated Token Account (ATA) — a token sub-address that must be activated before the token can be received or used. This rent is paid by the main (source) address. It is populated only when an ATA must be activated for the transaction; otherwise it is null. | [optional]
|
|
21
21
|
**compute_unit_price** | **String** | The price paid per compute unit. This value determines the priority fee for the transaction, allowing you to increase inclusion probability in congested conditions. | [optional]
|
|
22
22
|
**compute_unit_limit** | **String** | The maximum number of compute units your transaction is allowed to consume. It sets an upper bound on computational resource usage to prevent overload. | [optional]
|
|
23
23
|
**gas_base** | **String** | The minimum fee required for a transaction to be included in a block. The base fee is dynamically adjusted based on network congestion to maintain target block utilization. It is burned rather than paid to miners, reducing the total Filecoin supply over time. | [optional]
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**base_fee** | **String** | A fixed fee charged per signature. The default is 5,000 lamports per signature. | [optional]
|
|
8
|
-
**rent_amount** | **String** | The rent
|
|
8
|
+
**rent_amount** | **String** | The one-time rent required to create and initialize a Solana token Associated Token Account (ATA) — a token sub-address that must be activated before the token can be received or used. This rent is paid by the main (source) address. It is populated only when an ATA must be activated for the transaction; otherwise it is null. | [optional]
|
|
9
9
|
**compute_unit_price** | **String** | The price paid per compute unit. This value determines the priority fee for the transaction, allowing you to increase inclusion probability in congested conditions. | [optional]
|
|
10
10
|
**compute_unit_limit** | **String** | The maximum number of compute units your transaction is allowed to consume. It sets an upper bound on computational resource usage to prevent overload. | [optional]
|
|
11
11
|
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
12
12
|
**token_id** | **String** | The token used to pay the transaction fee. | [optional]
|
|
13
|
-
**fee_used** | **String** | The
|
|
13
|
+
**fee_used** | **String** | The actual on-chain network transaction fee charged for this Solana transaction. For Solana, this value covers the network fee only and does NOT include `rent_amount`. The total cost deducted from the transaction's source (withdrawal) address is `fee_used` + `rent_amount`, both paid by the same source address. | [optional]
|
|
14
14
|
**estimated_fee_used** | **String** | The estimated transaction fee. | [optional]
|
|
15
15
|
|
|
16
16
|
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction 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]
|
|
@@ -72,6 +72,8 @@ Name | Type | Description | Notes
|
|
|
72
72
|
|
|
73
73
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
74
74
|
|
|
75
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
76
|
+
|
|
75
77
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
76
78
|
|
|
77
79
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -82,6 +84,10 @@ Name | Type | Description | Notes
|
|
|
82
84
|
|
|
83
85
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
84
86
|
|
|
87
|
+
* `Organization` (value: `"Organization"`)
|
|
88
|
+
|
|
89
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
90
|
+
|
|
85
91
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
86
92
|
|
|
87
93
|
|
|
@@ -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. - `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. |
|
|
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. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. |
|
|
8
8
|
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
42
42
|
|
|
43
43
|
* `PaymentBulkSend` (value: `"PaymentBulkSend"`)
|
|
44
44
|
|
|
45
|
+
* `PaymentAccountBalanceUpdate` (value: `"PaymentAccountBalanceUpdate"`)
|
|
46
|
+
|
|
45
47
|
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
46
48
|
|
|
47
49
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
@@ -52,6 +54,10 @@ Name | Type | Description | Notes
|
|
|
52
54
|
|
|
53
55
|
* `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
|
|
54
56
|
|
|
57
|
+
* `Organization` (value: `"Organization"`)
|
|
58
|
+
|
|
59
|
+
* `FiatTransaction` (value: `"FiatTransaction"`)
|
|
60
|
+
|
|
55
61
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
56
62
|
|
|
57
63
|
|