@cobo/cobo-waas2 1.24.0 → 1.26.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 (188) hide show
  1. package/README.md +45 -6
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AutoSweepApi.js +2 -2
  4. package/dist/api/ComplianceApi.js +132 -2
  5. package/dist/api/DevelopersWebhooksApi.js +2 -2
  6. package/dist/api/FeeStationApi.js +6 -6
  7. package/dist/api/PaymentApi.js +109 -24
  8. package/dist/api/TokenizationApi.js +122 -4
  9. package/dist/api/TransactionsApi.js +4 -4
  10. package/dist/index.js +217 -14
  11. package/dist/model/AddressesEventData.js +8 -3
  12. package/dist/model/AutoFuelType.js +5 -0
  13. package/dist/model/BalanceUpdateInfoEventData.js +8 -3
  14. package/dist/model/BridgingFee.js +4 -4
  15. package/dist/model/ChainsEventData.js +8 -3
  16. package/dist/model/CommissionFee.js +2 -2
  17. package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
  18. package/dist/model/ComplianceKytScreeningsUpdateEventData.js +305 -0
  19. package/dist/model/CreateCryptoAddressRequest.js +1 -1
  20. package/dist/model/CreateMerchantRequest.js +2 -2
  21. package/dist/model/CreateOrderLinkRequest.js +129 -0
  22. package/dist/model/CreatePaymentOrderRequest.js +21 -8
  23. package/dist/model/CreateRefundLinkRequest.js +129 -0
  24. package/dist/model/CreateRefundRequest.js +2 -2
  25. package/dist/model/CreateSettlement.js +2 -28
  26. package/dist/model/CreateSettlementRequestRequest.js +3 -3
  27. package/dist/model/CustodialTransferDestination.js +1 -1
  28. package/dist/model/FeeStationCheckFeeStationUsage.js +28 -10
  29. package/dist/model/FeeStationCheckFeeStationUsageResponse.js +33 -20
  30. package/dist/model/FeeStationSponsorTransactionDescription.js +125 -0
  31. package/dist/model/FundsStatusType.js +111 -0
  32. package/dist/model/KytScreeningsDecisionsType.js +71 -0
  33. package/dist/model/KytScreeningsEventData.js +155 -0
  34. package/dist/model/KytScreeningsReviewType.js +61 -0
  35. package/dist/model/KytScreeningsTransaction.js +144 -0
  36. package/dist/model/KytScreeningsTransactionType.js +61 -0
  37. package/dist/model/Link.js +125 -0
  38. package/dist/model/LinkDisplayInfo.js +100 -0
  39. package/dist/model/MPCVaultEventData.js +8 -3
  40. package/dist/model/Merchant.js +3 -3
  41. package/dist/model/MerchantBalance.js +1 -1
  42. package/dist/model/Order.js +13 -0
  43. package/dist/model/OrderLinkBusinessInfo.js +261 -0
  44. package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +125 -0
  45. package/dist/model/OtcFee.js +3 -3
  46. package/dist/model/PaymentAddressUpdateEventData.js +8 -3
  47. package/dist/model/PaymentEstimateFee.js +4 -4
  48. package/dist/model/PaymentEstimateFee201Response.js +1 -0
  49. package/dist/model/PaymentEstimateFeeRequest.js +2 -1
  50. package/dist/model/PaymentEstimatedFee.js +4 -4
  51. package/dist/model/PaymentOrderEventData.js +26 -3
  52. package/dist/model/PaymentRefundEventData.js +8 -3
  53. package/dist/model/PaymentSettlementEvent.js +12 -7
  54. package/dist/model/PaymentTransactionEventData.js +8 -3
  55. package/dist/model/PspBalance.js +1 -1
  56. package/dist/model/RefundLinkBusinessInfo.js +162 -0
  57. package/dist/model/RefundStatus.js +10 -0
  58. package/dist/model/ReviewStatusType.js +91 -0
  59. package/dist/model/Settlement.js +2 -2
  60. package/dist/model/SubmitKytResponse.js +122 -0
  61. package/dist/model/SubmitKytScreeningsDecisionsBody.js +122 -0
  62. package/dist/model/SubmitKytScreeningsReviewBody.js +122 -0
  63. package/dist/model/SupportedToken.js +1 -1
  64. package/dist/model/SuspendedTokenEventData.js +8 -3
  65. package/dist/model/SwapQuote.js +18 -18
  66. package/dist/model/TSSRequestWebhookEventData.js +8 -3
  67. package/dist/model/TokenListingEventData.js +8 -3
  68. package/dist/model/TokenizationERC20TokenParams.js +5 -5
  69. package/dist/model/{TokenizationTokenPermissionParams.js → TokenizationERC20TokenPermissionParams.js} +23 -23
  70. package/dist/model/TokenizationERC20WrappedTokenParams.js +177 -0
  71. package/dist/model/TokenizationERC20WrappedTokenPermissionParams.js +166 -0
  72. package/dist/model/TokenizationEstimateFeeRequestOperationParams.js +38 -11
  73. package/dist/model/TokenizationIssueTokenParamsTokenParams.js +72 -10
  74. package/dist/model/TokenizationListPermissionsResponse.js +146 -0
  75. package/dist/model/TokenizationListPermissionsResponseDataInner.js +126 -0
  76. package/dist/model/TokenizationOperationType.js +5 -0
  77. package/dist/model/TokenizationPermissionAction.js +66 -0
  78. package/dist/model/TokenizationSOLWrappedTokenParams.js +177 -0
  79. package/dist/model/TokenizationSolWrappedTokenPermissionParams.js +127 -0
  80. package/dist/model/TokenizationTokenDetailInfo.js +51 -5
  81. package/dist/model/TokenizationTokenInfo.js +26 -4
  82. package/dist/model/TokenizationTokenPermissionType.js +5 -0
  83. package/dist/model/TokenizationTokenStandard.js +10 -0
  84. package/dist/model/{TokenizationTokenPermissionsResponse.js → TokenizationUpdateAddressPermissions.js} +51 -53
  85. package/dist/model/TokenizationUpdatePermissionsEstimateFeeParams.js +198 -0
  86. package/dist/model/TokenizationUpdatePermissionsParams.js +145 -0
  87. package/dist/model/TokenizationUpdatePermissionsRequest.js +213 -0
  88. package/dist/model/TokensEventData.js +8 -3
  89. package/dist/model/TransactionCoboCategory.js +35 -0
  90. package/dist/model/TransactionWebhookEventData.js +8 -3
  91. package/dist/model/UpdateMerchantByIdRequest.js +1 -1
  92. package/dist/model/WalletInfoEventData.js +8 -3
  93. package/dist/model/WebhookEventData.js +64 -12
  94. package/dist/model/WebhookEventDataType.js +7 -2
  95. package/dist/model/WebhookEventType.js +10 -0
  96. package/docs/AddressesEventData.md +3 -1
  97. package/docs/AutoFuelType.md +2 -0
  98. package/docs/AutoSweepApi.md +2 -2
  99. package/docs/BalanceUpdateInfoEventData.md +3 -1
  100. package/docs/BridgingFee.md +3 -3
  101. package/docs/ChainsEventData.md +3 -1
  102. package/docs/CommissionFee.md +1 -1
  103. package/docs/ComplianceApi.md +158 -1
  104. package/docs/ComplianceDispositionUpdateEventData.md +3 -1
  105. package/docs/ComplianceKytScreeningsUpdateEventData.md +57 -0
  106. package/docs/CreateCryptoAddressRequest.md +1 -1
  107. package/docs/CreateMerchantRequest.md +2 -2
  108. package/docs/CreateOrderLinkRequest.md +10 -0
  109. package/docs/CreatePaymentOrderRequest.md +6 -5
  110. package/docs/CreateRefundLinkRequest.md +10 -0
  111. package/docs/CreateRefundRequest.md +2 -2
  112. package/docs/CreateSettlement.md +1 -3
  113. package/docs/CreateSettlementRequestRequest.md +3 -3
  114. package/docs/DevelopersWebhooksApi.md +1 -1
  115. package/docs/FeeStationApi.md +4 -4
  116. package/docs/FeeStationCheckFeeStationUsage.md +4 -2
  117. package/docs/FeeStationCheckFeeStationUsageResponse.md +4 -3
  118. package/docs/FeeStationSponsorTransactionDescription.md +10 -0
  119. package/docs/FundsStatusType.md +32 -0
  120. package/docs/KytScreeningsDecisionsType.md +16 -0
  121. package/docs/KytScreeningsEventData.md +13 -0
  122. package/docs/KytScreeningsReviewType.md +12 -0
  123. package/docs/KytScreeningsTransaction.md +12 -0
  124. package/docs/KytScreeningsTransactionType.md +12 -0
  125. package/docs/Link.md +10 -0
  126. package/docs/LinkDisplayInfo.md +10 -0
  127. package/docs/MPCVaultEventData.md +3 -1
  128. package/docs/Merchant.md +2 -2
  129. package/docs/MerchantBalance.md +1 -1
  130. package/docs/Order.md +1 -0
  131. package/docs/OrderLinkBusinessInfo.md +19 -0
  132. package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +10 -0
  133. package/docs/OtcFee.md +2 -2
  134. package/docs/PaymentAddressUpdateEventData.md +3 -1
  135. package/docs/PaymentApi.md +118 -12
  136. package/docs/PaymentEstimateFee.md +2 -2
  137. package/docs/PaymentEstimateFee201Response.md +1 -1
  138. package/docs/PaymentEstimateFeeRequest.md +1 -1
  139. package/docs/PaymentEstimatedFee.md +2 -2
  140. package/docs/PaymentOrderEventData.md +4 -1
  141. package/docs/PaymentRefundEventData.md +3 -1
  142. package/docs/PaymentSettlementEvent.md +5 -3
  143. package/docs/PaymentTransactionEventData.md +3 -1
  144. package/docs/PspBalance.md +1 -1
  145. package/docs/RefundLinkBusinessInfo.md +13 -0
  146. package/docs/RefundStatus.md +4 -0
  147. package/docs/ReviewStatusType.md +24 -0
  148. package/docs/Settlement.md +2 -2
  149. package/docs/SubmitKytResponse.md +10 -0
  150. package/docs/SubmitKytScreeningsDecisionsBody.md +10 -0
  151. package/docs/SubmitKytScreeningsReviewBody.md +10 -0
  152. package/docs/SupportedToken.md +1 -1
  153. package/docs/SuspendedTokenEventData.md +3 -1
  154. package/docs/SwapQuote.md +10 -10
  155. package/docs/TSSRequestWebhookEventData.md +3 -1
  156. package/docs/TokenListingEventData.md +3 -1
  157. package/docs/TokenizationApi.md +120 -2
  158. package/docs/TokenizationERC20TokenParams.md +1 -1
  159. package/docs/{TokenizationTokenPermissionParams.md → TokenizationERC20TokenPermissionParams.md} +1 -1
  160. package/docs/TokenizationERC20WrappedTokenParams.md +14 -0
  161. package/docs/TokenizationERC20WrappedTokenPermissionParams.md +15 -0
  162. package/docs/TokenizationEstimateFeeRequestOperationParams.md +1 -1
  163. package/docs/TokenizationIssueTokenParamsTokenParams.md +2 -1
  164. package/docs/TokenizationListPermissionsResponse.md +10 -0
  165. package/docs/TokenizationListPermissionsResponseDataInner.md +10 -0
  166. package/docs/TokenizationOperationType.md +2 -0
  167. package/docs/TokenizationPermissionAction.md +14 -0
  168. package/docs/TokenizationSOLWrappedTokenParams.md +14 -0
  169. package/docs/TokenizationSolWrappedTokenPermissionParams.md +12 -0
  170. package/docs/TokenizationTokenDetailInfo.md +3 -0
  171. package/docs/TokenizationTokenInfo.md +2 -0
  172. package/docs/TokenizationTokenPermissionType.md +2 -0
  173. package/docs/TokenizationTokenStandard.md +4 -0
  174. package/docs/TokenizationUpdateAddressPermissions.md +11 -0
  175. package/docs/TokenizationUpdatePermissionsEstimateFeeParams.md +13 -0
  176. package/docs/TokenizationUpdatePermissionsParams.md +10 -0
  177. package/docs/TokenizationUpdatePermissionsRequest.md +13 -0
  178. package/docs/TokensEventData.md +3 -1
  179. package/docs/TransactionCoboCategory.md +14 -0
  180. package/docs/TransactionWebhookEventData.md +3 -1
  181. package/docs/TransactionsApi.md +2 -2
  182. package/docs/UpdateMerchantByIdRequest.md +1 -1
  183. package/docs/WalletInfoEventData.md +3 -1
  184. package/docs/WebhookEventData.md +10 -4
  185. package/docs/WebhookEventDataType.md +3 -1
  186. package/docs/WebhookEventType.md +4 -0
  187. package/package.json +1 -1
  188. package/docs/TokenizationTokenPermissionsResponse.md +0 -10
