@cobo/cobo-waas2 1.25.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.
- package/README.md +21 -5
- package/dist/ApiClient.js +1 -1
- package/dist/api/AutoSweepApi.js +2 -2
- package/dist/api/ComplianceApi.js +2 -2
- package/dist/api/FeeStationApi.js +6 -6
- package/dist/api/PaymentApi.js +48 -6
- package/dist/api/TokenizationApi.js +122 -4
- package/dist/api/TransactionsApi.js +2 -2
- package/dist/index.js +105 -14
- package/dist/model/AutoFuelType.js +5 -0
- package/dist/model/CreateCryptoAddressRequest.js +1 -1
- package/dist/model/CreateMerchantRequest.js +1 -1
- package/dist/model/CreatePaymentOrderRequest.js +8 -8
- package/dist/model/CreateRefundLinkRequest.js +129 -0
- package/dist/model/FeeStationCheckFeeStationUsage.js +28 -10
- package/dist/model/FeeStationCheckFeeStationUsageResponse.js +33 -20
- package/dist/model/FeeStationSponsorTransactionDescription.js +125 -0
- package/dist/model/Link.js +2 -2
- package/dist/model/LinkDisplayInfo.js +2 -2
- package/dist/model/MerchantBalance.js +1 -1
- package/dist/model/Order.js +1 -1
- package/dist/model/OrderLinkBusinessInfo.js +11 -11
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +4 -4
- package/dist/model/PaymentOrderEventData.js +2 -2
- package/dist/model/PspBalance.js +1 -1
- package/dist/model/RefundLinkBusinessInfo.js +162 -0
- package/dist/model/RefundStatus.js +10 -0
- package/dist/model/SubmitKytScreeningsReviewBody.js +1 -1
- package/dist/model/SwapQuote.js +18 -18
- package/dist/model/TokenizationERC20TokenParams.js +5 -5
- package/dist/model/{TokenizationTokenPermissionParams.js → TokenizationERC20TokenPermissionParams.js} +23 -23
- package/dist/model/TokenizationERC20WrappedTokenParams.js +177 -0
- package/dist/model/TokenizationERC20WrappedTokenPermissionParams.js +166 -0
- package/dist/model/TokenizationEstimateFeeRequestOperationParams.js +38 -11
- package/dist/model/TokenizationIssueTokenParamsTokenParams.js +72 -10
- package/dist/model/TokenizationListPermissionsResponse.js +146 -0
- package/dist/model/TokenizationListPermissionsResponseDataInner.js +126 -0
- package/dist/model/TokenizationOperationType.js +5 -0
- package/dist/model/TokenizationPermissionAction.js +66 -0
- package/dist/model/TokenizationSOLWrappedTokenParams.js +177 -0
- package/dist/model/TokenizationSolWrappedTokenPermissionParams.js +127 -0
- package/dist/model/TokenizationTokenDetailInfo.js +51 -5
- package/dist/model/TokenizationTokenInfo.js +26 -4
- package/dist/model/TokenizationTokenPermissionType.js +5 -0
- package/dist/model/TokenizationTokenStandard.js +10 -0
- package/dist/model/{TokenizationTokenPermissionsResponse.js → TokenizationUpdateAddressPermissions.js} +51 -53
- package/dist/model/TokenizationUpdatePermissionsEstimateFeeParams.js +198 -0
- package/dist/model/TokenizationUpdatePermissionsParams.js +145 -0
- package/dist/model/TokenizationUpdatePermissionsRequest.js +213 -0
- package/dist/model/TransactionCoboCategory.js +35 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/WebhookEventData.js +1 -1
- package/docs/AutoFuelType.md +2 -0
- package/docs/AutoSweepApi.md +2 -2
- package/docs/ComplianceApi.md +1 -1
- package/docs/CreateCryptoAddressRequest.md +1 -1
- package/docs/CreateMerchantRequest.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +5 -5
- package/docs/CreateRefundLinkRequest.md +10 -0
- package/docs/FeeStationApi.md +4 -4
- package/docs/FeeStationCheckFeeStationUsage.md +4 -2
- package/docs/FeeStationCheckFeeStationUsageResponse.md +4 -3
- package/docs/FeeStationSponsorTransactionDescription.md +10 -0
- package/docs/Link.md +1 -1
- package/docs/LinkDisplayInfo.md +2 -2
- package/docs/MerchantBalance.md +1 -1
- package/docs/Order.md +1 -1
- package/docs/OrderLinkBusinessInfo.md +7 -7
- package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +2 -2
- package/docs/PaymentApi.md +56 -3
- package/docs/PaymentOrderEventData.md +1 -1
- package/docs/PspBalance.md +1 -1
- package/docs/RefundLinkBusinessInfo.md +13 -0
- package/docs/RefundStatus.md +4 -0
- package/docs/SwapQuote.md +10 -10
- package/docs/TokenizationApi.md +120 -2
- package/docs/TokenizationERC20TokenParams.md +1 -1
- package/docs/{TokenizationTokenPermissionParams.md → TokenizationERC20TokenPermissionParams.md} +1 -1
- package/docs/TokenizationERC20WrappedTokenParams.md +14 -0
- package/docs/TokenizationERC20WrappedTokenPermissionParams.md +15 -0
- package/docs/TokenizationEstimateFeeRequestOperationParams.md +1 -1
- package/docs/TokenizationIssueTokenParamsTokenParams.md +2 -1
- package/docs/TokenizationListPermissionsResponse.md +10 -0
- package/docs/TokenizationListPermissionsResponseDataInner.md +10 -0
- package/docs/TokenizationOperationType.md +2 -0
- package/docs/TokenizationPermissionAction.md +14 -0
- package/docs/TokenizationSOLWrappedTokenParams.md +14 -0
- package/docs/TokenizationSolWrappedTokenPermissionParams.md +12 -0
- package/docs/TokenizationTokenDetailInfo.md +3 -0
- package/docs/TokenizationTokenInfo.md +2 -0
- package/docs/TokenizationTokenPermissionType.md +2 -0
- package/docs/TokenizationTokenStandard.md +4 -0
- package/docs/TokenizationUpdateAddressPermissions.md +11 -0
- package/docs/TokenizationUpdatePermissionsEstimateFeeParams.md +13 -0
- package/docs/TokenizationUpdatePermissionsParams.md +10 -0
- package/docs/TokenizationUpdatePermissionsRequest.md +13 -0
- package/docs/TransactionCoboCategory.md +14 -0
- package/docs/TransactionsApi.md +1 -1
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/WebhookEventData.md +1 -1
- package/package.json +1 -1
- package/docs/TokenizationTokenPermissionsResponse.md +0 -10
|
@@ -0,0 +1,213 @@
|
|
|
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
|
+
var _TokenizationAppInitiator = _interopRequireDefault(require("./TokenizationAppInitiator"));
|
|
9
|
+
var _TokenizationTokenOperationSource = _interopRequireDefault(require("./TokenizationTokenOperationSource"));
|
|
10
|
+
var _TokenizationUpdateAddressPermissions = _interopRequireDefault(require("./TokenizationUpdateAddressPermissions"));
|
|
11
|
+
var _TokenizationUpdatePermissionsParams = _interopRequireDefault(require("./TokenizationUpdatePermissionsParams"));
|
|
12
|
+
var _TransactionRequestFee = _interopRequireDefault(require("./TransactionRequestFee"));
|
|
13
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
14
|
+
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); }
|
|
15
|
+
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; } } }; }
|
|
16
|
+
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; } }
|
|
17
|
+
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; }
|
|
18
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
19
|
+
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); } }
|
|
20
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
21
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
22
|
+
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); } /**
|
|
23
|
+
* Cobo Wallet as a Service 2.0
|
|
24
|
+
*
|
|
25
|
+
* Contact: help@cobo.com
|
|
26
|
+
*
|
|
27
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
28
|
+
* https://openapi-generator.tech
|
|
29
|
+
* Do not edit the class manually.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
/**
|
|
33
|
+
* The TokenizationUpdatePermissionsRequest model module.
|
|
34
|
+
* @module model/TokenizationUpdatePermissionsRequest
|
|
35
|
+
*/
|
|
36
|
+
var TokenizationUpdatePermissionsRequest = /*#__PURE__*/function () {
|
|
37
|
+
/**
|
|
38
|
+
* Constructs a new <code>TokenizationUpdatePermissionsRequest</code>.
|
|
39
|
+
* @alias module:model/TokenizationUpdatePermissionsRequest
|
|
40
|
+
* @implements module:model/TokenizationUpdatePermissionsParams
|
|
41
|
+
* @implements module:model/TokenizationAppInitiator
|
|
42
|
+
* @param source {module:model/TokenizationTokenOperationSource}
|
|
43
|
+
* @param addresses {Array.<module:model/TokenizationUpdateAddressPermissions>}
|
|
44
|
+
* @param fee {module:model/TransactionRequestFee}
|
|
45
|
+
*/
|
|
46
|
+
function TokenizationUpdatePermissionsRequest(source, addresses, fee) {
|
|
47
|
+
_classCallCheck(this, TokenizationUpdatePermissionsRequest);
|
|
48
|
+
_TokenizationUpdatePermissionsParams["default"].initialize(this, source, addresses);
|
|
49
|
+
_TokenizationAppInitiator["default"].initialize(this);
|
|
50
|
+
TokenizationUpdatePermissionsRequest.initialize(this, source, addresses, fee);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Initializes the fields of this object.
|
|
55
|
+
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
56
|
+
* Only for internal use.
|
|
57
|
+
*/
|
|
58
|
+
return _createClass(TokenizationUpdatePermissionsRequest, null, [{
|
|
59
|
+
key: "initialize",
|
|
60
|
+
value: function initialize(obj, source, addresses, fee) {
|
|
61
|
+
obj['source'] = source;
|
|
62
|
+
obj['addresses'] = addresses;
|
|
63
|
+
obj['fee'] = fee;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Constructs a <code>TokenizationUpdatePermissionsRequest</code> from a plain JavaScript object, optionally creating a new instance.
|
|
68
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
69
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
70
|
+
* @param {module:model/TokenizationUpdatePermissionsRequest} obj Optional instance to populate.
|
|
71
|
+
* @return {module:model/TokenizationUpdatePermissionsRequest} The populated <code>TokenizationUpdatePermissionsRequest</code> instance.
|
|
72
|
+
*/
|
|
73
|
+
}, {
|
|
74
|
+
key: "constructFromObject",
|
|
75
|
+
value: function constructFromObject(data, obj) {
|
|
76
|
+
if (data) {
|
|
77
|
+
obj = obj || new TokenizationUpdatePermissionsRequest();
|
|
78
|
+
_TokenizationUpdatePermissionsParams["default"].constructFromObject(data, obj);
|
|
79
|
+
_TokenizationAppInitiator["default"].constructFromObject(data, obj);
|
|
80
|
+
if (data.hasOwnProperty('source')) {
|
|
81
|
+
obj['source'] = _TokenizationTokenOperationSource["default"].constructFromObject(data['source']);
|
|
82
|
+
}
|
|
83
|
+
if (data.hasOwnProperty('addresses')) {
|
|
84
|
+
obj['addresses'] = _ApiClient["default"].convertToType(data['addresses'], [_TokenizationUpdateAddressPermissions["default"]]);
|
|
85
|
+
}
|
|
86
|
+
if (data.hasOwnProperty('app_initiator')) {
|
|
87
|
+
obj['app_initiator'] = _ApiClient["default"].convertToType(data['app_initiator'], 'String');
|
|
88
|
+
}
|
|
89
|
+
if (data.hasOwnProperty('fee')) {
|
|
90
|
+
obj['fee'] = _TransactionRequestFee["default"].constructFromObject(data['fee']);
|
|
91
|
+
}
|
|
92
|
+
if (data.hasOwnProperty('request_id')) {
|
|
93
|
+
obj['request_id'] = _ApiClient["default"].convertToType(data['request_id'], 'String');
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
return obj;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Validates the JSON data with respect to <code>TokenizationUpdatePermissionsRequest</code>.
|
|
101
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
102
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>TokenizationUpdatePermissionsRequest</code>.
|
|
103
|
+
*/
|
|
104
|
+
}, {
|
|
105
|
+
key: "validateJSON",
|
|
106
|
+
value: function validateJSON(data) {
|
|
107
|
+
// check to make sure all required properties are present in the JSON string
|
|
108
|
+
var _iterator = _createForOfIteratorHelper(TokenizationUpdatePermissionsRequest.RequiredProperties),
|
|
109
|
+
_step;
|
|
110
|
+
try {
|
|
111
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
112
|
+
var property = _step.value;
|
|
113
|
+
if (!data.hasOwnProperty(property)) {
|
|
114
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
// validate the optional field `source`
|
|
118
|
+
} catch (err) {
|
|
119
|
+
_iterator.e(err);
|
|
120
|
+
} finally {
|
|
121
|
+
_iterator.f();
|
|
122
|
+
}
|
|
123
|
+
if (data['source']) {
|
|
124
|
+
// data not null
|
|
125
|
+
if (!!_TokenizationTokenOperationSource["default"].validateJSON) {
|
|
126
|
+
_TokenizationTokenOperationSource["default"].validateJSON(data['source']);
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
if (data['addresses']) {
|
|
130
|
+
// data not null
|
|
131
|
+
// ensure the json data is an array
|
|
132
|
+
if (!Array.isArray(data['addresses'])) {
|
|
133
|
+
throw new Error("Expected the field `addresses` to be an array in the JSON data but got " + data['addresses']);
|
|
134
|
+
}
|
|
135
|
+
// validate the optional field `addresses` (array)
|
|
136
|
+
var _iterator2 = _createForOfIteratorHelper(data['addresses']),
|
|
137
|
+
_step2;
|
|
138
|
+
try {
|
|
139
|
+
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
|
|
140
|
+
var item = _step2.value;
|
|
141
|
+
_TokenizationUpdateAddressPermissions["default"].validateJSON(item);
|
|
142
|
+
}
|
|
143
|
+
} catch (err) {
|
|
144
|
+
_iterator2.e(err);
|
|
145
|
+
} finally {
|
|
146
|
+
_iterator2.f();
|
|
147
|
+
}
|
|
148
|
+
;
|
|
149
|
+
}
|
|
150
|
+
// ensure the json data is a string
|
|
151
|
+
if (data['app_initiator'] && !(typeof data['app_initiator'] === 'string' || data['app_initiator'] instanceof String)) {
|
|
152
|
+
throw new Error("Expected the field `app_initiator` to be a primitive type in the JSON string but got " + data['app_initiator']);
|
|
153
|
+
}
|
|
154
|
+
// validate the optional field `fee`
|
|
155
|
+
if (data['fee']) {
|
|
156
|
+
// data not null
|
|
157
|
+
if (!!_TransactionRequestFee["default"].validateJSON) {
|
|
158
|
+
_TransactionRequestFee["default"].validateJSON(data['fee']);
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
// ensure the json data is a string
|
|
162
|
+
if (data['request_id'] && !(typeof data['request_id'] === 'string' || data['request_id'] instanceof String)) {
|
|
163
|
+
throw new Error("Expected the field `request_id` to be a primitive type in the JSON string but got " + data['request_id']);
|
|
164
|
+
}
|
|
165
|
+
return true;
|
|
166
|
+
}
|
|
167
|
+
}]);
|
|
168
|
+
}();
|
|
169
|
+
TokenizationUpdatePermissionsRequest.RequiredProperties = ["source", "addresses", "fee"];
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* @member {module:model/TokenizationTokenOperationSource} source
|
|
173
|
+
*/
|
|
174
|
+
TokenizationUpdatePermissionsRequest.prototype['source'] = undefined;
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* @member {Array.<module:model/TokenizationUpdateAddressPermissions>} addresses
|
|
178
|
+
*/
|
|
179
|
+
TokenizationUpdatePermissionsRequest.prototype['addresses'] = undefined;
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator.
|
|
183
|
+
* @member {String} app_initiator
|
|
184
|
+
*/
|
|
185
|
+
TokenizationUpdatePermissionsRequest.prototype['app_initiator'] = undefined;
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* @member {module:model/TransactionRequestFee} fee
|
|
189
|
+
*/
|
|
190
|
+
TokenizationUpdatePermissionsRequest.prototype['fee'] = undefined;
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization.
|
|
194
|
+
* @member {String} request_id
|
|
195
|
+
*/
|
|
196
|
+
TokenizationUpdatePermissionsRequest.prototype['request_id'] = undefined;
|
|
197
|
+
|
|
198
|
+
// Implement TokenizationUpdatePermissionsParams interface:
|
|
199
|
+
/**
|
|
200
|
+
* @member {module:model/TokenizationTokenOperationSource} source
|
|
201
|
+
*/
|
|
202
|
+
_TokenizationUpdatePermissionsParams["default"].prototype['source'] = undefined;
|
|
203
|
+
/**
|
|
204
|
+
* @member {Array.<module:model/TokenizationUpdateAddressPermissions>} addresses
|
|
205
|
+
*/
|
|
206
|
+
_TokenizationUpdatePermissionsParams["default"].prototype['addresses'] = undefined;
|
|
207
|
+
// Implement TokenizationAppInitiator interface:
|
|
208
|
+
/**
|
|
209
|
+
* The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator.
|
|
210
|
+
* @member {String} app_initiator
|
|
211
|
+
*/
|
|
212
|
+
_TokenizationAppInitiator["default"].prototype['app_initiator'] = undefined;
|
|
213
|
+
var _default = exports["default"] = TokenizationUpdatePermissionsRequest;
|
|
@@ -190,6 +190,41 @@ var TransactionCoboCategory = exports["default"] = /*#__PURE__*/function () {
|
|
|
190
190
|
* @const
|
|
191
191
|
*/
|
|
192
192
|
_defineProperty(this, "StellarChangeTrust", "StellarChangeTrust");
|
|
193
|
+
/**
|
|
194
|
+
* value: "Tokenization"
|
|
195
|
+
* @const
|
|
196
|
+
*/
|
|
197
|
+
_defineProperty(this, "Tokenization", "Tokenization");
|
|
198
|
+
/**
|
|
199
|
+
* value: "TokenizationGasSponsor"
|
|
200
|
+
* @const
|
|
201
|
+
*/
|
|
202
|
+
_defineProperty(this, "TokenizationGasSponsor", "TokenizationGasSponsor");
|
|
203
|
+
/**
|
|
204
|
+
* value: "TokenSwap"
|
|
205
|
+
* @const
|
|
206
|
+
*/
|
|
207
|
+
_defineProperty(this, "TokenSwap", "TokenSwap");
|
|
208
|
+
/**
|
|
209
|
+
* value: "NonceAccountSign"
|
|
210
|
+
* @const
|
|
211
|
+
*/
|
|
212
|
+
_defineProperty(this, "NonceAccountSign", "NonceAccountSign");
|
|
213
|
+
/**
|
|
214
|
+
* value: "FeePayerSign"
|
|
215
|
+
* @const
|
|
216
|
+
*/
|
|
217
|
+
_defineProperty(this, "FeePayerSign", "FeePayerSign");
|
|
218
|
+
/**
|
|
219
|
+
* value: "GasFeeSponsor"
|
|
220
|
+
* @const
|
|
221
|
+
*/
|
|
222
|
+
_defineProperty(this, "GasFeeSponsor", "GasFeeSponsor");
|
|
223
|
+
/**
|
|
224
|
+
* value: "GasFeeSponsorRefund"
|
|
225
|
+
* @const
|
|
226
|
+
*/
|
|
227
|
+
_defineProperty(this, "GasFeeSponsorRefund", "GasFeeSponsorRefund");
|
|
193
228
|
/**
|
|
194
229
|
* value: "unknown_default_open_api"
|
|
195
230
|
* @const
|
|
@@ -93,7 +93,7 @@ var UpdateMerchantByIdRequest = /*#__PURE__*/function () {
|
|
|
93
93
|
UpdateMerchantByIdRequest.prototype['name'] = undefined;
|
|
94
94
|
|
|
95
95
|
/**
|
|
96
|
-
* The developer fee rate applied to this merchant.
|
|
96
|
+
* The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).
|
|
97
97
|
* @member {String} developer_fee_rate
|
|
98
98
|
*/
|
|
99
99
|
UpdateMerchantByIdRequest.prototype['developer_fee_rate'] = undefined;
|
|
@@ -1014,7 +1014,7 @@ WebhookEventData.prototype['transactions'] = undefined;
|
|
|
1014
1014
|
WebhookEventData.prototype['settlement_status'] = undefined;
|
|
1015
1015
|
|
|
1016
1016
|
/**
|
|
1017
|
-
*
|
|
1017
|
+
* 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`.
|
|
1018
1018
|
* @member {String} amount_tolerance
|
|
1019
1019
|
*/
|
|
1020
1020
|
WebhookEventData.prototype['amount_tolerance'] = undefined;
|
package/docs/AutoFuelType.md
CHANGED
package/docs/AutoSweepApi.md
CHANGED
|
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**createAutoSweepTask**](AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks | Create auto-sweep task
|
|
8
|
-
[**createWalletSweepToAddresses**](AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses |
|
|
8
|
+
[**createWalletSweepToAddresses**](AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | Create sweep-to address
|
|
9
9
|
[**getAutoSweepTaskById**](AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto-sweep task details
|
|
10
10
|
[**listAutoSweepTask**](AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List auto-sweep tasks
|
|
11
11
|
[**listWalletSweepToAddresses**](AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List sweep-to addresses
|
|
@@ -68,7 +68,7 @@ Name | Type | Description | Notes
|
|
|
68
68
|
|
|
69
69
|
> SweepToAddress createWalletSweepToAddresses(opts)
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Create sweep-to address
|
|
72
72
|
|
|
73
73
|
This operation creates a new sweep-to address for the specified wallet. The previously sweep-to address for the same token becomes invalid once the new one is created. Use this operation to change the sweep-to address when your setup changes, you switch networks, or the current address is compromised or tainted by suspicious funds. You can withdraw any remaining balances from the old sweep-to addresses to the new address or another designated destination. <Note>Sweep-to addresses are only applicable to MPC Wallets and Web3 Wallets with the auto-sweep feature enabled.</Note>
|
|
74
74
|
|
package/docs/ComplianceApi.md
CHANGED
|
@@ -254,7 +254,7 @@ apiInstance.submitKytManualReview(opts).then((data) => {
|
|
|
254
254
|
|
|
255
255
|
Name | Type | Description | Notes
|
|
256
256
|
------------- | ------------- | ------------- | -------------
|
|
257
|
-
**SubmitKytScreeningsReviewBody** | [**SubmitKytScreeningsReviewBody**](SubmitKytScreeningsReviewBody.md)| The request body to submit a manual review result for KYT screening case that requires human analysis. | [optional]
|
|
257
|
+
**SubmitKytScreeningsReviewBody** | [**SubmitKytScreeningsReviewBody**](SubmitKytScreeningsReviewBody.md)| The request body to submit a manual review result for a KYT screening case that requires human analysis. | [optional]
|
|
258
258
|
|
|
259
259
|
### Return type
|
|
260
260
|
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**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}`. Supported values include: - 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` |
|
|
8
8
|
**address** | **String** | The blockchain address in its native format. This is the actual destination address where funds will be sent. The address must match the format required by the specified blockchain. For example: - For `SOL_USDC`: Provide a Solana address - For `ETH_USDT`: Provide an Ethereum address |
|
|
9
|
-
**label** | **String** | A label to help identify the address's purpose. | [optional]
|
|
9
|
+
**label** | **String** | A label to help identify the address's purpose. Can contain up to 128 characters. | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The merchant name. |
|
|
8
8
|
**wallet_id** | **String** | This field has been deprecated. | [optional]
|
|
9
|
-
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant.
|
|
9
|
+
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). | [optional]
|
|
10
10
|
**wallet_setup** | [**WalletSetup**](WalletSetup.md) | | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
@@ -4,16 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**merchant_id** | **String** | The merchant ID. |
|
|
7
|
+
**merchant_id** | **String** | The merchant ID. This ID is assigned by Cobo when you create the merchant. |
|
|
8
8
|
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported values: - 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` |
|
|
9
|
-
**currency** | **String** | The fiat currency for the base order amount and the developer fee.
|
|
10
|
-
**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`. If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`. Values must be greater than `0` and contain two decimal places. |
|
|
11
|
-
**fee_amount** | **String** | The developer fee for the order
|
|
9
|
+
**currency** | **String** | The fiat currency for the base order amount and the developer fee. If left empty, both `order_amount` and `fee_amount` will be denominated in the cryptocurrency specified by `token_id` Currently, only `USD` is supported. | [optional] [default to '']
|
|
10
|
+
**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). The denomination of the amount depends on if `currency` is specified: - If `currency` is specified, the amount is in the currency specified by `currency`, e.g. \"USD\". - If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`, e.g. \"ETH_USDT\". Values must be greater than `0` and contain two decimal places. |
|
|
11
|
+
**fee_amount** | **String** | The developer fee for the order. - **When to set:** If you are a merchant serving payers directly, set this field to `0`. Developer fees are only relevant for platforms like payment service providers (PSPs) that charge fees to their downstream merchants. For details, see [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). - **Denomination:** The denomination of `fee_amount` depends on the presence of `currency`: - If `currency` is set, the amount is denominated in that currency (e.g., \"USD\"). - If `currency` is not set, the amount is denominated in the cryptocurrency specified by `token_id` (e.g., \"ETH_USDT\"). - **Calculation:** The developer fee is added to the base order amount (`order_amount`) to determine the final amount charged to the customer. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\" - **Total charged:** \"102.00\" - **Formatting:** The value can contain up to two decimal places. |
|
|
12
12
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters. | [optional]
|
|
13
13
|
**psp_order_code** | **String** | A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters. |
|
|
14
14
|
**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]
|
|
15
15
|
**use_dedicated_address** | **Boolean** | This field has been deprecated. | [optional]
|
|
16
16
|
**custom_exchange_rate** | **String** | A custom exchange rate that defines how much fiat currency equals 1 unit of cryptocurrency. If not provided, the system's default exchange rate will be used. For example, if the fiat currency is USD and the cryptocurrency is USDT, setting `custom_exchange_rate` to `\"0.99\"` means that 1 USDT will be valued at 0.99 USD. | [optional]
|
|
17
|
-
**amount_tolerance** | **String** |
|
|
17
|
+
**amount_tolerance** | **String** | 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`. | [optional]
|
|
18
18
|
|
|
19
19
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.CreateRefundLinkRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**business_info** | [**RefundLinkBusinessInfo**](RefundLinkBusinessInfo.md) | |
|
|
8
|
+
**display_info** | [**LinkDisplayInfo**](LinkDisplayInfo.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
package/docs/FeeStationApi.md
CHANGED
|
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**checkFeeStationUsage**](FeeStationApi.md#checkFeeStationUsage) | **POST** /fee_station/check_fee_station_usage | Check Fee Station usage
|
|
8
|
-
[**estimateFeeStationFee**](FeeStationApi.md#estimateFeeStationFee) | **POST** /fee_station/transactions/estimate_fee | Estimate fee
|
|
8
|
+
[**estimateFeeStationFee**](FeeStationApi.md#estimateFeeStationFee) | **POST** /fee_station/transactions/estimate_fee | Estimate transaction fee
|
|
9
9
|
[**getFeeStationTransactionById**](FeeStationApi.md#getFeeStationTransactionById) | **GET** /fee_station/transactions/{transaction_id} | Get Fee Station transaction information
|
|
10
10
|
[**listFeeStationAddresses**](FeeStationApi.md#listFeeStationAddresses) | **GET** /fee_station/addresses | List Fee Station addresses
|
|
11
11
|
[**listFeeStationTransactions**](FeeStationApi.md#listFeeStationTransactions) | **GET** /fee_station/transactions | List all Fee Station transactions
|
|
@@ -19,7 +19,7 @@ Method | HTTP request | Description
|
|
|
19
19
|
|
|
20
20
|
Check Fee Station usage
|
|
21
21
|
|
|
22
|
-
This operation evaluates Fee Station usage for the current transaction. It determines whether Fee station can be used, checks if the Fee Station balance is sufficient, and returns a breakdown of the amounts involved, including any portion that must be covered by the user or sponsored in
|
|
22
|
+
This operation evaluates Fee Station usage for the current transaction. It determines whether Fee station can be used, checks if the Fee Station balance is sufficient, and returns a breakdown of the amounts involved, including any portion that must be covered by the user or sponsored in USD stablecoin.
|
|
23
23
|
|
|
24
24
|
### Example
|
|
25
25
|
|
|
@@ -69,9 +69,9 @@ Name | Type | Description | Notes
|
|
|
69
69
|
|
|
70
70
|
> EstimatedFixedFee estimateFeeStationFee(opts)
|
|
71
71
|
|
|
72
|
-
Estimate fee
|
|
72
|
+
Estimate transaction fee
|
|
73
73
|
|
|
74
|
-
This operation
|
|
74
|
+
<Note>This operation is **deprecated**. Please use the enhanced version [Check Fee Station usage](https://www.cobo.com/developers/v2/api-references/feestation/check-fee-station-usage) instead.</Note> This operation estimates the transaction fee of a token transfer based on the fee model that the chain uses, considering factors such as network congestion and transaction complexity. You need to specify the transaction information, including destination address, token ID. The response can contain different properties based on the transaction fee model used by the chain. For the legacy, EIP-1559, and UTXO fee models, Cobo also supports three different transaction speed levels: slow, recommended, and fast. For more information about estimating transaction fees, refer to [Estimate transaction fee](https://www.cobo.com/developers/v2/guides/transactions/estimate-fees).
|
|
75
75
|
|
|
76
76
|
### Example
|
|
77
77
|
|
|
@@ -5,10 +5,12 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. |
|
|
8
|
-
**amount** | **String** | The amount of tokens to be transferred in this request. |
|
|
9
|
-
**token_id** | **String** | The token ID of the transferred
|
|
8
|
+
**amount** | **String** | Applicable to transfer requests only. The amount of tokens to be transferred in this request. | [optional]
|
|
9
|
+
**token_id** | **String** | Applicable to transfer requests only. The token ID of the asset to be transferred. You can retrieve available token IDs by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
10
|
+
**fee_token_id** | **String** | The token ID used to pay the gas fee for the main transaction. You can retrieve available token IDs by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
10
11
|
**estimated_fee_amount** | **String** | The estimated transaction fee required for this transfer, before applying any Fee Station rules. |
|
|
11
12
|
**from_address** | **String** | The blockchain address that initiates the transfer. |
|
|
12
13
|
**from_wallet_id** | **String** | The wallet ID. |
|
|
14
|
+
**auto_fuel** | [**AutoFuelType**](AutoFuelType.md) | | [optional]
|
|
13
15
|
|
|
14
16
|
|
|
@@ -5,12 +5,13 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**token_id** | **String** | The token used to pay the gas fee for this specific transaction. You can retrieve the IDs of all supported tokens by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
8
|
+
**balance** | **String** | The current token balance available in Fee Station. |
|
|
8
9
|
**gas_station_type** | [**FeeStationGasStationType**](FeeStationGasStationType.md) | |
|
|
9
10
|
**is_fee_station_applicable** | **Boolean** | Indicates whether Fee Station is applied for this transfer request. |
|
|
10
11
|
**is_balance_sufficient** | **Boolean** | If Fee Station is used, indicates whether its balance is sufficient to cover the required gas fee. |
|
|
11
|
-
**balance** | **String** | The current token balance available in Fee Station. |
|
|
12
12
|
**total_fee_amount** | **String** | The total gas amount required for this transfer request. |
|
|
13
|
-
**is_sponsor_applicable** | **Boolean** | Indicates whether
|
|
14
|
-
**sponsored_fee_amount** | **String** | The amount of gas fee sponsored by
|
|
13
|
+
**is_sponsor_applicable** | **Boolean** | Indicates whether USD stablecoin sponsorship is applied when the Fee Station balance is insufficient. |
|
|
14
|
+
**sponsored_fee_amount** | **String** | The amount of gas fee sponsored by USD stablecoin when applicable. |
|
|
15
|
+
**sponsored_token_id** | **String** | The token ID used to sponsor the gas fee. | [optional]
|
|
15
16
|
|
|
16
17
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.FeeStationSponsorTransactionDescription
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_fee_amount** | **String** | The total amount used to sponsor the gas fee required for executing the main transaction on behalf of the user. |
|
|
8
|
+
**commission_fee** | **String** | The commission fee charged for sponsoring the gas fee. |
|
|
9
|
+
|
|
10
|
+
|
package/docs/Link.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**url** | **String** | The base URL of the payment page. This URL should be combined with the token parameter to form the complete payment link.
|
|
7
|
+
**url** | **String** | The base URL of the payment page. This URL should be combined with the `token` parameter to form the complete payment link. |
|
|
8
8
|
**token** | **String** | The unique payment token that should be appended to the URL as a query parameter. This token authenticates and identifies the specific payment session. The complete payment link should be constructed as: `[url]?token=[token]` |
|
|
9
9
|
|
|
10
10
|
|
package/docs/LinkDisplayInfo.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**developer_name** | **String** |
|
|
8
|
-
**logo** | **String** |
|
|
7
|
+
**developer_name** | **String** | The brand name to display to end users during the payment process. | [optional]
|
|
8
|
+
**logo** | **String** | The URL of your logo image to display to end users during the payment process. | [optional]
|
|
9
9
|
|
|
10
10
|
|
package/docs/MerchantBalance.md
CHANGED
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
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
|
**refunded_amount** | **String** | The total amount of the token that has been refunded from the merchant's balance. | [optional]
|
|
13
|
-
**total_balance** | **String** | The total balance of the token available for payout or refund for the merchant. `total_balance` = `total_received_amount` - `settled_amount` - `refunded_amount` For more information, please refer to [
|
|
13
|
+
**total_balance** | **String** | The total balance of the token available for payout or refund for the merchant. `total_balance` = `total_received_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) | [optional]
|
|
14
14
|
**available_balance** | **String** | This field has been deprecated. | [optional]
|
|
15
15
|
|
|
16
16
|
|
package/docs/Order.md
CHANGED
|
@@ -23,6 +23,6 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**updated_timestamp** | **Number** | The last update time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
24
24
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the pay-in process. | [optional]
|
|
25
25
|
**settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
26
|
-
**amount_tolerance** | **String** |
|
|
26
|
+
**amount_tolerance** | **String** | 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`. | [optional]
|
|
27
27
|
|
|
28
28
|
|
|
@@ -4,16 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_ids** | **[String]** |
|
|
8
|
-
**custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) |
|
|
9
|
-
**currency** | **String** | The currency
|
|
10
|
-
**fee_amount** | **String** | The developer fee for the order, in the currency specified by `currency`.
|
|
7
|
+
**token_ids** | **[String]** | An array of token IDs representing the cryptocurrencies and chains available for payment. These options will be shown to users on the payment page for them to choose from. Supported token IDs include: - 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` |
|
|
8
|
+
**custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) | A list of custom exchange rates defining how much one unit of a specific cryptocurrency (`token_id`) is valued in the selected fiat or crypto currency (`currency`). If this field is omitted, the system’s default exchange rates will apply. Each item specifies a `token_id` and its corresponding `exchange_rate`. For example, to treat 1 USDT (on Ethereum) as equivalent to 0.99 USD, provide: ```json { \"custom_exchange_rates\": [ { \"token_id\": \"ETH_USDT\", \"exchange_rate\": \"0.99\" } ], \"currency\": \"USD\" } ``` | [optional]
|
|
9
|
+
**currency** | **String** | The currency in which both the order amount (`order_amount`) and the developer fee (`fee_amount`) are denominated. Only the following values are supported: `USD`, `USDT`, or `USDC`. |
|
|
10
|
+
**fee_amount** | **String** | The developer fee for the order, denominated in the currency specified by `currency`. If you are a merchant directly serving payers, set this field to `0`. Developer fees are only relevant for platforms like payment service providers (PSPs) that charge fees to their downstream merchants. The developer fee is added to the base amount (`order_amount`) to determine the final charge. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\" - Total charged to customer: \"102.00\" Values can contain up to two decimal places. |
|
|
11
11
|
**merchant_id** | **String** | The merchant ID. |
|
|
12
|
-
**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`.
|
|
12
|
+
**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), denominated in the currency specified by `currency`. Values must be greater than `0` and contain two decimal places. |
|
|
13
13
|
**merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters. | [optional]
|
|
14
14
|
**psp_order_code** | **String** | A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters. |
|
|
15
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
|
-
**use_dedicated_address** | **Boolean** |
|
|
17
|
-
**amount_tolerance** | **String** |
|
|
16
|
+
**use_dedicated_address** | **Boolean** | This field has been deprecated. | [optional]
|
|
17
|
+
**amount_tolerance** | **String** | 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`. | [optional]
|
|
18
18
|
|
|
19
19
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_id** | **String** | The
|
|
8
|
-
**exchange_rate** | **String** | The
|
|
7
|
+
**token_id** | **String** | The token ID. |
|
|
8
|
+
**exchange_rate** | **String** | The exchange rate to use for this token. |
|
|
9
9
|
|
|
10
10
|
|