@cobo/cobo-waas2 1.36.0 → 1.37.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.
Files changed (74) hide show
  1. package/README.md +8 -1
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/PaymentApi.js +77 -0
  4. package/dist/index.js +42 -0
  5. package/dist/model/AddressesEventData.js +13 -3
  6. package/dist/model/BalanceUpdateInfoEventData.js +13 -3
  7. package/dist/model/ChainsEventData.js +13 -3
  8. package/dist/model/ComplianceDispositionUpdateEventData.js +13 -3
  9. package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +13 -3
  10. package/dist/model/ComplianceKytScreeningsUpdateEventData.js +13 -3
  11. package/dist/model/FiatTransactionEventData.js +431 -0
  12. package/dist/model/MPCVaultEventData.js +13 -3
  13. package/dist/model/OrganizationEventData.js +270 -0
  14. package/dist/model/PaymentAddressUpdateEventData.js +13 -3
  15. package/dist/model/PaymentBalanceChange.js +248 -0
  16. package/dist/model/PaymentBalanceChangeResponse.js +125 -0
  17. package/dist/model/PaymentBalanceChangeSourceType.js +106 -0
  18. package/dist/model/PaymentBalanceFlowDirection.js +61 -0
  19. package/dist/model/PaymentBulkSend.js +17 -0
  20. package/dist/model/PaymentBulkSendEvent.js +35 -3
  21. package/dist/model/PaymentBulkSendItem.js +13 -0
  22. package/dist/model/PaymentOrderEventData.js +13 -3
  23. package/dist/model/PaymentPayout.js +1 -1
  24. package/dist/model/PaymentPayoutDetail.js +2 -2
  25. package/dist/model/PaymentPayoutEvent.js +15 -5
  26. package/dist/model/PaymentRefundEventData.js +16 -4
  27. package/dist/model/PaymentSettlementEvent.js +13 -3
  28. package/dist/model/PaymentTransactionEventData.js +13 -3
  29. package/dist/model/Refund.js +2 -1
  30. package/dist/model/SuspendedTokenEventData.js +13 -3
  31. package/dist/model/TSSRequestWebhookEventData.js +13 -3
  32. package/dist/model/TokenListingEventData.js +13 -3
  33. package/dist/model/TokensEventData.js +13 -3
  34. package/dist/model/TransactionWebhookEventData.js +13 -3
  35. package/dist/model/WalletInfoEventData.js +13 -3
  36. package/dist/model/WebhookEventData.js +99 -18
  37. package/dist/model/WebhookEventDataType.js +12 -2
  38. package/dist/model/WebhookEventType.js +20 -0
  39. package/docs/AddressesEventData.md +5 -1
  40. package/docs/BalanceUpdateInfoEventData.md +5 -1
  41. package/docs/ChainsEventData.md +5 -1
  42. package/docs/ComplianceDispositionUpdateEventData.md +5 -1
  43. package/docs/ComplianceKyaScreeningsUpdateEventData.md +5 -1
  44. package/docs/ComplianceKytScreeningsUpdateEventData.md +5 -1
  45. package/docs/FiatTransactionEventData.md +84 -0
  46. package/docs/MPCVaultEventData.md +5 -1
  47. package/docs/OrganizationEventData.md +64 -0
  48. package/docs/PaymentAddressUpdateEventData.md +5 -1
  49. package/docs/PaymentApi.md +71 -0
  50. package/docs/PaymentBalanceChange.md +19 -0
  51. package/docs/PaymentBalanceChangeResponse.md +10 -0
  52. package/docs/PaymentBalanceChangeSourceType.md +30 -0
  53. package/docs/PaymentBalanceFlowDirection.md +12 -0
  54. package/docs/PaymentBulkSend.md +1 -0
  55. package/docs/PaymentBulkSendEvent.md +6 -1
  56. package/docs/PaymentBulkSendItem.md +1 -0
  57. package/docs/PaymentOrderEventData.md +5 -1
  58. package/docs/PaymentPayout.md +1 -1
  59. package/docs/PaymentPayoutDetail.md +1 -1
  60. package/docs/PaymentPayoutEvent.md +6 -2
  61. package/docs/PaymentRefundEventData.md +6 -2
  62. package/docs/PaymentSettlementEvent.md +5 -1
  63. package/docs/PaymentTransactionEventData.md +5 -1
  64. package/docs/Refund.md +1 -1
  65. package/docs/SuspendedTokenEventData.md +5 -1
  66. package/docs/TSSRequestWebhookEventData.md +5 -1
  67. package/docs/TokenListingEventData.md +5 -1
  68. package/docs/TokensEventData.md +5 -1
  69. package/docs/TransactionWebhookEventData.md +5 -1
  70. package/docs/WalletInfoEventData.md +5 -1
  71. package/docs/WebhookEventData.md +30 -9
  72. package/docs/WebhookEventDataType.md +5 -1
  73. package/docs/WebhookEventType.md +8 -0
  74. package/package.json +1 -1