@@ -0,0 +1,125 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
+ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
11
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
12
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
13
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
14
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
15
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
+ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
18
+ * Cobo Wallet as a Service 2.0
19
+ *
20
+ * Contact: help@cobo.com
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * The OrderLinkBusinessInfoCustomExchangeRatesInner model module.
29
+ * @module model/OrderLinkBusinessInfoCustomExchangeRatesInner
30
+ */
31
+ var OrderLinkBusinessInfoCustomExchangeRatesInner = /*#__PURE__*/function () {
32
+ /**
33
+ * Constructs a new <code>OrderLinkBusinessInfoCustomExchangeRatesInner</code>.
34
+ * @alias module:model/OrderLinkBusinessInfoCustomExchangeRatesInner
35
+ * @param token_id {String} The token ID.
36
+ * @param exchange_rate {String} The exchange rate to use for this token.
37
+ */
38
+ function OrderLinkBusinessInfoCustomExchangeRatesInner(token_id, exchange_rate) {
39
+ _classCallCheck(this, OrderLinkBusinessInfoCustomExchangeRatesInner);
40
+ OrderLinkBusinessInfoCustomExchangeRatesInner.initialize(this, token_id, exchange_rate);
41
+ }
42
+
43
+ /**
44
+ * Initializes the fields of this object.
45
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
46
+ * Only for internal use.
47
+ */
48
+ return _createClass(OrderLinkBusinessInfoCustomExchangeRatesInner, null, [{
49
+ key: "initialize",
50
+ value: function initialize(obj, token_id, exchange_rate) {
51
+ obj['token_id'] = token_id;
52
+ obj['exchange_rate'] = exchange_rate;
53
+ }
54
+
55
+ /**
56
+ * Constructs a <code>OrderLinkBusinessInfoCustomExchangeRatesInner</code> from a plain JavaScript object, optionally creating a new instance.
57
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
58
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
59
+ * @param {module:model/OrderLinkBusinessInfoCustomExchangeRatesInner} obj Optional instance to populate.
60
+ * @return {module:model/OrderLinkBusinessInfoCustomExchangeRatesInner} The populated <code>OrderLinkBusinessInfoCustomExchangeRatesInner</code> instance.
61
+ */
62
+ }, {
63
+ key: "constructFromObject",
64
+ value: function constructFromObject(data, obj) {
65
+ if (data) {
66
+ obj = obj || new OrderLinkBusinessInfoCustomExchangeRatesInner();
67
+ if (data.hasOwnProperty('token_id')) {
68
+ obj['token_id'] = _ApiClient["default"].convertToType(data['token_id'], 'String');
69
+ }
70
+ if (data.hasOwnProperty('exchange_rate')) {
71
+ obj['exchange_rate'] = _ApiClient["default"].convertToType(data['exchange_rate'], 'String');
72
+ }
73
+ }
74
+ return obj;
75
+ }
76
+
77
+ /**
78
+ * Validates the JSON data with respect to <code>OrderLinkBusinessInfoCustomExchangeRatesInner</code>.
79
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
80
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>OrderLinkBusinessInfoCustomExchangeRatesInner</code>.
81
+ */
82
+ }, {
83
+ key: "validateJSON",
84
+ value: function validateJSON(data) {
85
+ // check to make sure all required properties are present in the JSON string
86
+ var _iterator = _createForOfIteratorHelper(OrderLinkBusinessInfoCustomExchangeRatesInner.RequiredProperties),
87
+ _step;
88
+ try {
89
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
90
+ var property = _step.value;
91
+ if (!data.hasOwnProperty(property)) {
92
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
93
+ }
94
+ }
95
+ // ensure the json data is a string
96
+ } catch (err) {
97
+ _iterator.e(err);
98
+ } finally {
99
+ _iterator.f();
100
+ }
101
+ if (data['token_id'] && !(typeof data['token_id'] === 'string' || data['token_id'] instanceof String)) {
102
+ throw new Error("Expected the field `token_id` to be a primitive type in the JSON string but got " + data['token_id']);
103
+ }
104
+ // ensure the json data is a string
105
+ if (data['exchange_rate'] && !(typeof data['exchange_rate'] === 'string' || data['exchange_rate'] instanceof String)) {
106
+ throw new Error("Expected the field `exchange_rate` to be a primitive type in the JSON string but got " + data['exchange_rate']);
107
+ }
108
+ return true;
109
+ }
110
+ }]);
111
+ }();
112
+ OrderLinkBusinessInfoCustomExchangeRatesInner.RequiredProperties = ["token_id", "exchange_rate"];
113
+
114
+ /**
115
+ * The token ID.
116
+ * @member {String} token_id
117
+ */
118
+ OrderLinkBusinessInfoCustomExchangeRatesInner.prototype['token_id'] = undefined;
119
+
120
+ /**
121
+ * The exchange rate to use for this token.
122
+ * @member {String} exchange_rate
123
+ */
124
+ OrderLinkBusinessInfoCustomExchangeRatesInner.prototype['exchange_rate'] = undefined;
125
+ var _default = exports["default"] = OrderLinkBusinessInfoCustomExchangeRatesInner;
@@ -32,7 +32,7 @@ var OtcFee = /*#__PURE__*/function () {
32
32
  /**
33
33
  * Constructs a new <code>OtcFee</code>.
34
34
  * @alias module:model/OtcFee
35
- * @param fee_rate {String} The otc fee rate.
35
+ * @param fee_rate {String} The exchange rate used to convert cryptos to fiat currencies during off-ramp. The final fiat amount is calculated using the following formula: Final Fiat Amount = (Token Amount - Bridging Fee) × Exchange Rate Note: The actual fiat amount received may be lower due to additional bank transfer fees.
36
36
  */
37
37
  function OtcFee(fee_rate) {
38
38
  _classCallCheck(this, OtcFee);
@@ -110,13 +110,13 @@ var OtcFee = /*#__PURE__*/function () {
110
110
  OtcFee.RequiredProperties = ["fee_rate"];
111
111
 
112
112
  /**
113
- * The otc fee rate.
113
+ * The exchange rate used to convert cryptos to fiat currencies during off-ramp. The final fiat amount is calculated using the following formula: Final Fiat Amount = (Token Amount - Bridging Fee) × Exchange Rate Note: The actual fiat amount received may be lower due to additional bank transfer fees.
114
114
  * @member {String} fee_rate
115
115
  */
116
116
  OtcFee.prototype['fee_rate'] = undefined;
117
117
 
118
118
  /**
119
- * The token id in otc.
119
+ * The ID of the token you want to off-ramp.
120
120
  * @member {String} token_id
121
121
  */
122
122
  OtcFee.prototype['token_id'] = undefined;
@@ -34,7 +34,7 @@ var PaymentAddressUpdateEventData = /*#__PURE__*/function () {
34
34
  * Constructs a new <code>PaymentAddressUpdateEventData</code>.
35
35
  * @alias module:model/PaymentAddressUpdateEventData
36
36
  * @implements module:model/WebhookEventDataType
37
- * @param data_type {module:model/PaymentAddressUpdateEventData.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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
37
+ * @param data_type {module:model/PaymentAddressUpdateEventData.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. - `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.
38
38
  * @param custom_payer_id {String} A unique identifier assigned by the developer to track and identify individual payers in their system.
39
39
  * @param payer_id {String} A unique identifier assigned by Cobo to track and identify individual payers.
40
40
  * @param chain {String} The chain ID.
@@ -152,7 +152,7 @@ var PaymentAddressUpdateEventData = /*#__PURE__*/function () {
152
152
  PaymentAddressUpdateEventData.RequiredProperties = ["data_type", "custom_payer_id", "payer_id", "chain", "previous_address", "updated_address"];
153
153
 
154
154
  /**
155
- * 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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
155
+ * 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. - `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.
156
156
  * @member {module:model/PaymentAddressUpdateEventData.DataTypeEnum} data_type
157
157
  */
158
158
  PaymentAddressUpdateEventData.prototype['data_type'] = undefined;
@@ -189,7 +189,7 @@ PaymentAddressUpdateEventData.prototype['updated_address'] = undefined;
189
189
 
190
190
  // Implement WebhookEventDataType interface:
191
191
  /**
192
- * 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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
192
+ * 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. - `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.
193
193
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
194
194
  */
195
195
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -280,6 +280,11 @@ PaymentAddressUpdateEventData['DataTypeEnum'] = {
280
280
  * @const
281
281
  */
282
282
  "ComplianceDisposition": "ComplianceDisposition",
283
+ /**
284
+ * value: "ComplianceKytScreenings"
285
+ * @const
286
+ */
287
+ "ComplianceKytScreenings": "ComplianceKytScreenings",
283
288
  /**
284
289
  * value: "unknown_default_open_api"
285
290
  * @const
@@ -32,8 +32,8 @@ var PaymentEstimateFee = /*#__PURE__*/function () {
32
32
  /**
33
33
  * Constructs a new <code>PaymentEstimateFee</code>.
34
34
  * @alias module:model/PaymentEstimateFee
35
- * @param token_id {String} The ID of the cryptocurrency you want to OffRamp settle.
36
- * @param amount {String} The OffRamp settlement amount.
35
+ * @param token_id {String} The token ID for which fees will be calculated.
36
+ * @param amount {String} The transaction amount for which fees will be calculated.
37
37
  */
38
38
  function PaymentEstimateFee(token_id, amount) {
39
39
  _classCallCheck(this, PaymentEstimateFee);
@@ -112,13 +112,13 @@ var PaymentEstimateFee = /*#__PURE__*/function () {
112
112
  PaymentEstimateFee.RequiredProperties = ["token_id", "amount"];
113
113
 
114
114
  /**
115
- * The ID of the cryptocurrency you want to OffRamp settle.
115
+ * The token ID for which fees will be calculated.
116
116
  * @member {String} token_id
117
117
  */
118
118
  PaymentEstimateFee.prototype['token_id'] = undefined;
119
119
 
120
120
  /**
121
- * The OffRamp settlement amount.
121
+ * The transaction amount for which fees will be calculated.
122
122
  * @member {String} amount
123
123
  */
124
124
  PaymentEstimateFee.prototype['amount'] = undefined;
@@ -101,6 +101,7 @@ var PaymentEstimateFee201Response = /*#__PURE__*/function () {
101
101
  }]);
102
102
  }();
103
103
  /**
104
+ * A list of estimated fees for the requested operations.
104
105
  * @member {Array.<module:model/PaymentEstimatedFee>} data
105
106
  */
106
107
  PaymentEstimateFee201Response.prototype['data'] = undefined;
@@ -34,7 +34,7 @@ var PaymentEstimateFeeRequest = /*#__PURE__*/function () {
34
34
  /**
35
35
  * Constructs a new <code>PaymentEstimateFeeRequest</code>.
36
36
  * @alias module:model/PaymentEstimateFeeRequest
37
- * @param estimate_fees {Array.<module:model/PaymentEstimateFee>}
37
+ * @param estimate_fees {Array.<module:model/PaymentEstimateFee>} A list of token IDs and amounts for which fees will be calculated.
38
38
  */
39
39
  function PaymentEstimateFeeRequest(estimate_fees) {
40
40
  _classCallCheck(this, PaymentEstimateFeeRequest);
@@ -130,6 +130,7 @@ PaymentEstimateFeeRequest.RequiredProperties = ["estimate_fees"];
130
130
  PaymentEstimateFeeRequest.prototype['fee_type'] = undefined;
131
131
 
132
132
  /**
133
+ * A list of token IDs and amounts for which fees will be calculated.
133
134
  * @member {Array.<module:model/PaymentEstimateFee>} estimate_fees
134
135
  */
135
136
  PaymentEstimateFeeRequest.prototype['estimate_fees'] = undefined;
@@ -35,8 +35,8 @@ var PaymentEstimatedFee = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>PaymentEstimatedFee</code>.
37
37
  * @alias module:model/PaymentEstimatedFee
38
- * @param token_id {String} The ID of the cryptocurrency you want to payment.
39
- * @param amount {String} The payment amount.
38
+ * @param token_id {String} The token ID for which fees will be calculated.
39
+ * @param amount {String} The transaction amount for which fees will be calculated.
40
40
  */
41
41
  function PaymentEstimatedFee(token_id, amount) {
42
42
  _classCallCheck(this, PaymentEstimatedFee);
@@ -145,13 +145,13 @@ var PaymentEstimatedFee = /*#__PURE__*/function () {
145
145
  PaymentEstimatedFee.RequiredProperties = ["token_id", "amount"];
146
146
 
147
147
  /**
148
- * The ID of the cryptocurrency you want to payment.
148
+ * The token ID for which fees will be calculated.
149
149
  * @member {String} token_id
150
150
  */
151
151
  PaymentEstimatedFee.prototype['token_id'] = undefined;
152
152
 
153
153
  /**
154
- * The payment amount.
154
+ * The transaction amount for which fees will be calculated.
155
155
  * @member {String} amount
156
156
  */
157
157
  PaymentEstimatedFee.prototype['amount'] = undefined;
@@ -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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `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.
43
43
  * @param order_id {String} The order ID.
44
44
  * @param token_id {String} The ID of the cryptocurrency used for payment. Supported tokens: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`
45
45
  * @param chain_id {String} The ID of the blockchain network where the payment transaction should be made. Supported chains: - USDC: `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` - USDT: `TRON`, `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC`
@@ -157,6 +157,9 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
157
157
  if (data.hasOwnProperty('settlement_status')) {
158
158
  obj['settlement_status'] = _SettleStatus["default"].constructFromObject(data['settlement_status']);
159
159
  }
160
+ if (data.hasOwnProperty('amount_tolerance')) {
161
+ obj['amount_tolerance'] = _ApiClient["default"].convertToType(data['amount_tolerance'], 'String');
162
+ }
160
163
  }
161
164
  return obj;
162
165
  }
@@ -261,6 +264,10 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
261
264
  }
262
265
  ;
263
266
  }
267
+ // ensure the json data is a string
268
+ if (data['amount_tolerance'] && !(typeof data['amount_tolerance'] === 'string' || data['amount_tolerance'] instanceof String)) {
269
+ throw new Error("Expected the field `amount_tolerance` to be a primitive type in the JSON string but got " + data['amount_tolerance']);
270
+ }
264
271
  return true;
265
272
  }
266
273
  }]);
@@ -268,7 +275,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
268
275
  PaymentOrderEventData.RequiredProperties = ["data_type", "order_id", "token_id", "chain_id", "payable_amount", "receive_address", "currency", "order_amount", "fee_amount", "exchange_rate", "psp_order_code", "status", "received_token_amount"];
269
276
 
270
277
  /**
271
- * 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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
278
+ * 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. - `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.
272
279
  * @member {module:model/PaymentOrderEventData.DataTypeEnum} data_type
273
280
  */
274
281
  PaymentOrderEventData.prototype['data_type'] = undefined;
@@ -385,9 +392,15 @@ PaymentOrderEventData.prototype['transactions'] = undefined;
385
392
  */
386
393
  PaymentOrderEventData.prototype['settlement_status'] = undefined;
387
394
 
395
+ /**
396
+ * The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur. When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.
397
+ * @member {String} amount_tolerance
398
+ */
399
+ PaymentOrderEventData.prototype['amount_tolerance'] = undefined;
400
+
388
401
  // Implement WebhookEventDataType interface:
389
402
  /**
390
- * 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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
403
+ * 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. - `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.
391
404
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
392
405
  */
393
406
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -485,6 +498,11 @@ _Order["default"].prototype['transactions'] = undefined;
485
498
  * @member {module:model/SettleStatus} settlement_status
486
499
  */
487
500
  _Order["default"].prototype['settlement_status'] = undefined;
501
+ /**
502
+ * The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur. When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.
503
+ * @member {String} amount_tolerance
504
+ */
505
+ _Order["default"].prototype['amount_tolerance'] = undefined;
488
506
 
489
507
  /**
490
508
  * Allowed values for the <code>data_type</code> property.
@@ -572,6 +590,11 @@ PaymentOrderEventData['DataTypeEnum'] = {
572
590
  * @const
573
591
  */
574
592
  "ComplianceDisposition": "ComplianceDisposition",
593
+ /**
594
+ * value: "ComplianceKytScreenings"
595
+ * @const
596
+ */
597
+ "ComplianceKytScreenings": "ComplianceKytScreenings",
575
598
  /**
576
599
  * value: "unknown_default_open_api"
577
600
  * @const
@@ -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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `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.
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.
@@ -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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `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.
257
257
  * @member {module:model/PaymentRefundEventData.DataTypeEnum} data_type
258
258
  */
259
259
  PaymentRefundEventData.prototype['data_type'] = undefined;
@@ -365,7 +365,7 @@ PaymentRefundEventData.prototype['commission_fee'] = undefined;
365
365
 
366
366
  // Implement WebhookEventDataType interface:
367
367
  /**
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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
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. - `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.
369
369
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
370
370
  */
371
371
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -544,6 +544,11 @@ PaymentRefundEventData['DataTypeEnum'] = {
544
544
  * @const
545
545
  */
546
546
  "ComplianceDisposition": "ComplianceDisposition",
547
+ /**
548
+ * value: "ComplianceKytScreenings"
549
+ * @const
550
+ */
551
+ "ComplianceKytScreenings": "ComplianceKytScreenings",
547
552
  /**
548
553
  * value: "unknown_default_open_api"
549
554
  * @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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `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.
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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `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.
216
216
  * @member {module:model/PaymentSettlementEvent.DataTypeEnum} data_type
217
217
  */
218
218
  PaymentSettlementEvent.prototype['data_type'] = undefined;
@@ -273,13 +273,13 @@ PaymentSettlementEvent.prototype['payout_channel'] = undefined;
273
273
  PaymentSettlementEvent.prototype['settlement_type'] = undefined;
274
274
 
275
275
  /**
276
- * The fiat currency for the settlement request.
276
+ * The fiat currency for the off-ramp.
277
277
  * @member {String} currency
278
278
  */
279
279
  PaymentSettlementEvent.prototype['currency'] = undefined;
280
280
 
281
281
  /**
282
- * The received fiat amount of this settlement request.
282
+ * The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees.
283
283
  * @member {String} received_amount_fiat
284
284
  */
285
285
  PaymentSettlementEvent.prototype['received_amount_fiat'] = 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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `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.
295
295
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
296
296
  */
297
297
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -342,12 +342,12 @@ _Settlement["default"].prototype['payout_channel'] = undefined;
342
342
  */
343
343
  _Settlement["default"].prototype['settlement_type'] = undefined;
344
344
  /**
345
- * The fiat currency for the settlement request.
345
+ * The fiat currency for the off-ramp.
346
346
  * @member {String} currency
347
347
  */
348
348
  _Settlement["default"].prototype['currency'] = undefined;
349
349
  /**
350
- * The received fiat amount of this settlement request.
350
+ * The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees.
351
351
  * @member {String} received_amount_fiat
352
352
  */
353
353
  _Settlement["default"].prototype['received_amount_fiat'] = undefined;
@@ -442,6 +442,11 @@ PaymentSettlementEvent['DataTypeEnum'] = {
442
442
  * @const
443
443
  */
444
444
  "ComplianceDisposition": "ComplianceDisposition",
445
+ /**
446
+ * value: "ComplianceKytScreenings"
447
+ * @const
448
+ */
449
+ "ComplianceKytScreenings": "ComplianceKytScreenings",
445
450
  /**
446
451
  * value: "unknown_default_open_api"
447
452
  * @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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `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.
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}
@@ -378,7 +378,7 @@ var PaymentTransactionEventData = /*#__PURE__*/function () {
378
378
  PaymentTransactionEventData.RequiredProperties = ["data_type", "transaction_id", "wallet_id", "status", "source", "destination", "initiator_type", "created_timestamp", "updated_timestamp", "acquiring_type"];
379
379
 
380
380
  /**
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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
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. - `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.
382
382
  * @member {module:model/PaymentTransactionEventData.DataTypeEnum} data_type
383
383
  */
384
384
  PaymentTransactionEventData.prototype['data_type'] = undefined;
@@ -588,7 +588,7 @@ PaymentTransactionEventData.prototype['custom_payer_id'] = undefined;
588
588
 
589
589
  // Implement WebhookEventDataType interface:
590
590
  /**
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. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data.
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. - `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.
592
592
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
593
593
  */
594
594
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -823,6 +823,11 @@ PaymentTransactionEventData['DataTypeEnum'] = {
823
823
  * @const
824
824
  */
825
825
  "ComplianceDisposition": "ComplianceDisposition",
826
+ /**
827
+ * value: "ComplianceKytScreenings"
828
+ * @const
829
+ */
830
+ "ComplianceKytScreenings": "ComplianceKytScreenings",
826
831
  /**
827
832
  * value: "unknown_default_open_api"
828
833
  * @const
@@ -162,7 +162,7 @@ PspBalance.prototype['settled_amount'] = undefined;
162
162
  PspBalance.prototype['refunded_amount'] = undefined;
163
163
 
164
164
  /**
165
- * The total balance of the token available for payout or refund for the developer. `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount` For more information, please refer to [Amounts and Balances](/v2_cn/payments/amounts-and-balances)
165
+ * The total balance of the token available for payout or refund for the developer. `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount` For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances)
166
166
  * @member {String} total_balance
167
167
  */
168
168
  PspBalance.prototype['total_balance'] = undefined;