@cobo/cobo-waas2 1.30.0 → 1.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -36
- package/dist/ApiClient.js +1 -1
- package/dist/api/AutoSweepApi.js +4 -4
- package/dist/api/FeeStationApi.js +4 -4
- package/dist/api/PaymentApi.js +76 -929
- package/dist/api/TransactionsApi.js +4 -4
- package/dist/api/WalletsApi.js +83 -0
- package/dist/index.js +35 -105
- package/dist/model/Balance.js +14 -0
- package/dist/model/BridgingFee.js +9 -0
- package/dist/model/ContractCallParams.js +16 -0
- package/dist/model/CreateDestinationBankAccount.js +26 -0
- package/dist/model/CreatePaymentOrderRequest.js +4 -3
- package/dist/model/CreateTopUpAddresses.js +2 -2
- package/dist/model/CreateWalletAddress.js +2 -2
- package/dist/model/DestinationBankAccount.js +26 -0
- package/dist/model/DestinationBankAccountDetail.js +26 -0
- package/dist/model/IntermediaryBankInfo.js +4 -6
- package/dist/model/MerchantBalance.js +4 -6
- package/dist/model/PaymentBridgeStatus.js +61 -0
- package/dist/model/PaymentBulkSendItem.js +9 -9
- package/dist/model/PaymentPayout.js +35 -4
- package/dist/model/PaymentPayoutDetail.js +49 -13
- package/dist/model/PaymentPayoutEvent.js +49 -13
- package/dist/model/PreCheck.js +89 -0
- package/dist/model/ReportType.js +5 -0
- package/dist/model/SkipCheckType.js +56 -0
- package/dist/model/SupportedToken.js +17 -17
- package/dist/model/TransactionDepositToAddressDestinationTxInfo.js +26 -0
- package/dist/model/TransactionRawTxInfo.js +32 -1
- package/dist/model/TransactionSelectedUtxo.js +39 -0
- package/dist/model/TransactionUtxoChange.js +13 -0
- package/dist/model/TransferParams.js +16 -0
- package/dist/model/TriggerTestPaymentWebhookEventResponse.js +83 -0
- package/dist/model/{QueryDestinationWhitelistEnabled200Response.js → TriggerTestPaymentsWebhookEventRequest.js} +35 -26
- package/dist/model/UTXO.js +48 -0
- package/dist/model/UpdateDestinationBankAccount.js +26 -0
- package/dist/model/WebhookEventData.js +6 -0
- package/dist/model/WebhookEventType.js +25 -0
- package/docs/AutoSweepApi.md +2 -2
- package/docs/Balance.md +1 -0
- package/docs/BridgingFee.md +1 -0
- package/docs/ContractCallParams.md +1 -0
- package/docs/CreateDestinationBankAccount.md +2 -0
- package/docs/CreatePaymentOrderRequest.md +2 -2
- package/docs/CreateTopUpAddresses.md +1 -1
- package/docs/CreateWalletAddress.md +1 -1
- package/docs/DestinationBankAccount.md +2 -0
- package/docs/DestinationBankAccountDetail.md +2 -0
- package/docs/FeeStationApi.md +2 -2
- package/docs/IntermediaryBankInfo.md +1 -1
- package/docs/MerchantBalance.md +1 -1
- package/docs/PaymentApi.md +185 -1153
- package/docs/PaymentBridgeStatus.md +12 -0
- package/docs/PaymentBulkSendItem.md +5 -5
- package/docs/PaymentPayout.md +2 -1
- package/docs/PaymentPayoutDetail.md +2 -1
- package/docs/PaymentPayoutEvent.md +2 -1
- package/docs/PreCheck.md +9 -0
- package/docs/ReportType.md +2 -0
- package/docs/SkipCheckType.md +10 -0
- package/docs/SupportedToken.md +10 -10
- package/docs/TransactionDepositToAddressDestinationTxInfo.md +2 -0
- package/docs/TransactionRawTxInfo.md +2 -1
- package/docs/TransactionSelectedUtxo.md +3 -0
- package/docs/TransactionUtxoChange.md +1 -0
- package/docs/TransactionsApi.md +2 -2
- package/docs/TransferParams.md +1 -0
- package/docs/TriggerTestPaymentWebhookEventResponse.md +9 -0
- package/docs/TriggerTestPaymentsWebhookEventRequest.md +10 -0
- package/docs/UTXO.md +4 -0
- package/docs/UpdateDestinationBankAccount.md +2 -0
- package/docs/WalletsApi.md +71 -0
- package/docs/WebhookEventData.md +1 -0
- package/docs/WebhookEventType.md +10 -0
- package/package.json +1 -1
- package/dist/model/CreateCounterpartyWalletAddressRequest.js +0 -140
- package/dist/model/CreateDestinationBankAccountRequest.js +0 -272
- package/dist/model/CreateDestinationWalletAddressRequest.js +0 -140
- package/dist/model/DeleteCounterparty200Response.js +0 -110
- package/dist/model/DeleteCounterpartyWalletAddress200Response.js +0 -110
- package/dist/model/DeleteDestination200Response.js +0 -110
- package/dist/model/DeleteDestinationBankAccount200Response.js +0 -110
- package/dist/model/DeleteDestinationWalletAddress200Response.js +0 -110
- package/dist/model/EnableDestinationWhitelistRequest.js +0 -106
- package/dist/model/ListCounterpartyWalletAddress200Response.js +0 -123
- package/dist/model/ListDestinationBankAccounts200Response.js +0 -123
- package/dist/model/ListDestinationWalletAddresses200Response.js +0 -123
- package/dist/model/UpdateCounterpartyByIdRequest.js +0 -160
- package/dist/model/UpdateDestinationByIdRequest.js +0 -173
- package/docs/CreateCounterpartyWalletAddressRequest.md +0 -11
- package/docs/CreateDestinationBankAccountRequest.md +0 -20
- package/docs/CreateDestinationWalletAddressRequest.md +0 -11
- package/docs/DeleteCounterparty200Response.md +0 -9
- package/docs/DeleteCounterpartyWalletAddress200Response.md +0 -9
- package/docs/DeleteDestination200Response.md +0 -9
- package/docs/DeleteDestinationBankAccount200Response.md +0 -9
- package/docs/DeleteDestinationWalletAddress200Response.md +0 -9
- package/docs/EnableDestinationWhitelistRequest.md +0 -9
- package/docs/ListCounterpartyWalletAddress200Response.md +0 -10
- package/docs/ListDestinationBankAccounts200Response.md +0 -10
- package/docs/ListDestinationWalletAddresses200Response.md +0 -10
- package/docs/QueryDestinationWhitelistEnabled200Response.md +0 -9
- package/docs/UpdateCounterpartyByIdRequest.md +0 -13
- package/docs/UpdateDestinationByIdRequest.md +0 -14
|
@@ -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 _WebhookEventType = _interopRequireDefault(require("./WebhookEventType"));
|
|
8
9
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
9
10
|
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
11
|
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; } } }; }
|
|
@@ -25,18 +26,18 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
25
26
|
*
|
|
26
27
|
*/
|
|
27
28
|
/**
|
|
28
|
-
* The
|
|
29
|
-
* @module model/
|
|
29
|
+
* The TriggerTestPaymentsWebhookEventRequest model module.
|
|
30
|
+
* @module model/TriggerTestPaymentsWebhookEventRequest
|
|
30
31
|
*/
|
|
31
|
-
var
|
|
32
|
+
var TriggerTestPaymentsWebhookEventRequest = /*#__PURE__*/function () {
|
|
32
33
|
/**
|
|
33
|
-
* Constructs a new <code>
|
|
34
|
-
* @alias module:model/
|
|
35
|
-
* @param
|
|
34
|
+
* Constructs a new <code>TriggerTestPaymentsWebhookEventRequest</code>.
|
|
35
|
+
* @alias module:model/TriggerTestPaymentsWebhookEventRequest
|
|
36
|
+
* @param event_type {module:model/WebhookEventType}
|
|
36
37
|
*/
|
|
37
|
-
function
|
|
38
|
-
_classCallCheck(this,
|
|
39
|
-
|
|
38
|
+
function TriggerTestPaymentsWebhookEventRequest(event_type) {
|
|
39
|
+
_classCallCheck(this, TriggerTestPaymentsWebhookEventRequest);
|
|
40
|
+
TriggerTestPaymentsWebhookEventRequest.initialize(this, event_type);
|
|
40
41
|
}
|
|
41
42
|
|
|
42
43
|
/**
|
|
@@ -44,41 +45,44 @@ var QueryDestinationWhitelistEnabled200Response = /*#__PURE__*/function () {
|
|
|
44
45
|
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
45
46
|
* Only for internal use.
|
|
46
47
|
*/
|
|
47
|
-
return _createClass(
|
|
48
|
+
return _createClass(TriggerTestPaymentsWebhookEventRequest, null, [{
|
|
48
49
|
key: "initialize",
|
|
49
|
-
value: function initialize(obj,
|
|
50
|
-
obj['
|
|
50
|
+
value: function initialize(obj, event_type) {
|
|
51
|
+
obj['event_type'] = event_type;
|
|
51
52
|
}
|
|
52
53
|
|
|
53
54
|
/**
|
|
54
|
-
* Constructs a <code>
|
|
55
|
+
* Constructs a <code>TriggerTestPaymentsWebhookEventRequest</code> from a plain JavaScript object, optionally creating a new instance.
|
|
55
56
|
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
56
57
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
57
|
-
* @param {module:model/
|
|
58
|
-
* @return {module:model/
|
|
58
|
+
* @param {module:model/TriggerTestPaymentsWebhookEventRequest} obj Optional instance to populate.
|
|
59
|
+
* @return {module:model/TriggerTestPaymentsWebhookEventRequest} The populated <code>TriggerTestPaymentsWebhookEventRequest</code> instance.
|
|
59
60
|
*/
|
|
60
61
|
}, {
|
|
61
62
|
key: "constructFromObject",
|
|
62
63
|
value: function constructFromObject(data, obj) {
|
|
63
64
|
if (data) {
|
|
64
|
-
obj = obj || new
|
|
65
|
-
if (data.hasOwnProperty('
|
|
66
|
-
obj['
|
|
65
|
+
obj = obj || new TriggerTestPaymentsWebhookEventRequest();
|
|
66
|
+
if (data.hasOwnProperty('event_type')) {
|
|
67
|
+
obj['event_type'] = _WebhookEventType["default"].constructFromObject(data['event_type']);
|
|
68
|
+
}
|
|
69
|
+
if (data.hasOwnProperty('override_data')) {
|
|
70
|
+
obj['override_data'] = _ApiClient["default"].convertToType(data['override_data'], Object);
|
|
67
71
|
}
|
|
68
72
|
}
|
|
69
73
|
return obj;
|
|
70
74
|
}
|
|
71
75
|
|
|
72
76
|
/**
|
|
73
|
-
* Validates the JSON data with respect to <code>
|
|
77
|
+
* Validates the JSON data with respect to <code>TriggerTestPaymentsWebhookEventRequest</code>.
|
|
74
78
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
75
|
-
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>
|
|
79
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>TriggerTestPaymentsWebhookEventRequest</code>.
|
|
76
80
|
*/
|
|
77
81
|
}, {
|
|
78
82
|
key: "validateJSON",
|
|
79
83
|
value: function validateJSON(data) {
|
|
80
84
|
// check to make sure all required properties are present in the JSON string
|
|
81
|
-
var _iterator = _createForOfIteratorHelper(
|
|
85
|
+
var _iterator = _createForOfIteratorHelper(TriggerTestPaymentsWebhookEventRequest.RequiredProperties),
|
|
82
86
|
_step;
|
|
83
87
|
try {
|
|
84
88
|
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
@@ -96,11 +100,16 @@ var QueryDestinationWhitelistEnabled200Response = /*#__PURE__*/function () {
|
|
|
96
100
|
}
|
|
97
101
|
}]);
|
|
98
102
|
}();
|
|
99
|
-
|
|
103
|
+
TriggerTestPaymentsWebhookEventRequest.RequiredProperties = ["event_type"];
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* @member {module:model/WebhookEventType} event_type
|
|
107
|
+
*/
|
|
108
|
+
TriggerTestPaymentsWebhookEventRequest.prototype['event_type'] = undefined;
|
|
100
109
|
|
|
101
110
|
/**
|
|
102
|
-
*
|
|
103
|
-
* @member {
|
|
111
|
+
* An optional object to customize the webhook event payload. Include only the fields you want to override. The provided fields must match the webhook event data structure for the specified event type. For the full event data structure, refer to the `data.data` property in the response of [List all webhook events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-webhook-events). If this property is omitted, a default payload is returned.
|
|
112
|
+
* @member {Object} override_data
|
|
104
113
|
*/
|
|
105
|
-
|
|
106
|
-
var _default = exports["default"] =
|
|
114
|
+
TriggerTestPaymentsWebhookEventRequest.prototype['override_data'] = undefined;
|
|
115
|
+
var _default = exports["default"] = TriggerTestPaymentsWebhookEventRequest;
|
package/dist/model/UTXO.js
CHANGED
|
@@ -84,6 +84,18 @@ var UTXO = /*#__PURE__*/function () {
|
|
|
84
84
|
if (data.hasOwnProperty('is_frozen')) {
|
|
85
85
|
obj['is_frozen'] = _ApiClient["default"].convertToType(data['is_frozen'], 'Boolean');
|
|
86
86
|
}
|
|
87
|
+
if (data.hasOwnProperty('is_change')) {
|
|
88
|
+
obj['is_change'] = _ApiClient["default"].convertToType(data['is_change'], 'Boolean');
|
|
89
|
+
}
|
|
90
|
+
if (data.hasOwnProperty('chain_id')) {
|
|
91
|
+
obj['chain_id'] = _ApiClient["default"].convertToType(data['chain_id'], 'String');
|
|
92
|
+
}
|
|
93
|
+
if (data.hasOwnProperty('object_id')) {
|
|
94
|
+
obj['object_id'] = _ApiClient["default"].convertToType(data['object_id'], 'String');
|
|
95
|
+
}
|
|
96
|
+
if (data.hasOwnProperty('version')) {
|
|
97
|
+
obj['version'] = _ApiClient["default"].convertToType(data['version'], 'String');
|
|
98
|
+
}
|
|
87
99
|
}
|
|
88
100
|
return obj;
|
|
89
101
|
}
|
|
@@ -112,6 +124,18 @@ var UTXO = /*#__PURE__*/function () {
|
|
|
112
124
|
if (data['value'] && !(typeof data['value'] === 'string' || data['value'] instanceof String)) {
|
|
113
125
|
throw new Error("Expected the field `value` to be a primitive type in the JSON string but got " + data['value']);
|
|
114
126
|
}
|
|
127
|
+
// ensure the json data is a string
|
|
128
|
+
if (data['chain_id'] && !(typeof data['chain_id'] === 'string' || data['chain_id'] instanceof String)) {
|
|
129
|
+
throw new Error("Expected the field `chain_id` to be a primitive type in the JSON string but got " + data['chain_id']);
|
|
130
|
+
}
|
|
131
|
+
// ensure the json data is a string
|
|
132
|
+
if (data['object_id'] && !(typeof data['object_id'] === 'string' || data['object_id'] instanceof String)) {
|
|
133
|
+
throw new Error("Expected the field `object_id` to be a primitive type in the JSON string but got " + data['object_id']);
|
|
134
|
+
}
|
|
135
|
+
// ensure the json data is a string
|
|
136
|
+
if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
|
|
137
|
+
throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
|
|
138
|
+
}
|
|
115
139
|
return true;
|
|
116
140
|
}
|
|
117
141
|
}]);
|
|
@@ -169,4 +193,28 @@ UTXO.prototype['confirmed_number'] = undefined;
|
|
|
169
193
|
* @member {Boolean} is_frozen
|
|
170
194
|
*/
|
|
171
195
|
UTXO.prototype['is_frozen'] = undefined;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Whether the UTXO is a change output of a transaction.
|
|
199
|
+
* @member {Boolean} is_change
|
|
200
|
+
*/
|
|
201
|
+
UTXO.prototype['is_change'] = undefined;
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* The chain ID, which is the unique identifier of a blockchain.
|
|
205
|
+
* @member {String} chain_id
|
|
206
|
+
*/
|
|
207
|
+
UTXO.prototype['chain_id'] = undefined;
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* The ID of the blockchain object to spend (e.g., SUI Coin object).
|
|
211
|
+
* @member {String} object_id
|
|
212
|
+
*/
|
|
213
|
+
UTXO.prototype['object_id'] = undefined;
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* Object version number.
|
|
217
|
+
* @member {String} version
|
|
218
|
+
*/
|
|
219
|
+
UTXO.prototype['version'] = undefined;
|
|
172
220
|
var _default = exports["default"] = UTXO;
|
|
@@ -110,6 +110,12 @@ var UpdateDestinationBankAccount = /*#__PURE__*/function () {
|
|
|
110
110
|
if (data.hasOwnProperty('intermediary_bank_info')) {
|
|
111
111
|
obj['intermediary_bank_info'] = _IntermediaryBankInfo["default"].constructFromObject(data['intermediary_bank_info']);
|
|
112
112
|
}
|
|
113
|
+
if (data.hasOwnProperty('country')) {
|
|
114
|
+
obj['country'] = _ApiClient["default"].convertToType(data['country'], 'String');
|
|
115
|
+
}
|
|
116
|
+
if (data.hasOwnProperty('city')) {
|
|
117
|
+
obj['city'] = _ApiClient["default"].convertToType(data['city'], 'String');
|
|
118
|
+
}
|
|
113
119
|
}
|
|
114
120
|
return obj;
|
|
115
121
|
}
|
|
@@ -184,6 +190,14 @@ var UpdateDestinationBankAccount = /*#__PURE__*/function () {
|
|
|
184
190
|
_IntermediaryBankInfo["default"].validateJSON(data['intermediary_bank_info']);
|
|
185
191
|
}
|
|
186
192
|
}
|
|
193
|
+
// ensure the json data is a string
|
|
194
|
+
if (data['country'] && !(typeof data['country'] === 'string' || data['country'] instanceof String)) {
|
|
195
|
+
throw new Error("Expected the field `country` to be a primitive type in the JSON string but got " + data['country']);
|
|
196
|
+
}
|
|
197
|
+
// ensure the json data is a string
|
|
198
|
+
if (data['city'] && !(typeof data['city'] === 'string' || data['city'] instanceof String)) {
|
|
199
|
+
throw new Error("Expected the field `city` to be a primitive type in the JSON string but got " + data['city']);
|
|
200
|
+
}
|
|
187
201
|
return true;
|
|
188
202
|
}
|
|
189
203
|
}]);
|
|
@@ -254,4 +268,16 @@ UpdateDestinationBankAccount.prototype['further_credit'] = undefined;
|
|
|
254
268
|
* @member {module:model/IntermediaryBankInfo} intermediary_bank_info
|
|
255
269
|
*/
|
|
256
270
|
UpdateDestinationBankAccount.prototype['intermediary_bank_info'] = undefined;
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Beneficiary's country, in ISO 3166-1 alpha-3 format.
|
|
274
|
+
* @member {String} country
|
|
275
|
+
*/
|
|
276
|
+
UpdateDestinationBankAccount.prototype['country'] = undefined;
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* Beneficiary's city.
|
|
280
|
+
* @member {String} city
|
|
281
|
+
*/
|
|
282
|
+
UpdateDestinationBankAccount.prototype['city'] = undefined;
|
|
257
283
|
var _default = exports["default"] = UpdateDestinationBankAccount;
|
|
@@ -1266,6 +1266,12 @@ WebhookEventData.prototype['recipient_info'] = undefined;
|
|
|
1266
1266
|
*/
|
|
1267
1267
|
WebhookEventData.prototype['actual_payout_amount'] = undefined;
|
|
1268
1268
|
|
|
1269
|
+
/**
|
|
1270
|
+
* The commission fees of the payout.
|
|
1271
|
+
* @member {Array.<module:model/CommissionFee>} commission_fees
|
|
1272
|
+
*/
|
|
1273
|
+
WebhookEventData.prototype['commission_fees'] = undefined;
|
|
1274
|
+
|
|
1269
1275
|
/**
|
|
1270
1276
|
* A note or comment about the payout.
|
|
1271
1277
|
* @member {String} remark
|
|
@@ -185,6 +185,11 @@ var WebhookEventType = exports["default"] = /*#__PURE__*/function () {
|
|
|
185
185
|
* @const
|
|
186
186
|
*/
|
|
187
187
|
_defineProperty(this, "payment.status.updated", "payment.status.updated");
|
|
188
|
+
/**
|
|
189
|
+
* value: "payment.order.status.updated"
|
|
190
|
+
* @const
|
|
191
|
+
*/
|
|
192
|
+
_defineProperty(this, "payment.order.status.updated", "payment.order.status.updated");
|
|
188
193
|
/**
|
|
189
194
|
* value: "payment.refund.status.updated"
|
|
190
195
|
* @const
|
|
@@ -220,6 +225,26 @@ var WebhookEventType = exports["default"] = /*#__PURE__*/function () {
|
|
|
220
225
|
* @const
|
|
221
226
|
*/
|
|
222
227
|
_defineProperty(this, "payment.bulk_send.status.updated", "payment.bulk_send.status.updated");
|
|
228
|
+
/**
|
|
229
|
+
* value: "payment.transaction.external.created"
|
|
230
|
+
* @const
|
|
231
|
+
*/
|
|
232
|
+
_defineProperty(this, "payment.transaction.external.created", "payment.transaction.external.created");
|
|
233
|
+
/**
|
|
234
|
+
* value: "payment.transaction.external.completed"
|
|
235
|
+
* @const
|
|
236
|
+
*/
|
|
237
|
+
_defineProperty(this, "payment.transaction.external.completed", "payment.transaction.external.completed");
|
|
238
|
+
/**
|
|
239
|
+
* value: "payment.transaction.settlement_network.created"
|
|
240
|
+
* @const
|
|
241
|
+
*/
|
|
242
|
+
_defineProperty(this, "payment.transaction.settlement_network.created", "payment.transaction.settlement_network.created");
|
|
243
|
+
/**
|
|
244
|
+
* value: "payment.transaction.settlement_network.completed"
|
|
245
|
+
* @const
|
|
246
|
+
*/
|
|
247
|
+
_defineProperty(this, "payment.transaction.settlement_network.completed", "payment.transaction.settlement_network.completed");
|
|
223
248
|
/**
|
|
224
249
|
* value: "compliance.disposition.status.updated"
|
|
225
250
|
* @const
|
package/docs/AutoSweepApi.md
CHANGED
|
@@ -213,8 +213,8 @@ Name | Type | Description | Notes
|
|
|
213
213
|
**wallet_id** | **String**| The wallet ID. |
|
|
214
214
|
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
215
215
|
**task_ids** | **String**| A list of auto-sweep task IDs, separated by comma. | [optional]
|
|
216
|
-
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
|
|
217
|
-
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change. | [optional]
|
|
216
|
+
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If you specify `min_created_timestamp` without specifying `max_created_timestamp`, `max_created_timestamp` is automatically set to `min_created_timestamp` + 90 days. If you specify both, the time range cannot exceed 90 days. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
|
|
217
|
+
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If you specify `max_created_timestamp` without specifying `min_created_timestamp`, `min_created_timestamp` is automatically set to `max_created_timestamp` - 90 days. If you specify both, the time range cannot exceed 90 days. If not provided, the default value is the current time. This default value is subject to change. | [optional]
|
|
218
218
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
219
219
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
220
220
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
package/docs/Balance.md
CHANGED
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**available** | **String** | The amount of tokens ready to be spent. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
9
9
|
**pending** | **String** | The total amount being sent in a transaction, which is calculated as the withdrawal amount plus the transaction fee. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
10
10
|
**locked** | **String** | For UTXO chains, this is the combined value of the selected UTXOs for the transaction. For other chains, it is equal to the Pending amount. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
11
|
+
**frozen** | **String** | Amount frozen due to compliance inspection. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
11
12
|
|
|
12
13
|
|
package/docs/BridgingFee.md
CHANGED
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**fee_amount** | **String** | The fee charged for bridging tokens to another chain. |
|
|
8
8
|
**received_token_id** | **String** | The ID of the destination token received after bridging. | [optional]
|
|
9
9
|
**received_amount** | **String** | The final amount of the token received after bridging. | [optional]
|
|
10
|
+
**bridge_status** | [**PaymentBridgeStatus**](PaymentBridgeStatus.md) | | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
14
14
|
**transaction_process_type** | [**TransactionProcessType**](TransactionProcessType.md) | | [optional]
|
|
15
15
|
**auto_fuel** | [**AutoFuelType**](AutoFuelType.md) | | [optional]
|
|
16
|
+
**pre_check** | [**PreCheck**](PreCheck.md) | | [optional]
|
|
16
17
|
|
|
17
18
|
|
|
@@ -15,5 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
16
16
|
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
17
17
|
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
18
|
+
**country** | **String** | Beneficiary's country, in ISO 3166-1 alpha-3 format. | [optional]
|
|
19
|
+
**city** | **String** | Beneficiary's city. | [optional]
|
|
18
20
|
|
|
19
21
|
|
|
@@ -7,12 +7,12 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. |
|
|
8
8
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
|
|
9
9
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
10
|
-
**pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com/
|
|
10
|
+
**pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com//payments/en/guides/supported-chains-and-tokens#pricing-currency). | [optional]
|
|
11
11
|
**pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional]
|
|
12
12
|
**fee_amount** | **String** | The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. |
|
|
13
13
|
**payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
14
14
|
**payable_amount** | **String** | The total amount the payer needs to pay, denominated in the specified `payable_currency`. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. | [optional]
|
|
15
|
-
**expired_in** | **Number** | The pay-in order will expire
|
|
15
|
+
**expired_in** | **Number** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. | [optional] [default to 1800]
|
|
16
16
|
**amount_tolerance** | **String** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional]
|
|
17
17
|
**currency** | **String** | This field has been deprecated. Please use `pricing_currency` instead. | [optional] [default to '']
|
|
18
18
|
**order_amount** | **String** | This field has been deprecated. Please use `pricing_amount` instead. | [optional]
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. If not provided, the default merchant created during organization initialization will be used. | [optional]
|
|
8
8
|
**token_id** | **String** | The token ID, which identifies the cryptocurrency. |
|
|
9
|
-
**custom_payer_ids** | **[String]** | A list of unique custom payer IDs required to create top-up addresses.
|
|
9
|
+
**custom_payer_ids** | **[String]** | A list of unique custom payer IDs required to create top-up addresses. |
|
|
10
10
|
|
|
11
11
|
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**address** | **String** | The wallet address. |
|
|
8
|
-
**chain_id** | **String** | The chain ID of the
|
|
8
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. Supported values in the development environment: - Counterparty: `ARBITRUM_ETH`, `BASE_ETH`, `BSC_BNB`, `ETH`, `TRON`, `MATIC`, `SOL`, `TTRON`, `SOLDEV_SOL`, `SETH` - Destination: `All EVM Networks`, `SOL`, `TRON`, `TTRON`, `SOLDEV_SOL` Supported values in the production environment: - Counterparty: `ARBITRUM_ETH`, `BASE_ETH`, `BSC_BNB`, `ETH`, `TRON`, `MATIC`, `SOL` - Destination: `All EVM Networks`, `SOL`, `TRON` |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -19,5 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**bank_account_status** | [**BankAccountStatus**](BankAccountStatus.md) | |
|
|
20
20
|
**created_timestamp** | **Number** | The created time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
21
21
|
**updated_timestamp** | **Number** | The updated time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
22
|
+
**country** | **String** | Beneficiary's country, in ISO 3166-1 alpha-3 format. | [optional]
|
|
23
|
+
**city** | **String** | Beneficiary's city. | [optional]
|
|
22
24
|
|
|
23
25
|
|
|
@@ -24,6 +24,8 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
25
25
|
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
26
26
|
**bank_account_status** | [**BankAccountStatus**](BankAccountStatus.md) | |
|
|
27
|
+
**country** | **String** | Beneficiary's country, in ISO 3166-1 alpha-3 format. | [optional]
|
|
28
|
+
**city** | **String** | Beneficiary's city. | [optional]
|
|
27
29
|
**created_timestamp** | **Number** | The created time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
28
30
|
**updated_timestamp** | **Number** | The updated time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
29
31
|
|
package/docs/FeeStationApi.md
CHANGED
|
@@ -286,8 +286,8 @@ Name | Type | Description | Notes
|
|
|
286
286
|
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
287
287
|
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
288
288
|
**asset_ids** | **String**| (This concept applies to Exchange Wallets only) A list of asset IDs, separated by comma. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional]
|
|
289
|
-
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
|
|
290
|
-
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change. | [optional]
|
|
289
|
+
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If you specify `min_created_timestamp` without specifying `max_created_timestamp`, `max_created_timestamp` is automatically set to `min_created_timestamp` + 90 days. If you specify both, the time range cannot exceed 90 days. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
|
|
290
|
+
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If you specify `max_created_timestamp` without specifying `min_created_timestamp`, `min_created_timestamp` is automatically set to `max_created_timestamp` - 90 days. If you specify both, the time range cannot exceed 90 days. If not provided, the default value is the current time. This default value is subject to change. | [optional]
|
|
291
291
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
292
292
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
293
293
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**bank_name** | **String** | The name of the intermediary bank. |
|
|
8
|
-
**bank_address** | **String** | The address of the intermediary bank. |
|
|
8
|
+
**bank_address** | **String** | The address of the intermediary bank. | [optional]
|
|
9
9
|
**bank_swift_code** | **String** | The SWIFT or BIC code of the intermediary bank. |
|
|
10
10
|
|
|
11
11
|
|
package/docs/MerchantBalance.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. |
|
|
8
8
|
**token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. |
|
|
9
|
-
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
|
|
9
|
+
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
10
10
|
**total_received_amount** | **String** | The total amount of the token that has been received by the merchant. | [optional]
|
|
11
11
|
**settled_amount** | **String** | The total amount of the token that has been paid out from the merchant's balance. | [optional]
|
|
12
12
|
**payout_amount** | **String** | This field is reserved for future use. | [optional]
|