@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.
Files changed (92) hide show
  1. package/README.md +9 -1
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/PaymentApi.js +77 -0
  4. package/dist/index.js +49 -0
  5. package/dist/model/AddressesEventData.js +18 -3
  6. package/dist/model/ApprovalUserDetail.js +13 -0
  7. package/dist/model/BalanceUpdateInfoEventData.js +18 -3
  8. package/dist/model/ChainsEventData.js +18 -3
  9. package/dist/model/ComplianceDispositionUpdateEventData.js +18 -3
  10. package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +18 -3
  11. package/dist/model/ComplianceKytScreeningsUpdateEventData.js +18 -3
  12. package/dist/model/CreateBulkSendRequest.js +1 -1
  13. package/dist/model/CreateBulkSendRequestPayoutParamsInner.js +1 -1
  14. package/dist/model/EstimatedSOLFeeSlow.js +2 -2
  15. package/dist/model/FiatTransactionEventData.js +436 -0
  16. package/dist/model/MPCVaultEventData.js +18 -3
  17. package/dist/model/OrganizationEventData.js +275 -0
  18. package/dist/model/PaymentAccountBalanceUpdateEventData.js +418 -0
  19. package/dist/model/PaymentAddressUpdateEventData.js +31 -3
  20. package/dist/model/PaymentBalanceChange.js +248 -0
  21. package/dist/model/PaymentBalanceChangeResponse.js +125 -0
  22. package/dist/model/PaymentBalanceChangeSourceType.js +106 -0
  23. package/dist/model/PaymentBalanceFlowDirection.js +61 -0
  24. package/dist/model/PaymentBulkSend.js +17 -0
  25. package/dist/model/PaymentBulkSendEvent.js +40 -3
  26. package/dist/model/PaymentBulkSendItem.js +13 -0
  27. package/dist/model/PaymentOrderEventData.js +18 -3
  28. package/dist/model/PaymentPayout.js +1 -1
  29. package/dist/model/PaymentPayoutDetail.js +2 -2
  30. package/dist/model/PaymentPayoutEvent.js +20 -5
  31. package/dist/model/PaymentPayoutRecipientInfo.js +1 -1
  32. package/dist/model/PaymentRefundEventData.js +21 -4
  33. package/dist/model/PaymentSettlementEvent.js +18 -3
  34. package/dist/model/PaymentTransactionEventData.js +57 -3
  35. package/dist/model/Refund.js +2 -1
  36. package/dist/model/SOLBase.js +1 -1
  37. package/dist/model/SuspendedTokenEventData.js +18 -3
  38. package/dist/model/TSSRequestWebhookEventData.js +18 -3
  39. package/dist/model/TokenListingEventData.js +18 -3
  40. package/dist/model/TokensEventData.js +18 -3
  41. package/dist/model/TransactionFee.js +1 -1
  42. package/dist/model/TransactionSOLFee.js +3 -3
  43. package/dist/model/TransactionWebhookEventData.js +18 -3
  44. package/dist/model/WalletInfoEventData.js +18 -3
  45. package/dist/model/WebhookEventData.js +195 -20
  46. package/dist/model/WebhookEventDataType.js +17 -2
  47. package/dist/model/WebhookEventType.js +25 -0
  48. package/docs/AddressesEventData.md +7 -1
  49. package/docs/ApprovalUserDetail.md +1 -0
  50. package/docs/BalanceUpdateInfoEventData.md +7 -1
  51. package/docs/ChainsEventData.md +7 -1
  52. package/docs/ComplianceDispositionUpdateEventData.md +7 -1
  53. package/docs/ComplianceKyaScreeningsUpdateEventData.md +7 -1
  54. package/docs/ComplianceKytScreeningsUpdateEventData.md +7 -1
  55. package/docs/CreateBulkSendRequest.md +1 -1
  56. package/docs/CreateBulkSendRequestPayoutParamsInner.md +1 -1
  57. package/docs/EstimatedSOLFeeSlow.md +1 -1
  58. package/docs/FiatTransactionEventData.md +86 -0
  59. package/docs/MPCVaultEventData.md +7 -1
  60. package/docs/OrganizationEventData.md +66 -0
  61. package/docs/PaymentAccountBalanceUpdateEventData.md +76 -0
  62. package/docs/PaymentAddressUpdateEventData.md +8 -1
  63. package/docs/PaymentApi.md +71 -0
  64. package/docs/PaymentBalanceChange.md +19 -0
  65. package/docs/PaymentBalanceChangeResponse.md +10 -0
  66. package/docs/PaymentBalanceChangeSourceType.md +30 -0
  67. package/docs/PaymentBalanceFlowDirection.md +12 -0
  68. package/docs/PaymentBulkSend.md +1 -0
  69. package/docs/PaymentBulkSendEvent.md +8 -1
  70. package/docs/PaymentBulkSendItem.md +1 -0
  71. package/docs/PaymentOrderEventData.md +7 -1
  72. package/docs/PaymentPayout.md +1 -1
  73. package/docs/PaymentPayoutDetail.md +1 -1
  74. package/docs/PaymentPayoutEvent.md +8 -2
  75. package/docs/PaymentPayoutRecipientInfo.md +1 -1
  76. package/docs/PaymentRefundEventData.md +8 -2
  77. package/docs/PaymentSettlementEvent.md +7 -1
  78. package/docs/PaymentTransactionEventData.md +10 -1
  79. package/docs/Refund.md +1 -1
  80. package/docs/SOLBase.md +1 -1
  81. package/docs/SuspendedTokenEventData.md +7 -1
  82. package/docs/TSSRequestWebhookEventData.md +7 -1
  83. package/docs/TokenListingEventData.md +7 -1
  84. package/docs/TokensEventData.md +7 -1
  85. package/docs/TransactionFee.md +1 -1
  86. package/docs/TransactionSOLFee.md +2 -2
  87. package/docs/TransactionWebhookEventData.md +7 -1
  88. package/docs/WalletInfoEventData.md +7 -1
  89. package/docs/WebhookEventData.md +45 -11
  90. package/docs/WebhookEventDataType.md +7 -1
  91. package/docs/WebhookEventType.md +10 -0
  92. package/package.json +1 -1