@@ -0,0 +1,64 @@
1
+ # CoboWaas2.OrganizationEventData
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. |
8
+ **org_id** | **String** | The organization ID. | [optional]
9
+ **name** | **String** | The organization name. | [optional]
10
+
11
+
12
+
13
+ ## Enum: DataTypeEnum
14
+
15
+
16
+ * `Transaction` (value: `"Transaction"`)
17
+
18
+ * `TSSRequest` (value: `"TSSRequest"`)
19
+
20
+ * `Addresses` (value: `"Addresses"`)
21
+
22
+ * `WalletInfo` (value: `"WalletInfo"`)
23
+
24
+ * `MPCVault` (value: `"MPCVault"`)
25
+
26
+ * `Chains` (value: `"Chains"`)
27
+
28
+ * `Tokens` (value: `"Tokens"`)
29
+
30
+ * `TokenListing` (value: `"TokenListing"`)
31
+
32
+ * `PaymentOrder` (value: `"PaymentOrder"`)
33
+
34
+ * `PaymentRefund` (value: `"PaymentRefund"`)
35
+
36
+ * `PaymentSettlement` (value: `"PaymentSettlement"`)
37
+
38
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
39
+
40
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
41
+
42
+ * `PaymentPayout` (value: `"PaymentPayout"`)
43
+
44
+ * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
45
+
46
+ * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
47
+
48
+ * `SuspendedToken` (value: `"SuspendedToken"`)
49
+
50
+ * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
51
+
52
+ * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
53
+
54
+ * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
55
+
56
+ * `Organization` (value: `"Organization"`)
57
+
58
+ * `FiatTransaction` (value: `"FiatTransaction"`)
59
+
60
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
61
+
62
+
63
+
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. - `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
  **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
9
9
  **payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. |
10
10
  **chain** | **String** | The chain ID. |
@@ -56,6 +56,10 @@ Name | Type | Description | Notes
56
56
 
57
57
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
58
58
 
59
+ * `Organization` (value: `"Organization"`)
60
+
61
+ * `FiatTransaction` (value: `"FiatTransaction"`)
62
+
59
63
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
60
64
 
61
65
 
@@ -47,6 +47,7 @@ Method | HTTP request | Description
47
47
  [**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
48
48
  [**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Create/Get top-up address
49
49
  [**listAllocationItems**](PaymentApi.md#listAllocationItems) | **GET** /payments/allocation_items | List all allocation items
50
+ [**listBalanceChanges**](PaymentApi.md#listBalanceChanges) | **GET** /payments/balance_changes | List balance changes
50
51
  [**listBatchAllocations**](PaymentApi.md#listBatchAllocations) | **GET** /payments/batch_allocations | List all batch allocations
51
52
  [**listBulkSendItems**](PaymentApi.md#listBulkSendItems) | **GET** /payments/bulk_sends/{bulk_send_id}/items | List bulk send items
52
53
  [**listBulkSends**](PaymentApi.md#listBulkSends) | **GET** /payments/bulk_sends | List bulk sends
@@ -2331,6 +2332,76 @@ Name | Type | Description | Notes
2331
2332
  - **Accept**: application/json
2332
2333
 
2333
2334
 
2335
+ ## listBalanceChanges
2336
+
2337
+ > PaymentBalanceChangeResponse listBalanceChanges(source_account, opts)
2338
+
2339
+ List balance changes
2340
+
2341
+ This operation retrieves balance changes for the specified source account. Each balance change includes the source information, token ID, changed amount, account balances before and after the change, flow direction, and creation time. You need to specify `source_account`. Currently, use `developer` as the source account. You can use pagination parameters to control the response size, and filter balance changes by `token_id`, `flow_direction`, `min_created_timestamp`, `max_created_timestamp`, `source_type`, or `source_id`. <Note>When specifying `source_id`, you must also specify `source_type`.</Note> For more information, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview).
2342
+
2343
+ ### Example
2344
+
2345
+ ```javascript
2346
+ const CoboWaas2 = require('@cobo/cobo-waas2');
2347
+ // Initialize the API client
2348
+ const apiClient = CoboWaas2.ApiClient.instance
2349
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
2350
+ apiClient.setEnv(CoboWaas2.Env.DEV);
2351
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
2352
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
2353
+ // Call the API
2354
+ const apiInstance = new CoboWaas2.PaymentApi();
2355
+ const source_account = "developer";
2356
+ const opts = {
2357
+ 'limit': 10,
2358
+ 'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
2359
+ 'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
2360
+ 'token_id': "ETH_USDT",
2361
+ 'flow_direction': new CoboWaas2.PaymentBalanceFlowDirection(),
2362
+ 'min_created_timestamp': 1744689600,
2363
+ 'max_created_timestamp': 1744776000,
2364
+ 'source_type': new CoboWaas2.PaymentBalanceChangeSourceType(),
2365
+ 'source_id': "po_1234567890"
2366
+ };
2367
+ apiInstance.listBalanceChanges(source_account, opts).then((data) => {
2368
+ console.log('API called successfully. Returned data: ' + data);
2369
+ }, (error) => {
2370
+ console.error(error);
2371
+ });
2372
+
2373
+ ```
2374
+
2375
+ ### Parameters
2376
+
2377
+
2378
+ Name | Type | Description | Notes
2379
+ ------------- | ------------- | ------------- | -------------
2380
+ **source_account** | **String**| The source account for which to retrieve balance changes. Currently, use &#x60;developer&#x60;. |
2381
+ **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
2382
+ **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]
2383
+ **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]
2384
+ **token_id** | **String**| The token ID used to filter balance changes. For a complete list of supported tokens, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). | [optional]
2385
+ **flow_direction** | [**PaymentBalanceFlowDirection**](.md)| The direction of the balance change relative to the source account. Possible values include: - &#x60;in&#x60;: Funds flow into the source account. - &#x60;out&#x60;: Funds flow out of the source account. | [optional]
2386
+ **min_created_timestamp** | **Number**| The minimum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or after this time are returned. | [optional]
2387
+ **max_created_timestamp** | **Number**| The maximum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or before this time are returned. | [optional]
2388
+ **source_type** | [**PaymentBalanceChangeSourceType**](.md)| The source type used to filter balance changes. Possible values include: - &#x60;Init&#x60;: Balance change caused by initialization. - &#x60;OrderIn&#x60;: Balance change from an order-in payment. - &#x60;LatePayment&#x60;: Balance change from a late payment. - &#x60;TopUp&#x60;: Balance change from a top-up. - &#x60;UnexceptedIn&#x60;: Balance change from an unexpected incoming payment. - &#x60;RefundOut&#x60;: Balance change from a refund payout. - &#x60;Payout&#x60;: Balance change from a payout. - &#x60;UnexceptedOut&#x60;: Balance change from an unexpected outgoing payment. - &#x60;Allocation&#x60;: Balance change from an allocation. - &#x60;SettlementNetwork&#x60;: Balance change from the settlement network. - &#x60;BulkSend&#x60;: Balance change from a bulk send. &lt;Note&gt;When specifying &#x60;source_id&#x60;, you must also specify &#x60;source_type&#x60;.&lt;/Note&gt; | [optional]
2389
+ **source_id** | **String**| The source ID used to filter balance changes. &lt;Note&gt;When specifying &#x60;source_id&#x60;, you must also specify &#x60;source_type&#x60;.&lt;/Note&gt; | [optional]
2390
+
2391
+ ### Return type
2392
+
2393
+ [**PaymentBalanceChangeResponse**](PaymentBalanceChangeResponse.md)
2394
+
2395
+ ### Authorization
2396
+
2397
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
2398
+
2399
+ ### HTTP request headers
2400
+
2401
+ - **Content-Type**: Not defined
2402
+ - **Accept**: application/json
2403
+
2404
+
2334
2405
  ## listBatchAllocations
2335
2406
 
2336
2407
  > ListBatchAllocations200Response listBatchAllocations(opts)
@@ -0,0 +1,19 @@
1
+ # CoboWaas2.PaymentBalanceChange
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **source_id** | **String** | The source ID of the balance change. |
8
+ **source_type** | [**PaymentBalanceChangeSourceType**](PaymentBalanceChangeSourceType.md) | |
9
+ **token_id** | **String** | The token ID of the balance change. |
10
+ **amount** | **String** | The balance change amount, truncated to two decimal places and represented as a numeric string. |
11
+ **amount_raw** | **String** | The balance change amount in the token&#39;s decimal precision, represented as a numeric string. |
12
+ **balance_before** | **String** | The account balance before the balance change, truncated to two decimal places and represented as a numeric string. |
13
+ **balance_before_raw** | **String** | The account balance before the balance change in the token&#39;s decimal precision, represented as a numeric string. |
14
+ **balance_after** | **String** | The account balance after the balance change, truncated to two decimal places and represented as a numeric string. |
15
+ **balance_after_raw** | **String** | The account balance after the balance change in the token&#39;s decimal precision, represented as a numeric string. |
16
+ **flow_direction** | [**PaymentBalanceFlowDirection**](PaymentBalanceFlowDirection.md) | |
17
+ **created_timestamp** | **Number** | The time when the balance change was created, represented as a UNIX timestamp in seconds. |
18
+
19
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.PaymentBalanceChangeResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**[PaymentBalanceChange]**](PaymentBalanceChange.md) | The list of balance changes. | [optional]
8
+ **pagination** | [**Pagination**](Pagination.md) | | [optional]
9
+
10
+
@@ -0,0 +1,30 @@
1
+ # CoboWaas2.PaymentBalanceChangeSourceType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Init` (value: `"Init"`)
7
+
8
+ * `OrderIn` (value: `"OrderIn"`)
9
+
10
+ * `LatePayment` (value: `"LatePayment"`)
11
+
12
+ * `TopUp` (value: `"TopUp"`)
13
+
14
+ * `UnexceptedIn` (value: `"UnexceptedIn"`)
15
+
16
+ * `RefundOut` (value: `"RefundOut"`)
17
+
18
+ * `Payout` (value: `"Payout"`)
19
+
20
+ * `UnexceptedOut` (value: `"UnexceptedOut"`)
21
+
22
+ * `Allocation` (value: `"Allocation"`)
23
+
24
+ * `SettlementNetwork` (value: `"SettlementNetwork"`)
25
+
26
+ * `BulkSend` (value: `"BulkSend"`)
27
+
28
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
29
+
30
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.PaymentBalanceFlowDirection
2
+
3
+ ## Enum
4
+
5
+
6
+ * `in` (value: `"in"`)
7
+
8
+ * `out` (value: `"out"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
12
12
  **status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) | |
13
13
  **created_timestamp** | **Number** | The created time of the bulk send, represented as a UNIX timestamp in seconds. |
14
14
  **updated_timestamp** | **Number** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. |
15
+ **commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or &#x60;0&#x60; if refunded. | [optional]
15
16
 
16
17
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: The fiat transaction event data. |
8
8
  **bulk_send_id** | **String** | The bulk send ID. |
9
9
  **request_id** | **String** | The request ID. | [optional]
10
10
  **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&#39;s ID (e.g., \&quot;M1001\&quot;). - If the source account is the developer account, use the string &#x60;\&quot;developer\&quot;&#x60;. |
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) | |
14
14
  **created_timestamp** | **Number** | The created time of the bulk send, represented as a UNIX timestamp in seconds. |
15
15
  **updated_timestamp** | **Number** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. |
16
+ **commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or &#x60;0&#x60; if refunded. | [optional]
16
17
 
17
18
 
18
19
 
@@ -59,6 +60,10 @@ Name | Type | Description | Notes
59
60
 
60
61
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
61
62
 
63
+ * `Organization` (value: `"Organization"`)
64
+
65
+ * `FiatTransaction` (value: `"FiatTransaction"`)
66
+
62
67
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
63
68
 
64
69
 
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **receiving_address** | **String** | The receiving address. |
10
10
  **amount** | **String** | The amount of the cryptocurrency to be sent to the recipient. |
11
11
  **description** | **String** | A note or comment about the bulk send item. | [optional]
12
+ **tx_hash** | **String** | The transaction hash of the bulk send item. | [optional]
12
13
  **status** | [**PaymentBulkSendItemStatus**](PaymentBulkSendItemStatus.md) | |
13
14
  **validation_status** | [**PaymentBulkSendItemValidationStatus**](PaymentBulkSendItemValidationStatus.md) | |
14
15
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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]
@@ -74,6 +74,10 @@ Name | Type | Description | Notes
74
74
 
75
75
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
76
76
 
77
+ * `Organization` (value: `"Organization"`)
78
+
79
+ * `FiatTransaction` (value: `"FiatTransaction"`)
80
+
77
81
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
78
82
 
79
83
 
@@ -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&#39;s API key. | [optional]
14
14
  **actual_payout_amount** | **String** | - For &#x60;Crypto&#x60; payouts: The amount of cryptocurrency sent to the recipient&#39;s address, denominated in the token specified in &#x60;recipient_info.token_id&#x60;. - For &#x60;OffRamp&#x60; payouts: The amount of fiat currency sent to the recipient&#39;s bank account, denominated in the currency specified in &#x60;recipient_info.currency&#x60;. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
15
- **commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees of the payout. | [optional]
15
+ **commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or &#x60;0&#x60; 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&#39;s API key. | [optional]
14
14
  **actual_payout_amount** | **String** | - For &#x60;Crypto&#x60; payouts: The amount of cryptocurrency sent to the recipient&#39;s address, denominated in the token specified in &#x60;recipient_info.token_id&#x60;. - For &#x60;OffRamp&#x60; payouts: The amount of fiat currency sent to the recipient&#39;s bank account, denominated in the currency specified in &#x60;recipient_info.currency&#x60;. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
15
- **commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees of the payout. | [optional]
15
+ **commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or &#x60;0&#x60; 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. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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&#39;s API key. | [optional]
15
15
  **actual_payout_amount** | **String** | - For &#x60;Crypto&#x60; payouts: The amount of cryptocurrency sent to the recipient&#39;s address, denominated in the token specified in &#x60;recipient_info.token_id&#x60;. - For &#x60;OffRamp&#x60; payouts: The amount of fiat currency sent to the recipient&#39;s bank account, denominated in the currency specified in &#x60;recipient_info.currency&#x60;. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
16
- **commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees of the payout. | [optional]
16
+ **commission_fees** | [**[CommissionFee]**](CommissionFee.md) | The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or &#x60;0&#x60; 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. |
@@ -65,6 +65,10 @@ Name | Type | Description | Notes
65
65
 
66
66
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
67
67
 
68
+ * `Organization` (value: `"Organization"`)
69
+
70
+ * `FiatTransaction` (value: `"FiatTransaction"`)
71
+
68
72
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
69
73
 
70
74
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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. - &#x60;true&#x60;: The fee amount (specified in &#x60;merchant_fee_amount&#x60;) will be deducted from the merchant&#39;s balance and added to the developer&#39;s balance - &#x60;false&#x60;: 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 &#x60;merchant_fee_token_id&#x60;. This is only applicable if &#x60;charge_merchant_fee&#x60; is set to &#x60;true&#x60;. | [optional]
24
24
  **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if &#x60;charge_merchant_fee&#x60; is set to true. | [optional]
25
- **commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
25
+ **commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or &#x60;0&#x60; if refunded. | [optional]
26
26
 
27
27
 
28
28
 
@@ -69,6 +69,10 @@ Name | Type | Description | Notes
69
69
 
70
70
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
71
71
 
72
+ * `Organization` (value: `"Organization"`)
73
+
74
+ * `FiatTransaction` (value: `"FiatTransaction"`)
75
+
72
76
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
73
77
 
74
78
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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) | |
@@ -64,6 +64,10 @@ Name | Type | Description | Notes
64
64
 
65
65
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
66
66
 
67
+ * `Organization` (value: `"Organization"`)
68
+
69
+ * `FiatTransaction` (value: `"FiatTransaction"`)
70
+
67
71
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
68
72
 
69
73
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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]
@@ -87,6 +87,10 @@ Name | Type | Description | Notes
87
87
 
88
88
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
89
89
 
90
+ * `Organization` (value: `"Organization"`)
91
+
92
+ * `FiatTransaction` (value: `"FiatTransaction"`)
93
+
90
94
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
91
95
 
92
96
 
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. - &#x60;true&#x60;: The fee amount (specified in &#x60;merchant_fee_amount&#x60;) will be deducted from the merchant&#39;s balance and added to the developer&#39;s balance - &#x60;false&#x60;: 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 &#x60;merchant_fee_token_id&#x60;. This is only applicable if &#x60;charge_merchant_fee&#x60; is set to &#x60;true&#x60;. | [optional]
23
23
  **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if &#x60;charge_merchant_fee&#x60; is set to true. | [optional]
24
- **commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
24
+ **commission_fee** | [**CommissionFee**](CommissionFee.md) | The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or &#x60;0&#x60; if refunded. | [optional]
25
25
 
26
26
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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
 
@@ -53,6 +53,10 @@ Name | Type | Description | Notes
53
53
 
54
54
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
55
55
 
56
+ * `Organization` (value: `"Organization"`)
57
+
58
+ * `FiatTransaction` (value: `"FiatTransaction"`)
59
+
56
60
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
57
61
 
58
62
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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]
@@ -58,6 +58,10 @@ Name | Type | Description | Notes
58
58
 
59
59
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
60
60
 
61
+ * `Organization` (value: `"Organization"`)
62
+
63
+ * `FiatTransaction` (value: `"FiatTransaction"`)
64
+
61
65
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
62
66
 
63
67
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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&#39;s contract address on the specified blockchain. |
@@ -62,6 +62,10 @@ Name | Type | Description | Notes
62
62
 
63
63
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
64
64
 
65
+ * `Organization` (value: `"Organization"`)
66
+
67
+ * `FiatTransaction` (value: `"FiatTransaction"`)
68
+
65
69
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
66
70
 
67
71
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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]
@@ -54,6 +54,10 @@ Name | Type | Description | Notes
54
54
 
55
55
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
56
56
 
57
+ * `Organization` (value: `"Organization"`)
58
+
59
+ * `FiatTransaction` (value: `"FiatTransaction"`)
60
+
57
61
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
58
62
 
59
63
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;PaymentPayout&#x60;: The payment payout event data. - &#x60;PaymentBulkSend&#x60;: The payment bulk send event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. - &#x60;ComplianceKyaScreenings&#x60;: The compliance KYA screenings event data. - &#x60;Organization&#x60;: The organization event data. - &#x60;FiatTransaction&#x60;: 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]
@@ -82,6 +82,10 @@ Name | Type | Description | Notes
82
82
 
83
83
  * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
84
84
 
85
+ * `Organization` (value: `"Organization"`)
86
+
87
+ * `FiatTransaction` (value: `"FiatTransaction"`)
88
+
85
89
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
86
90
 
87
91