@cobo/cobo-waas2 1.26.0 → 1.27.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 +64 -4
- package/dist/ApiClient.js +1 -1
- package/dist/api/DevelopersWebhooksApi.js +2 -2
- package/dist/api/PaymentApi.js +1298 -200
- package/dist/api/TransactionsApi.js +2 -2
- package/dist/index.js +266 -7
- package/dist/model/BankAccountStatus.js +66 -0
- package/dist/model/ContractCallDestination.js +38 -10
- package/dist/model/ContractCallDestinationType.js +5 -0
- package/dist/model/Counterparty.js +195 -0
- package/dist/model/CounterpartyDetail.js +228 -0
- package/dist/model/CounterpartyType.js +61 -0
- package/dist/model/CounterpartyWalletAddressDetail.js +192 -0
- package/dist/model/CreateCounterpartyRequest.js +193 -0
- package/dist/model/CreateCounterpartyWalletAddressRequest.js +140 -0
- package/dist/model/CreateDestinationBankAccount.js +257 -0
- package/dist/model/CreateDestinationBankAccountRequest.js +272 -0
- package/dist/model/CreateDestinationRequest.js +235 -0
- package/dist/model/CreateDestinationWalletAddressRequest.js +140 -0
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreatePaymentOrderRequest.js +2 -2
- package/dist/model/CreateSettlement.js +13 -0
- package/dist/model/{ReceivedAmountPerAddress.js → CreateWalletAddress.js} +31 -32
- package/dist/model/DeleteCounterparty200Response.js +110 -0
- package/dist/model/DeleteCounterpartyWalletAddress200Response.js +110 -0
- package/dist/model/DeleteDestination200Response.js +110 -0
- package/dist/model/DeleteDestinationBankAccount200Response.js +110 -0
- package/dist/model/DeleteDestinationWalletAddress200Response.js +110 -0
- package/dist/model/Destination.js +208 -0
- package/dist/model/DestinationBankAccount.js +301 -0
- package/dist/model/DestinationBankAccountDetail.js +394 -0
- package/dist/model/DestinationDetail.js +272 -0
- package/dist/model/DestinationType.js +61 -0
- package/dist/model/DestinationWalletAddressDetail.js +205 -0
- package/dist/model/EnableDestinationWhitelistRequest.js +106 -0
- package/dist/model/EvmContractCallDestination.js +2 -2
- package/dist/model/ExchangeRate.js +140 -0
- package/dist/model/IntermediaryBankInfo.js +140 -0
- package/dist/model/Link.js +4 -4
- package/dist/model/LinkDisplayInfo.js +2 -2
- package/dist/model/ListCounterparties200Response.js +123 -0
- package/dist/model/ListCounterpartyWalletAddress200Response.js +123 -0
- package/dist/model/ListDestinationBankAccounts200Response.js +123 -0
- package/dist/model/ListDestinationWalletAddresses200Response.js +123 -0
- package/dist/model/ListDestinations200Response.js +123 -0
- package/dist/model/PaymentTransaction.js +32 -0
- package/dist/model/PaymentTransactionEventData.js +2 -2
- package/dist/model/QueryDestinationWhitelistEnabled200Response.js +106 -0
- package/dist/model/RefundLinkBusinessInfo.js +6 -6
- package/dist/model/SettlementDetail.js +13 -0
- package/dist/model/SwapActivityTimeline.js +1 -1
- package/dist/model/Transaction.js +1 -1
- package/dist/model/TransactionDestination.js +38 -10
- package/dist/model/TransactionDestinationType.js +5 -0
- package/dist/model/TransactionDetail.js +2 -2
- package/dist/model/TransactionDetails.js +2 -2
- package/dist/model/TransactionTronContractDestination.js +150 -0
- package/dist/model/TransactionWebhookEventData.js +2 -2
- package/dist/model/TronContractCallDestination.js +150 -0
- package/dist/model/UpdateCounterpartyByIdRequest.js +160 -0
- package/dist/model/UpdateDestinationBankAccount.js +257 -0
- package/dist/model/UpdateDestinationByIdRequest.js +173 -0
- package/dist/model/WalletAddress.js +151 -0
- package/dist/model/WebhookEventData.js +1 -1
- package/docs/BankAccountStatus.md +14 -0
- package/docs/ContractCallDestination.md +2 -2
- package/docs/ContractCallDestinationType.md +2 -0
- package/docs/Counterparty.md +16 -0
- package/docs/CounterpartyDetail.md +17 -0
- package/docs/CounterpartyType.md +12 -0
- package/docs/CounterpartyWalletAddressDetail.md +15 -0
- package/docs/CreateCounterpartyRequest.md +14 -0
- package/docs/CreateCounterpartyWalletAddressRequest.md +11 -0
- package/docs/CreateDestinationBankAccount.md +19 -0
- package/docs/CreateDestinationBankAccountRequest.md +20 -0
- package/docs/CreateDestinationRequest.md +16 -0
- package/docs/CreateDestinationWalletAddressRequest.md +11 -0
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +1 -1
- package/docs/CreateSettlement.md +1 -0
- package/docs/CreateWalletAddress.md +10 -0
- package/docs/DeleteCounterparty200Response.md +9 -0
- package/docs/DeleteCounterpartyWalletAddress200Response.md +9 -0
- package/docs/DeleteDestination200Response.md +9 -0
- package/docs/DeleteDestinationBankAccount200Response.md +9 -0
- package/docs/DeleteDestinationWalletAddress200Response.md +9 -0
- package/docs/Destination.md +17 -0
- package/docs/DestinationBankAccount.md +23 -0
- package/docs/DestinationBankAccountDetail.md +30 -0
- package/docs/DestinationDetail.md +19 -0
- package/docs/DestinationType.md +12 -0
- package/docs/DestinationWalletAddressDetail.md +16 -0
- package/docs/DevelopersWebhooksApi.md +1 -1
- package/docs/EnableDestinationWhitelistRequest.md +9 -0
- package/docs/EvmContractCallDestination.md +1 -1
- package/docs/ExchangeRate.md +11 -0
- package/docs/IntermediaryBankInfo.md +11 -0
- package/docs/Link.md +2 -2
- package/docs/LinkDisplayInfo.md +2 -2
- package/docs/ListCounterparties200Response.md +10 -0
- package/docs/ListCounterpartyWalletAddress200Response.md +10 -0
- package/docs/ListDestinationBankAccounts200Response.md +10 -0
- package/docs/ListDestinationWalletAddresses200Response.md +10 -0
- package/docs/ListDestinations200Response.md +10 -0
- package/docs/PaymentApi.md +1459 -208
- package/docs/PaymentTransaction.md +2 -0
- package/docs/PaymentTransactionEventData.md +1 -1
- package/docs/QueryDestinationWhitelistEnabled200Response.md +9 -0
- package/docs/RefundLinkBusinessInfo.md +4 -4
- package/docs/SettlementDetail.md +1 -0
- package/docs/SwapActivityTimeline.md +1 -1
- package/docs/Transaction.md +1 -1
- package/docs/TransactionDestination.md +2 -2
- package/docs/TransactionDestinationType.md +2 -0
- package/docs/TransactionDetail.md +1 -1
- package/docs/TransactionDetails.md +1 -1
- package/docs/TransactionTronContractDestination.md +12 -0
- package/docs/TransactionWebhookEventData.md +1 -1
- package/docs/TransactionsApi.md +1 -1
- package/docs/TronContractCallDestination.md +12 -0
- package/docs/UpdateCounterpartyByIdRequest.md +13 -0
- package/docs/UpdateDestinationBankAccount.md +19 -0
- package/docs/UpdateDestinationByIdRequest.md +14 -0
- package/docs/WalletAddress.md +12 -0
- package/docs/WebhookEventData.md +1 -1
- package/package.json +1 -1
- package/docs/ReceivedAmountPerAddress.md +0 -10
|
@@ -0,0 +1,151 @@
|
|
|
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 WalletAddress model module.
|
|
29
|
+
* @module model/WalletAddress
|
|
30
|
+
*/
|
|
31
|
+
var WalletAddress = /*#__PURE__*/function () {
|
|
32
|
+
/**
|
|
33
|
+
* Constructs a new <code>WalletAddress</code>.
|
|
34
|
+
* @alias module:model/WalletAddress
|
|
35
|
+
* @param wallet_address_id {String} The wallet address ID.
|
|
36
|
+
* @param address {String} The wallet address.
|
|
37
|
+
* @param chain_id {String} The chain ID of the cryptocurrency.
|
|
38
|
+
* @param updated_timestamp {Number} The updated time of the wallet address, represented as a UNIX timestamp in seconds.
|
|
39
|
+
*/
|
|
40
|
+
function WalletAddress(wallet_address_id, address, chain_id, updated_timestamp) {
|
|
41
|
+
_classCallCheck(this, WalletAddress);
|
|
42
|
+
WalletAddress.initialize(this, wallet_address_id, address, chain_id, updated_timestamp);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Initializes the fields of this object.
|
|
47
|
+
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
48
|
+
* Only for internal use.
|
|
49
|
+
*/
|
|
50
|
+
return _createClass(WalletAddress, null, [{
|
|
51
|
+
key: "initialize",
|
|
52
|
+
value: function initialize(obj, wallet_address_id, address, chain_id, updated_timestamp) {
|
|
53
|
+
obj['wallet_address_id'] = wallet_address_id;
|
|
54
|
+
obj['address'] = address;
|
|
55
|
+
obj['chain_id'] = chain_id;
|
|
56
|
+
obj['updated_timestamp'] = updated_timestamp;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Constructs a <code>WalletAddress</code> from a plain JavaScript object, optionally creating a new instance.
|
|
61
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
62
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
63
|
+
* @param {module:model/WalletAddress} obj Optional instance to populate.
|
|
64
|
+
* @return {module:model/WalletAddress} The populated <code>WalletAddress</code> instance.
|
|
65
|
+
*/
|
|
66
|
+
}, {
|
|
67
|
+
key: "constructFromObject",
|
|
68
|
+
value: function constructFromObject(data, obj) {
|
|
69
|
+
if (data) {
|
|
70
|
+
obj = obj || new WalletAddress();
|
|
71
|
+
if (data.hasOwnProperty('wallet_address_id')) {
|
|
72
|
+
obj['wallet_address_id'] = _ApiClient["default"].convertToType(data['wallet_address_id'], 'String');
|
|
73
|
+
}
|
|
74
|
+
if (data.hasOwnProperty('address')) {
|
|
75
|
+
obj['address'] = _ApiClient["default"].convertToType(data['address'], 'String');
|
|
76
|
+
}
|
|
77
|
+
if (data.hasOwnProperty('chain_id')) {
|
|
78
|
+
obj['chain_id'] = _ApiClient["default"].convertToType(data['chain_id'], 'String');
|
|
79
|
+
}
|
|
80
|
+
if (data.hasOwnProperty('updated_timestamp')) {
|
|
81
|
+
obj['updated_timestamp'] = _ApiClient["default"].convertToType(data['updated_timestamp'], 'Number');
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return obj;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Validates the JSON data with respect to <code>WalletAddress</code>.
|
|
89
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
90
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>WalletAddress</code>.
|
|
91
|
+
*/
|
|
92
|
+
}, {
|
|
93
|
+
key: "validateJSON",
|
|
94
|
+
value: function validateJSON(data) {
|
|
95
|
+
// check to make sure all required properties are present in the JSON string
|
|
96
|
+
var _iterator = _createForOfIteratorHelper(WalletAddress.RequiredProperties),
|
|
97
|
+
_step;
|
|
98
|
+
try {
|
|
99
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
100
|
+
var property = _step.value;
|
|
101
|
+
if (!data.hasOwnProperty(property)) {
|
|
102
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
// ensure the json data is a string
|
|
106
|
+
} catch (err) {
|
|
107
|
+
_iterator.e(err);
|
|
108
|
+
} finally {
|
|
109
|
+
_iterator.f();
|
|
110
|
+
}
|
|
111
|
+
if (data['wallet_address_id'] && !(typeof data['wallet_address_id'] === 'string' || data['wallet_address_id'] instanceof String)) {
|
|
112
|
+
throw new Error("Expected the field `wallet_address_id` to be a primitive type in the JSON string but got " + data['wallet_address_id']);
|
|
113
|
+
}
|
|
114
|
+
// ensure the json data is a string
|
|
115
|
+
if (data['address'] && !(typeof data['address'] === 'string' || data['address'] instanceof String)) {
|
|
116
|
+
throw new Error("Expected the field `address` to be a primitive type in the JSON string but got " + data['address']);
|
|
117
|
+
}
|
|
118
|
+
// ensure the json data is a string
|
|
119
|
+
if (data['chain_id'] && !(typeof data['chain_id'] === 'string' || data['chain_id'] instanceof String)) {
|
|
120
|
+
throw new Error("Expected the field `chain_id` to be a primitive type in the JSON string but got " + data['chain_id']);
|
|
121
|
+
}
|
|
122
|
+
return true;
|
|
123
|
+
}
|
|
124
|
+
}]);
|
|
125
|
+
}();
|
|
126
|
+
WalletAddress.RequiredProperties = ["wallet_address_id", "address", "chain_id", "updated_timestamp"];
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* The wallet address ID.
|
|
130
|
+
* @member {String} wallet_address_id
|
|
131
|
+
*/
|
|
132
|
+
WalletAddress.prototype['wallet_address_id'] = undefined;
|
|
133
|
+
|
|
134
|
+
/**
|
|
135
|
+
* The wallet address.
|
|
136
|
+
* @member {String} address
|
|
137
|
+
*/
|
|
138
|
+
WalletAddress.prototype['address'] = undefined;
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* The chain ID of the cryptocurrency.
|
|
142
|
+
* @member {String} chain_id
|
|
143
|
+
*/
|
|
144
|
+
WalletAddress.prototype['chain_id'] = undefined;
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* The updated time of the wallet address, represented as a UNIX timestamp in seconds.
|
|
148
|
+
* @member {Number} updated_timestamp
|
|
149
|
+
*/
|
|
150
|
+
WalletAddress.prototype['updated_timestamp'] = undefined;
|
|
151
|
+
var _default = exports["default"] = WalletAddress;
|
|
@@ -779,7 +779,7 @@ WebhookEventData.prototype['description'] = undefined;
|
|
|
779
779
|
WebhookEventData.prototype['is_loop'] = undefined;
|
|
780
780
|
|
|
781
781
|
/**
|
|
782
|
-
* The transaction category defined by Cobo.
|
|
782
|
+
* The transaction category defined by Cobo. For more details, refer to [Cobo-defined categories](/v2/guides/transactions/manage-transactions#cobo-defined-categories).
|
|
783
783
|
* @member {Array.<String>} cobo_category
|
|
784
784
|
*/
|
|
785
785
|
WebhookEventData.prototype['cobo_category'] = undefined;
|
|
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
8
|
**address** | **String** | The destination address. |
|
|
9
|
-
**value** | **String** | The transfer amount. For example, if you trade 1.5
|
|
10
|
-
**calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address
|
|
9
|
+
**value** | **String** | The transfer amount. For example, if you trade 1.5 TRX, then the value is `1.5`. | [optional]
|
|
10
|
+
**calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
|
|
11
11
|
**instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
|
|
12
12
|
**address_lookup_table_accounts** | [**[SolContractCallAddressLookupTableAccount]**](SolContractCallAddressLookupTableAccount.md) | | [optional]
|
|
13
13
|
**contract_param** | [**StellarContractCallContractParam**](StellarContractCallContractParam.md) | |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.Counterparty
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. | [optional]
|
|
8
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**counterparty_name** | **String** | The counterparty name. |
|
|
10
|
+
**country** | **String** | The country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the counterparty. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the counterparty. | [optional]
|
|
13
|
+
**created_timestamp** | **Number** | The created time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
14
|
+
**updated_timestamp** | **Number** | The updated time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# CoboWaas2.CounterpartyDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. | [optional]
|
|
8
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**counterparty_name** | **String** | The counterparty name. |
|
|
10
|
+
**country** | **String** | The country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the counterparty. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the counterparty. | [optional]
|
|
13
|
+
**wallet_addresses** | [**[WalletAddress]**](WalletAddress.md) | The wallet addresses of the counterparty. |
|
|
14
|
+
**created_timestamp** | **Number** | The created time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
**updated_timestamp** | **Number** | The updated time of the counterparty, represented as a UNIX timestamp in seconds. |
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CoboWaas2.CounterpartyWalletAddressDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. |
|
|
8
|
+
**counterparty_name** | **String** | The name of the counterparty. |
|
|
9
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
10
|
+
**wallet_address_id** | **String** | The wallet address ID. |
|
|
11
|
+
**address** | **String** | The wallet address. |
|
|
12
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
13
|
+
**updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. |
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.CreateCounterpartyRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_name** | **String** | The counterparty name. |
|
|
8
|
+
**counterparty_type** | [**CounterpartyType**](CounterpartyType.md) | |
|
|
9
|
+
**wallet_addresses** | [**[CreateWalletAddress]**](CreateWalletAddress.md) | The wallet addresses of the counterparty. |
|
|
10
|
+
**country** | **String** | The country of the counterparty, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the counterparty. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the counterparty. | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.CreateCounterpartyWalletAddressRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**counterparty_id** | **String** | The counterparty ID. |
|
|
8
|
+
**address** | **String** | The wallet address. |
|
|
9
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationBankAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**account_alias** | **String** | The alias of the bank account. |
|
|
8
|
+
**account_number** | **String** | The bank account number. |
|
|
9
|
+
**swift_code** | **String** | The SWIFT or BIC code of the bank. |
|
|
10
|
+
**currency** | **String** | The currency of the bank account. |
|
|
11
|
+
**beneficiary_name** | **String** | The name of the account holder. |
|
|
12
|
+
**beneficiary_address** | **String** | The address of the account holder. |
|
|
13
|
+
**bank_name** | **String** | The name of the bank. |
|
|
14
|
+
**bank_address** | **String** | The address of the bank. |
|
|
15
|
+
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
16
|
+
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
17
|
+
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationBankAccountRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**account_alias** | **String** | The alias of the bank account. |
|
|
9
|
+
**account_number** | **String** | The bank account number. |
|
|
10
|
+
**swift_code** | **String** | The SWIFT or BIC code of the bank. |
|
|
11
|
+
**currency** | **String** | The currency of the bank account. |
|
|
12
|
+
**beneficiary_name** | **String** | The name of the account holder. |
|
|
13
|
+
**beneficiary_address** | **String** | The address of the account holder. |
|
|
14
|
+
**bank_name** | **String** | The name of the bank. |
|
|
15
|
+
**bank_address** | **String** | The address of the bank. |
|
|
16
|
+
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
17
|
+
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
18
|
+
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_name** | **String** | The destination name. |
|
|
8
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**wallet_addresses** | [**[CreateWalletAddress]**](CreateWalletAddress.md) | The wallet addresses of the destination. | [optional]
|
|
10
|
+
**bank_accounts** | [**[CreateDestinationBankAccount]**](CreateDestinationBankAccount.md) | The bank accounts of the destination. | [optional]
|
|
11
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
12
|
+
**country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
13
|
+
**email** | **String** | The email of the destination. | [optional]
|
|
14
|
+
**contact_address** | **String** | The contact address of the destination. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.CreateDestinationWalletAddressRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**address** | **String** | The wallet address. |
|
|
9
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Key share holder's name. | [optional]
|
|
8
8
|
**type** | [**KeyShareHolderType**](KeyShareHolderType.md) | | [optional]
|
|
9
|
-
**tss_node_id** | **String** | Key share holder's TSS Node ID.
|
|
9
|
+
**tss_node_id** | **String** | Key share holder's TSS Node ID. For detailed information about signer types and their setup, see the [**Signer Type** table](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/holder-group-main-group). Mobile signers can view their TSS Node ID in the [Cobo Guard app](https://manuals.cobo.com/en/guard/manage). | [optional]
|
|
10
10
|
**signer** | **Boolean** | Whether the key share holder has been selected as the designated transaction signer. For example, in a 2-3 [Threshold Signature Scheme (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss), Cobo will serve as one signer, and you can choose one of the other two key share holders to act as the second transaction signer. - `true`: The key share holder is a designated transaction signer. - `false`: The key share holder is not a designated transaction signer. | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
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
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.
|
|
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
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. |
|
package/docs/CreateSettlement.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**token_id** | **String** | The ID of the cryptocurrency you want to settle. Specify this field when `payout_channel` is set to `Crypto`. 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
9
|
**amount** | **String** | The amount of cryptocurrency to be settled. When settling merchant balance from orders (`acquiring_type` is `Order` and `settlement_type` is `Merchant`), do not specify this field as the amount will be automatically calculated based on the order amounts. | [optional]
|
|
10
10
|
**crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. Specify this field when `payout_channel` is set to `Crypto`. Call [List crypto addresses](https://www.cobo.com/developers/v2/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses. | [optional]
|
|
11
|
+
**crypto_address** | **String** | Only used in Crypto payout channel. The actual blockchain address to which funds will be transferred. If enable destination whitelist, this address must be associated with a destination. | [optional]
|
|
11
12
|
**order_ids** | **[String]** | | [optional]
|
|
12
13
|
|
|
13
14
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.CreateWalletAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**address** | **String** | The wallet address. |
|
|
8
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.DeleteCounterpartyWalletAddress200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**wallet_address_id** | **String** | The wallet address ID under the counterparty. |
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# CoboWaas2.Destination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. | [optional]
|
|
8
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**destination_name** | **String** | The destination name. |
|
|
10
|
+
**country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the destination. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the destination. | [optional]
|
|
13
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
14
|
+
**created_timestamp** | **Number** | The created time of the destination, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
**updated_timestamp** | **Number** | The updated time of the destination, represented as a UNIX timestamp in seconds. |
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CoboWaas2.DestinationBankAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**bank_account_id** | **String** | The destination bank account ID. |
|
|
8
|
+
**account_alias** | **String** | The alias of the bank account. |
|
|
9
|
+
**account_number** | **String** | The bank account number. |
|
|
10
|
+
**swift_code** | **String** | The SWIFT or BIC code of the bank. |
|
|
11
|
+
**currency** | **String** | The currency of the bank account. |
|
|
12
|
+
**beneficiary_name** | **String** | The name of the account holder. |
|
|
13
|
+
**beneficiary_address** | **String** | The address of the account holder. |
|
|
14
|
+
**bank_name** | **String** | The name of the bank. |
|
|
15
|
+
**bank_address** | **String** | The address of the bank. |
|
|
16
|
+
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
17
|
+
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
18
|
+
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
19
|
+
**bank_account_status** | [**BankAccountStatus**](BankAccountStatus.md) | |
|
|
20
|
+
**created_timestamp** | **Number** | The created time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
21
|
+
**updated_timestamp** | **Number** | The updated time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# CoboWaas2.DestinationBankAccountDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**destination_name** | **String** | The name of the destination. |
|
|
9
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
10
|
+
**destination_email** | **String** | The email of the destination. | [optional]
|
|
11
|
+
**destination_country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
12
|
+
**destination_contact_address** | **String** | The contact address of the destination. | [optional]
|
|
13
|
+
**destination_merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
14
|
+
**bank_account_id** | **String** | The destination bank account ID. |
|
|
15
|
+
**account_alias** | **String** | The alias of the bank account. |
|
|
16
|
+
**account_number** | **String** | The bank account number. |
|
|
17
|
+
**swift_code** | **String** | The SWIFT or BIC code of the bank. |
|
|
18
|
+
**currency** | **String** | The currency of the bank account. |
|
|
19
|
+
**beneficiary_name** | **String** | The name of the account holder. |
|
|
20
|
+
**beneficiary_address** | **String** | The address of the account holder. |
|
|
21
|
+
**bank_name** | **String** | The name of the bank. |
|
|
22
|
+
**bank_address** | **String** | The address of the bank. |
|
|
23
|
+
**iban_code** | **String** | The IBAN code of the bank account. | [optional]
|
|
24
|
+
**further_credit** | **String** | The further credit of the bank account. | [optional]
|
|
25
|
+
**intermediary_bank_info** | [**IntermediaryBankInfo**](IntermediaryBankInfo.md) | | [optional]
|
|
26
|
+
**bank_account_status** | [**BankAccountStatus**](BankAccountStatus.md) | |
|
|
27
|
+
**created_timestamp** | **Number** | The created time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
28
|
+
**updated_timestamp** | **Number** | The updated time of the bank account, represented as a UNIX timestamp in seconds. | [optional]
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CoboWaas2.DestinationDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
9
|
+
**destination_name** | **String** | The destination name. |
|
|
10
|
+
**country** | **String** | The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
11
|
+
**email** | **String** | The email of the destination. | [optional]
|
|
12
|
+
**contact_address** | **String** | The contact address of the destination. | [optional]
|
|
13
|
+
**wallet_addresses** | [**[WalletAddress]**](WalletAddress.md) | The wallet addresses of the destination. | [optional]
|
|
14
|
+
**bank_accounts** | [**[DestinationBankAccount]**](DestinationBankAccount.md) | The bank accounts of the destination. | [optional]
|
|
15
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
16
|
+
**created_timestamp** | **Number** | The created time of the destination, represented as a UNIX timestamp in seconds. |
|
|
17
|
+
**updated_timestamp** | **Number** | The updated time of the destination, represented as a UNIX timestamp in seconds. |
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.DestinationWalletAddressDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_id** | **String** | The destination ID. |
|
|
8
|
+
**destination_name** | **String** | The name of the destination. |
|
|
9
|
+
**destination_type** | [**DestinationType**](DestinationType.md) | |
|
|
10
|
+
**merchant_id** | **String** | The ID of the merchant linked to the destination. | [optional]
|
|
11
|
+
**wallet_address_id** | **String** | The wallet address ID. |
|
|
12
|
+
**address** | **String** | The wallet address. |
|
|
13
|
+
**chain_id** | **String** | The chain ID of the cryptocurrency. |
|
|
14
|
+
**updated_timestamp** | **Number** | The updated time of the wallet address, represented as a UNIX timestamp in seconds. |
|
|
15
|
+
|
|
16
|
+
|
|
@@ -457,7 +457,7 @@ Name | Type | Description | Notes
|
|
|
457
457
|
|
|
458
458
|
Trigger test event
|
|
459
459
|
|
|
460
|
-
This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload. <Note>Currently, you can only trigger test webhook events with the event data types `Transaction` and `TSSRequest`
|
|
460
|
+
This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload. <Note>Currently, you can only trigger test webhook events with the event data types [`Transaction`](https://www.cobo.com/developers/v2/guides/webhooks-callbacks/webhook-event-type#transaction-events-deposits%2Fwithdrawals%2Fcontract-calls%2Fmessage-signing) and [`TSSRequest`](https://www.cobo.com/developers/v2/guides/webhooks-callbacks/webhook-event-type#mpc-tss-request-events).</Note>
|
|
461
461
|
|
|
462
462
|
### Example
|
|
463
463
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.EnableDestinationWhitelistRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**enable_destination_whitelist** | **Boolean** | Indicates whether to enable the destination whitelist. |
|
|
8
|
+
|
|
9
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
|
-
**address** | **String** | The destination address. |
|
|
8
|
+
**address** | **String** | The destination address. If you are deploying a new contract on an EVM chain, set this address to `0x0000000000000000000000000000000000000000`. |
|
|
9
9
|
**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
|
|
10
10
|
**calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters. |
|
|
11
11
|
|