@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _CommissionFee = _interopRequireDefault(require("./CommissionFee"));
8
9
  var _PaymentBulkSend = _interopRequireDefault(require("./PaymentBulkSend"));
9
10
  var _PaymentBulkSendExecutionMode = _interopRequireDefault(require("./PaymentBulkSendExecutionMode"));
10
11
  var _PaymentBulkSendStatus = _interopRequireDefault(require("./PaymentBulkSendStatus"));
@@ -38,7 +39,7 @@ var PaymentBulkSendEvent = /*#__PURE__*/function () {
38
39
  * @alias module:model/PaymentBulkSendEvent
39
40
  * @implements module:model/WebhookEventDataType
40
41
  * @implements module:model/PaymentBulkSend
41
- * @param data_type {module:model/PaymentBulkSendEvent.DataTypeEnum} 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.
42
+ * @param data_type {module:model/PaymentBulkSendEvent.DataTypeEnum} 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.
42
43
  * @param bulk_send_id {String} The bulk send ID.
43
44
  * @param source_account {String} The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`.
44
45
  * @param execution_mode {module:model/PaymentBulkSendExecutionMode}
@@ -111,6 +112,9 @@ var PaymentBulkSendEvent = /*#__PURE__*/function () {
111
112
  if (data.hasOwnProperty('updated_timestamp')) {
112
113
  obj['updated_timestamp'] = _ApiClient["default"].convertToType(data['updated_timestamp'], 'Number');
113
114
  }
115
+ if (data.hasOwnProperty('commission_fee')) {
116
+ obj['commission_fee'] = _ApiClient["default"].convertToType(data['commission_fee'], _CommissionFee["default"]);
117
+ }
114
118
  }
115
119
  return obj;
116
120
  }
@@ -158,6 +162,13 @@ var PaymentBulkSendEvent = /*#__PURE__*/function () {
158
162
  if (data['description'] && !(typeof data['description'] === 'string' || data['description'] instanceof String)) {
159
163
  throw new Error("Expected the field `description` to be a primitive type in the JSON string but got " + data['description']);
160
164
  }
165
+ // validate the optional field `commission_fee`
166
+ if (data['commission_fee']) {
167
+ // data not null
168
+ if (!!_CommissionFee["default"].validateJSON) {
169
+ _CommissionFee["default"].validateJSON(data['commission_fee']);
170
+ }
171
+ }
161
172
  return true;
162
173
  }
163
174
  }]);
@@ -165,7 +176,7 @@ var PaymentBulkSendEvent = /*#__PURE__*/function () {
165
176
  PaymentBulkSendEvent.RequiredProperties = ["data_type", "bulk_send_id", "source_account", "execution_mode", "status", "created_timestamp", "updated_timestamp"];
166
177
 
167
178
  /**
168
- * 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.
179
+ * 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.
169
180
  * @member {module:model/PaymentBulkSendEvent.DataTypeEnum} data_type
170
181
  */
171
182
  PaymentBulkSendEvent.prototype['data_type'] = undefined;
@@ -216,9 +227,15 @@ PaymentBulkSendEvent.prototype['created_timestamp'] = undefined;
216
227
  */
217
228
  PaymentBulkSendEvent.prototype['updated_timestamp'] = undefined;
218
229
 
230
+ /**
231
+ * The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded.
232
+ * @member {module:model/CommissionFee} commission_fee
233
+ */
234
+ PaymentBulkSendEvent.prototype['commission_fee'] = undefined;
235
+
219
236
  // Implement WebhookEventDataType interface:
220
237
  /**
221
- * 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.
238
+ * 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.
222
239
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
223
240
  */
224
241
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -261,6 +278,11 @@ _PaymentBulkSend["default"].prototype['created_timestamp'] = undefined;
261
278
  * @member {Number} updated_timestamp
262
279
  */
263
280
  _PaymentBulkSend["default"].prototype['updated_timestamp'] = undefined;
281
+ /**
282
+ * The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded.
283
+ * @member {module:model/CommissionFee} commission_fee
284
+ */
285
+ _PaymentBulkSend["default"].prototype['commission_fee'] = undefined;
264
286
 
265
287
  /**
266
288
  * Allowed values for the <code>data_type</code> property.
@@ -343,6 +365,11 @@ PaymentBulkSendEvent['DataTypeEnum'] = {
343
365
  * @const
344
366
  */
345
367
  "PaymentBulkSend": "PaymentBulkSend",
368
+ /**
369
+ * value: "PaymentAccountBalanceUpdate"
370
+ * @const
371
+ */
372
+ "PaymentAccountBalanceUpdate": "PaymentAccountBalanceUpdate",
346
373
  /**
347
374
  * value: "BalanceUpdateInfo"
348
375
  * @const
@@ -368,6 +395,16 @@ PaymentBulkSendEvent['DataTypeEnum'] = {
368
395
  * @const
369
396
  */
370
397
  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
398
+ /**
399
+ * value: "Organization"
400
+ * @const
401
+ */
402
+ "Organization": "Organization",
403
+ /**
404
+ * value: "FiatTransaction"
405
+ * @const
406
+ */
407
+ "FiatTransaction": "FiatTransaction",
371
408
  /**
372
409
  * value: "unknown_default_open_api"
373
410
  * @const
@@ -89,6 +89,9 @@ var PaymentBulkSendItem = /*#__PURE__*/function () {
89
89
  if (data.hasOwnProperty('description')) {
90
90
  obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
91
91
  }
92
+ if (data.hasOwnProperty('tx_hash')) {
93
+ obj['tx_hash'] = _ApiClient["default"].convertToType(data['tx_hash'], 'String');
94
+ }
92
95
  if (data.hasOwnProperty('status')) {
93
96
  obj['status'] = _PaymentBulkSendItemStatus["default"].constructFromObject(data['status']);
94
97
  }
@@ -142,6 +145,10 @@ var PaymentBulkSendItem = /*#__PURE__*/function () {
142
145
  if (data['description'] && !(typeof data['description'] === 'string' || data['description'] instanceof String)) {
143
146
  throw new Error("Expected the field `description` to be a primitive type in the JSON string but got " + data['description']);
144
147
  }
148
+ // ensure the json data is a string
149
+ if (data['tx_hash'] && !(typeof data['tx_hash'] === 'string' || data['tx_hash'] instanceof String)) {
150
+ throw new Error("Expected the field `tx_hash` to be a primitive type in the JSON string but got " + data['tx_hash']);
151
+ }
145
152
  return true;
146
153
  }
147
154
  }]);
@@ -178,6 +185,12 @@ PaymentBulkSendItem.prototype['amount'] = undefined;
178
185
  */
179
186
  PaymentBulkSendItem.prototype['description'] = undefined;
180
187
 
188
+ /**
189
+ * The transaction hash of the bulk send item.
190
+ * @member {String} tx_hash
191
+ */
192
+ PaymentBulkSendItem.prototype['tx_hash'] = undefined;
193
+
181
194
  /**
182
195
  * @member {module:model/PaymentBulkSendItemStatus} status
183
196
  */
@@ -39,7 +39,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
39
39
  * @alias module:model/PaymentOrderEventData
40
40
  * @implements module:model/WebhookEventDataType
41
41
  * @implements module:model/Order
42
- * @param data_type {module:model/PaymentOrderEventData.DataTypeEnum} 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.
42
+ * @param data_type {module:model/PaymentOrderEventData.DataTypeEnum} 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.
43
43
  * @param order_id {String} The order ID.
44
44
  * @param psp_order_code {String} A unique reference code assigned by the developer to identify this order in their system.
45
45
  * @param fee_amount {String} The developer fee for the order. It is added to the base amount to determine the final charge.
@@ -290,7 +290,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
290
290
  PaymentOrderEventData.RequiredProperties = ["data_type", "order_id", "psp_order_code", "fee_amount", "chain_id", "payable_amount", "exchange_rate", "receive_address", "status", "received_token_amount"];
291
291
 
292
292
  /**
293
- * 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.
293
+ * 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.
294
294
  * @member {module:model/PaymentOrderEventData.DataTypeEnum} data_type
295
295
  */
296
296
  PaymentOrderEventData.prototype['data_type'] = undefined;
@@ -433,7 +433,7 @@ PaymentOrderEventData.prototype['settlement_status'] = undefined;
433
433
 
434
434
  // Implement WebhookEventDataType interface:
435
435
  /**
436
- * 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.
436
+ * 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.
437
437
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
438
438
  */
439
439
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -633,6 +633,11 @@ PaymentOrderEventData['DataTypeEnum'] = {
633
633
  * @const
634
634
  */
635
635
  "PaymentBulkSend": "PaymentBulkSend",
636
+ /**
637
+ * value: "PaymentAccountBalanceUpdate"
638
+ * @const
639
+ */
640
+ "PaymentAccountBalanceUpdate": "PaymentAccountBalanceUpdate",
636
641
  /**
637
642
  * value: "BalanceUpdateInfo"
638
643
  * @const
@@ -658,6 +663,16 @@ PaymentOrderEventData['DataTypeEnum'] = {
658
663
  * @const
659
664
  */
660
665
  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
666
+ /**
667
+ * value: "Organization"
668
+ * @const
669
+ */
670
+ "Organization": "Organization",
671
+ /**
672
+ * value: "FiatTransaction"
673
+ * @const
674
+ */
675
+ "FiatTransaction": "FiatTransaction",
661
676
  /**
662
677
  * value: "unknown_default_open_api"
663
678
  * @const
@@ -269,7 +269,7 @@ PaymentPayout.prototype['initiator'] = undefined;
269
269
  PaymentPayout.prototype['actual_payout_amount'] = undefined;
270
270
 
271
271
  /**
272
- * The commission fees of the payout.
272
+ * The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded.
273
273
  * @member {Array.<module:model/CommissionFee>} commission_fees
274
274
  */
275
275
  PaymentPayout.prototype['commission_fees'] = undefined;
@@ -298,7 +298,7 @@ PaymentPayoutDetail.prototype['initiator'] = undefined;
298
298
  PaymentPayoutDetail.prototype['actual_payout_amount'] = undefined;
299
299
 
300
300
  /**
301
- * The commission fees of the payout.
301
+ * The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded.
302
302
  * @member {Array.<module:model/CommissionFee>} commission_fees
303
303
  */
304
304
  PaymentPayoutDetail.prototype['commission_fees'] = undefined;
@@ -372,7 +372,7 @@ _PaymentPayout["default"].prototype['initiator'] = undefined;
372
372
  */
373
373
  _PaymentPayout["default"].prototype['actual_payout_amount'] = undefined;
374
374
  /**
375
- * The commission fees of the payout.
375
+ * The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded.
376
376
  * @member {Array.<module:model/CommissionFee>} commission_fees
377
377
  */
378
378
  _PaymentPayout["default"].prototype['commission_fees'] = undefined;
@@ -42,7 +42,7 @@ var PaymentPayoutEvent = /*#__PURE__*/function () {
42
42
  * @alias module:model/PaymentPayoutEvent
43
43
  * @implements module:model/WebhookEventDataType
44
44
  * @implements module:model/PaymentPayoutDetail
45
- * @param data_type {module:model/PaymentPayoutEvent.DataTypeEnum} 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.
45
+ * @param data_type {module:model/PaymentPayoutEvent.DataTypeEnum} 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.
46
46
  * @param payout_id {String} The payout ID generated by Cobo.
47
47
  * @param request_id {String} The request ID provided by you when creating the payout.
48
48
  * @param payout_channel {module:model/PayoutChannel}
@@ -265,7 +265,7 @@ var PaymentPayoutEvent = /*#__PURE__*/function () {
265
265
  PaymentPayoutEvent.RequiredProperties = ["data_type", "payout_id", "request_id", "payout_channel", "status", "created_timestamp", "updated_timestamp"];
266
266
 
267
267
  /**
268
- * 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.
268
+ * 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.
269
269
  * @member {module:model/PaymentPayoutEvent.DataTypeEnum} data_type
270
270
  */
271
271
  PaymentPayoutEvent.prototype['data_type'] = undefined;
@@ -317,7 +317,7 @@ PaymentPayoutEvent.prototype['initiator'] = undefined;
317
317
  PaymentPayoutEvent.prototype['actual_payout_amount'] = undefined;
318
318
 
319
319
  /**
320
- * The commission fees of the payout.
320
+ * The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded.
321
321
  * @member {Array.<module:model/CommissionFee>} commission_fees
322
322
  */
323
323
  PaymentPayoutEvent.prototype['commission_fees'] = undefined;
@@ -353,7 +353,7 @@ PaymentPayoutEvent.prototype['transactions'] = undefined;
353
353
 
354
354
  // Implement WebhookEventDataType interface:
355
355
  /**
356
- * 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.
356
+ * 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.
357
357
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
358
358
  */
359
359
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -397,7 +397,7 @@ _PaymentPayoutDetail["default"].prototype['initiator'] = undefined;
397
397
  */
398
398
  _PaymentPayoutDetail["default"].prototype['actual_payout_amount'] = undefined;
399
399
  /**
400
- * The commission fees of the payout.
400
+ * The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded.
401
401
  * @member {Array.<module:model/CommissionFee>} commission_fees
402
402
  */
403
403
  _PaymentPayoutDetail["default"].prototype['commission_fees'] = undefined;
@@ -507,6 +507,11 @@ PaymentPayoutEvent['DataTypeEnum'] = {
507
507
  * @const
508
508
  */
509
509
  "PaymentBulkSend": "PaymentBulkSend",
510
+ /**
511
+ * value: "PaymentAccountBalanceUpdate"
512
+ * @const
513
+ */
514
+ "PaymentAccountBalanceUpdate": "PaymentAccountBalanceUpdate",
510
515
  /**
511
516
  * value: "BalanceUpdateInfo"
512
517
  * @const
@@ -532,6 +537,16 @@ PaymentPayoutEvent['DataTypeEnum'] = {
532
537
  * @const
533
538
  */
534
539
  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
540
+ /**
541
+ * value: "Organization"
542
+ * @const
543
+ */
544
+ "Organization": "Organization",
545
+ /**
546
+ * value: "FiatTransaction"
547
+ * @const
548
+ */
549
+ "FiatTransaction": "FiatTransaction",
535
550
  /**
536
551
  * value: "unknown_default_open_api"
537
552
  * @const
@@ -122,7 +122,7 @@ PaymentPayoutRecipientInfo.prototype['token_id'] = undefined;
122
122
  PaymentPayoutRecipientInfo.prototype['currency'] = undefined;
123
123
 
124
124
  /**
125
- * 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).
125
+ * 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).
126
126
  * @member {String} bank_account_id
127
127
  */
128
128
  PaymentPayoutRecipientInfo.prototype['bank_account_id'] = undefined;
@@ -40,7 +40,7 @@ var PaymentRefundEventData = /*#__PURE__*/function () {
40
40
  * @alias module:model/PaymentRefundEventData
41
41
  * @implements module:model/WebhookEventDataType
42
42
  * @implements module:model/Refund
43
- * @param data_type {module:model/PaymentRefundEventData.DataTypeEnum} 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.
43
+ * @param data_type {module:model/PaymentRefundEventData.DataTypeEnum} 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.
44
44
  * @param refund_id {String} The refund order ID.
45
45
  * @param token_id {String} The ID of the cryptocurrency used for refund.
46
46
  * @param chain_id {String} The ID of the blockchain network on which the refund transaction occurs.
@@ -141,7 +141,7 @@ var PaymentRefundEventData = /*#__PURE__*/function () {
141
141
  obj['merchant_fee_token_id'] = _ApiClient["default"].convertToType(data['merchant_fee_token_id'], 'String');
142
142
  }
143
143
  if (data.hasOwnProperty('commission_fee')) {
144
- obj['commission_fee'] = _CommissionFee["default"].constructFromObject(data['commission_fee']);
144
+ obj['commission_fee'] = _ApiClient["default"].convertToType(data['commission_fee'], _CommissionFee["default"]);
145
145
  }
146
146
  }
147
147
  return obj;
@@ -253,7 +253,7 @@ var PaymentRefundEventData = /*#__PURE__*/function () {
253
253
  PaymentRefundEventData.RequiredProperties = ["data_type", "refund_id", "token_id", "chain_id", "amount", "to_address", "status"];
254
254
 
255
255
  /**
256
- * 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.
256
+ * 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.
257
257
  * @member {module:model/PaymentRefundEventData.DataTypeEnum} data_type
258
258
  */
259
259
  PaymentRefundEventData.prototype['data_type'] = undefined;
@@ -359,13 +359,14 @@ PaymentRefundEventData.prototype['merchant_fee_amount'] = undefined;
359
359
  PaymentRefundEventData.prototype['merchant_fee_token_id'] = undefined;
360
360
 
361
361
  /**
362
+ * The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded.
362
363
  * @member {module:model/CommissionFee} commission_fee
363
364
  */
364
365
  PaymentRefundEventData.prototype['commission_fee'] = undefined;
365
366
 
366
367
  // Implement WebhookEventDataType interface:
367
368
  /**
368
- * 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.
369
+ * 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.
369
370
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
370
371
  */
371
372
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -454,6 +455,7 @@ _Refund["default"].prototype['merchant_fee_amount'] = undefined;
454
455
  */
455
456
  _Refund["default"].prototype['merchant_fee_token_id'] = undefined;
456
457
  /**
458
+ * The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded.
457
459
  * @member {module:model/CommissionFee} commission_fee
458
460
  */
459
461
  _Refund["default"].prototype['commission_fee'] = undefined;
@@ -539,6 +541,11 @@ PaymentRefundEventData['DataTypeEnum'] = {
539
541
  * @const
540
542
  */
541
543
  "PaymentBulkSend": "PaymentBulkSend",
544
+ /**
545
+ * value: "PaymentAccountBalanceUpdate"
546
+ * @const
547
+ */
548
+ "PaymentAccountBalanceUpdate": "PaymentAccountBalanceUpdate",
542
549
  /**
543
550
  * value: "BalanceUpdateInfo"
544
551
  * @const
@@ -564,6 +571,16 @@ PaymentRefundEventData['DataTypeEnum'] = {
564
571
  * @const
565
572
  */
566
573
  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
574
+ /**
575
+ * value: "Organization"
576
+ * @const
577
+ */
578
+ "Organization": "Organization",
579
+ /**
580
+ * value: "FiatTransaction"
581
+ * @const
582
+ */
583
+ "FiatTransaction": "FiatTransaction",
567
584
  /**
568
585
  * value: "unknown_default_open_api"
569
586
  * @const
@@ -42,7 +42,7 @@ var PaymentSettlementEvent = /*#__PURE__*/function () {
42
42
  * @alias module:model/PaymentSettlementEvent
43
43
  * @implements module:model/WebhookEventDataType
44
44
  * @implements module:model/Settlement
45
- * @param data_type {module:model/PaymentSettlementEvent.DataTypeEnum} 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.
45
+ * @param data_type {module:model/PaymentSettlementEvent.DataTypeEnum} 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.
46
46
  * @param settlement_request_id {String} The settlement request ID generated by Cobo.
47
47
  * @param request_id {String} The request ID provided by you when creating the settlement request.
48
48
  * @param status {module:model/SettleRequestStatus}
@@ -212,7 +212,7 @@ var PaymentSettlementEvent = /*#__PURE__*/function () {
212
212
  PaymentSettlementEvent.RequiredProperties = ["data_type", "settlement_request_id", "request_id", "status", "settlements"];
213
213
 
214
214
  /**
215
- * 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.
215
+ * 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.
216
216
  * @member {module:model/PaymentSettlementEvent.DataTypeEnum} data_type
217
217
  */
218
218
  PaymentSettlementEvent.prototype['data_type'] = undefined;
@@ -291,7 +291,7 @@ PaymentSettlementEvent.prototype['bank_account'] = undefined;
291
291
 
292
292
  // Implement WebhookEventDataType interface:
293
293
  /**
294
- * 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.
294
+ * 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.
295
295
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
296
296
  */
297
297
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -437,6 +437,11 @@ PaymentSettlementEvent['DataTypeEnum'] = {
437
437
  * @const
438
438
  */
439
439
  "PaymentBulkSend": "PaymentBulkSend",
440
+ /**
441
+ * value: "PaymentAccountBalanceUpdate"
442
+ * @const
443
+ */
444
+ "PaymentAccountBalanceUpdate": "PaymentAccountBalanceUpdate",
440
445
  /**
441
446
  * value: "BalanceUpdateInfo"
442
447
  * @const
@@ -462,6 +467,16 @@ PaymentSettlementEvent['DataTypeEnum'] = {
462
467
  * @const
463
468
  */
464
469
  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
470
+ /**
471
+ * value: "Organization"
472
+ * @const
473
+ */
474
+ "Organization": "Organization",
475
+ /**
476
+ * value: "FiatTransaction"
477
+ * @const
478
+ */
479
+ "FiatTransaction": "FiatTransaction",
465
480
  /**
466
481
  * value: "unknown_default_open_api"
467
482
  * @const
@@ -49,7 +49,7 @@ var PaymentTransactionEventData = /*#__PURE__*/function () {
49
49
  * @alias module:model/PaymentTransactionEventData
50
50
  * @implements module:model/WebhookEventDataType
51
51
  * @implements module:model/Transaction
52
- * @param data_type {module:model/PaymentTransactionEventData.DataTypeEnum} 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.
52
+ * @param data_type {module:model/PaymentTransactionEventData.DataTypeEnum} 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.
53
53
  * @param transaction_id {String} The transaction ID.
54
54
  * @param wallet_id {String} For deposit transactions, this property represents the wallet ID of the transaction destination. For transactions of other types, this property represents the wallet ID of the transaction source.
55
55
  * @param status {module:model/TransactionStatus}
@@ -212,6 +212,15 @@ var PaymentTransactionEventData = /*#__PURE__*/function () {
212
212
  if (data.hasOwnProperty('custom_payer_id')) {
213
213
  obj['custom_payer_id'] = _ApiClient["default"].convertToType(data['custom_payer_id'], 'String');
214
214
  }
215
+ if (data.hasOwnProperty('merchant_id')) {
216
+ obj['merchant_id'] = _ApiClient["default"].convertToType(data['merchant_id'], 'String');
217
+ }
218
+ if (data.hasOwnProperty('subscription_id')) {
219
+ obj['subscription_id'] = _ApiClient["default"].convertToType(data['subscription_id'], 'String');
220
+ }
221
+ if (data.hasOwnProperty('action_id')) {
222
+ obj['action_id'] = _ApiClient["default"].convertToType(data['action_id'], 'String');
223
+ }
215
224
  }
216
225
  return obj;
217
226
  }
@@ -371,6 +380,18 @@ var PaymentTransactionEventData = /*#__PURE__*/function () {
371
380
  if (data['custom_payer_id'] && !(typeof data['custom_payer_id'] === 'string' || data['custom_payer_id'] instanceof String)) {
372
381
  throw new Error("Expected the field `custom_payer_id` to be a primitive type in the JSON string but got " + data['custom_payer_id']);
373
382
  }
383
+ // ensure the json data is a string
384
+ if (data['merchant_id'] && !(typeof data['merchant_id'] === 'string' || data['merchant_id'] instanceof String)) {
385
+ throw new Error("Expected the field `merchant_id` to be a primitive type in the JSON string but got " + data['merchant_id']);
386
+ }
387
+ // ensure the json data is a string
388
+ if (data['subscription_id'] && !(typeof data['subscription_id'] === 'string' || data['subscription_id'] instanceof String)) {
389
+ throw new Error("Expected the field `subscription_id` to be a primitive type in the JSON string but got " + data['subscription_id']);
390
+ }
391
+ // ensure the json data is a string
392
+ if (data['action_id'] && !(typeof data['action_id'] === 'string' || data['action_id'] instanceof String)) {
393
+ throw new Error("Expected the field `action_id` to be a primitive type in the JSON string but got " + data['action_id']);
394
+ }
374
395
  return true;
375
396
  }
376
397
  }]);
@@ -378,7 +399,7 @@ var PaymentTransactionEventData = /*#__PURE__*/function () {
378
399
  PaymentTransactionEventData.RequiredProperties = ["data_type", "transaction_id", "wallet_id", "status", "source", "destination", "initiator_type", "created_timestamp", "updated_timestamp", "acquiring_type"];
379
400
 
380
401
  /**
381
- * 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.
402
+ * 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.
382
403
  * @member {module:model/PaymentTransactionEventData.DataTypeEnum} data_type
383
404
  */
384
405
  PaymentTransactionEventData.prototype['data_type'] = undefined;
@@ -586,9 +607,27 @@ PaymentTransactionEventData.prototype['payer_id'] = undefined;
586
607
  */
587
608
  PaymentTransactionEventData.prototype['custom_payer_id'] = undefined;
588
609
 
610
+ /**
611
+ * The merchant ID.
612
+ * @member {String} merchant_id
613
+ */
614
+ PaymentTransactionEventData.prototype['merchant_id'] = undefined;
615
+
616
+ /**
617
+ * A unique identifier assigned by Cobo to track and identify subscription.
618
+ * @member {String} subscription_id
619
+ */
620
+ PaymentTransactionEventData.prototype['subscription_id'] = undefined;
621
+
622
+ /**
623
+ * A unique identifier assigned by Cobo to track and identify subscription action.
624
+ * @member {String} action_id
625
+ */
626
+ PaymentTransactionEventData.prototype['action_id'] = undefined;
627
+
589
628
  // Implement WebhookEventDataType interface:
590
629
  /**
591
- * 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.
630
+ * 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.
592
631
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
593
632
  */
594
633
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -818,6 +857,11 @@ PaymentTransactionEventData['DataTypeEnum'] = {
818
857
  * @const
819
858
  */
820
859
  "PaymentBulkSend": "PaymentBulkSend",
860
+ /**
861
+ * value: "PaymentAccountBalanceUpdate"
862
+ * @const
863
+ */
864
+ "PaymentAccountBalanceUpdate": "PaymentAccountBalanceUpdate",
821
865
  /**
822
866
  * value: "BalanceUpdateInfo"
823
867
  * @const
@@ -843,6 +887,16 @@ PaymentTransactionEventData['DataTypeEnum'] = {
843
887
  * @const
844
888
  */
845
889
  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
890
+ /**
891
+ * value: "Organization"
892
+ * @const
893
+ */
894
+ "Organization": "Organization",
895
+ /**
896
+ * value: "FiatTransaction"
897
+ * @const
898
+ */
899
+ "FiatTransaction": "FiatTransaction",
846
900
  /**
847
901
  * value: "unknown_default_open_api"
848
902
  * @const