@cobo/cobo-waas2 1.26.0 → 1.28.0

package/dist/model/CreateExchangeWalletParams.js

@@ -197,7 +197,7 @@ CreateExchangeWalletParams.prototype['wallet_type'] = undefined;
 CreateExchangeWalletParams.prototype['wallet_subtype'] = undefined;
 
 /**
- * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets.
+ * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets).
  * @member {Boolean} enable_auto_sweep
  */
 CreateExchangeWalletParams.prototype['enable_auto_sweep'] = undefined;
@@ -264,7 +264,7 @@ _CreateCustodialWalletParams["default"].prototype['wallet_type'] = undefined;
  */
 _CreateCustodialWalletParams["default"].prototype['wallet_subtype'] = undefined;
 /**
- * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets.
+ * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets).
  * @member {Boolean} enable_auto_sweep
  */
 _CreateCustodialWalletParams["default"].prototype['enable_auto_sweep'] = undefined;

package/dist/model/CreateKeyShareHolder.js

@@ -106,7 +106,7 @@ CreateKeyShareHolder.prototype['name'] = undefined;
 CreateKeyShareHolder.prototype['type'] = undefined;
 
 /**
- * Key share holder's TSS Node ID. You can obtain the TSS Node ID using either mobile co-signer or server co-signer. See the \"Primary Purposes\" row on the table in [Create a Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#create-a-main-group).
+ * 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).
  * @member {String} tss_node_id
  */
 CreateKeyShareHolder.prototype['tss_node_id'] = undefined;

package/dist/model/CreateMerchantRequest.js

@@ -133,7 +133,7 @@ CreateMerchantRequest.prototype['name'] = undefined;
 CreateMerchantRequest.prototype['wallet_id'] = undefined;
 
 /**
- * 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).
+ * 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/payments/en/guides/amounts-and-balances).
  * @member {String} developer_fee_rate
  */
 CreateMerchantRequest.prototype['developer_fee_rate'] = undefined;

package/dist/model/CreateMpcWalletParams.js

@@ -147,7 +147,7 @@ CreateMpcWalletParams.prototype['wallet_type'] = undefined;
 CreateMpcWalletParams.prototype['wallet_subtype'] = undefined;
 
 /**
- * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets.
+ * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets).
  * @member {Boolean} enable_auto_sweep
  */
 CreateMpcWalletParams.prototype['enable_auto_sweep'] = undefined;
@@ -173,7 +173,7 @@ _CreateCustodialWalletParams["default"].prototype['wallet_type'] = undefined;
  */
 _CreateCustodialWalletParams["default"].prototype['wallet_subtype'] = undefined;
 /**
- * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets.
+ * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets).
  * @member {Boolean} enable_auto_sweep
  */
 _CreateCustodialWalletParams["default"].prototype['enable_auto_sweep'] = undefined;

package/dist/model/CreatePaymentOrderRequest.js

@@ -32,15 +32,13 @@ var CreatePaymentOrderRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreatePaymentOrderRequest</code>.
    * @alias module:model/CreatePaymentOrderRequest
-   * @param merchant_id {String} The merchant ID. This ID is assigned by Cobo when you create the merchant.
-   * @param 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` 
-   * @param 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.  
-   * @param 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. 
-   * @param 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. 
+   * @param merchant_id {String} The merchant ID.
+   * @param psp_order_code {String} A unique reference code assigned by the developer to identify this order in their system.
+   * @param fee_amount {String} The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. For example, if order_amount is \"100.00\" and fee_amount is \"2.00\", the customer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant and \"2.00\" settled to the developer. Values must be greater than 0 and contain two decimal places.
    */
-  function CreatePaymentOrderRequest(merchant_id, token_id, order_amount, fee_amount, psp_order_code) {
+  function CreatePaymentOrderRequest(merchant_id, psp_order_code, fee_amount) {
     _classCallCheck(this, CreatePaymentOrderRequest);
-    CreatePaymentOrderRequest.initialize(this, merchant_id, token_id, order_amount, fee_amount, psp_order_code);
+    CreatePaymentOrderRequest.initialize(this, merchant_id, psp_order_code, fee_amount);
   }
 
   /**
@@ -50,12 +48,10 @@ var CreatePaymentOrderRequest = /*#__PURE__*/function () {
    */
   return _createClass(CreatePaymentOrderRequest, null, [{
     key: "initialize",
-    value: function initialize(obj, merchant_id, token_id, order_amount, fee_amount, psp_order_code) {
+    value: function initialize(obj, merchant_id, psp_order_code, fee_amount) {
       obj['merchant_id'] = merchant_id;
-      obj['token_id'] = token_id;
-      obj['order_amount'] = order_amount;
-      obj['fee_amount'] = fee_amount;
       obj['psp_order_code'] = psp_order_code;
+      obj['fee_amount'] = fee_amount;
     }
 
     /**
@@ -73,36 +69,48 @@ var CreatePaymentOrderRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('merchant_id')) {
           obj['merchant_id'] = _ApiClient["default"].convertToType(data['merchant_id'], 'String');
         }
-        if (data.hasOwnProperty('token_id')) {
-          obj['token_id'] = _ApiClient["default"].convertToType(data['token_id'], 'String');
+        if (data.hasOwnProperty('merchant_order_code')) {
+          obj['merchant_order_code'] = _ApiClient["default"].convertToType(data['merchant_order_code'], 'String');
         }
-        if (data.hasOwnProperty('currency')) {
-          obj['currency'] = _ApiClient["default"].convertToType(data['currency'], 'String');
+        if (data.hasOwnProperty('psp_order_code')) {
+          obj['psp_order_code'] = _ApiClient["default"].convertToType(data['psp_order_code'], 'String');
         }
-        if (data.hasOwnProperty('order_amount')) {
-          obj['order_amount'] = _ApiClient["default"].convertToType(data['order_amount'], 'String');
+        if (data.hasOwnProperty('pricing_currency')) {
+          obj['pricing_currency'] = _ApiClient["default"].convertToType(data['pricing_currency'], 'String');
+        }
+        if (data.hasOwnProperty('pricing_amount')) {
+          obj['pricing_amount'] = _ApiClient["default"].convertToType(data['pricing_amount'], 'String');
         }
         if (data.hasOwnProperty('fee_amount')) {
           obj['fee_amount'] = _ApiClient["default"].convertToType(data['fee_amount'], 'String');
         }
-        if (data.hasOwnProperty('merchant_order_code')) {
-          obj['merchant_order_code'] = _ApiClient["default"].convertToType(data['merchant_order_code'], 'String');
+        if (data.hasOwnProperty('payable_currency')) {
+          obj['payable_currency'] = _ApiClient["default"].convertToType(data['payable_currency'], 'String');
         }
-        if (data.hasOwnProperty('psp_order_code')) {
-          obj['psp_order_code'] = _ApiClient["default"].convertToType(data['psp_order_code'], 'String');
+        if (data.hasOwnProperty('payable_amount')) {
+          obj['payable_amount'] = _ApiClient["default"].convertToType(data['payable_amount'], 'String');
         }
         if (data.hasOwnProperty('expired_in')) {
           obj['expired_in'] = _ApiClient["default"].convertToType(data['expired_in'], 'Number');
         }
+        if (data.hasOwnProperty('amount_tolerance')) {
+          obj['amount_tolerance'] = _ApiClient["default"].convertToType(data['amount_tolerance'], 'String');
+        }
+        if (data.hasOwnProperty('currency')) {
+          obj['currency'] = _ApiClient["default"].convertToType(data['currency'], 'String');
+        }
+        if (data.hasOwnProperty('order_amount')) {
+          obj['order_amount'] = _ApiClient["default"].convertToType(data['order_amount'], 'String');
+        }
+        if (data.hasOwnProperty('token_id')) {
+          obj['token_id'] = _ApiClient["default"].convertToType(data['token_id'], 'String');
+        }
         if (data.hasOwnProperty('use_dedicated_address')) {
           obj['use_dedicated_address'] = _ApiClient["default"].convertToType(data['use_dedicated_address'], 'Boolean');
         }
         if (data.hasOwnProperty('custom_exchange_rate')) {
           obj['custom_exchange_rate'] = _ApiClient["default"].convertToType(data['custom_exchange_rate'], 'String');
         }
-        if (data.hasOwnProperty('amount_tolerance')) {
-          obj['amount_tolerance'] = _ApiClient["default"].convertToType(data['amount_tolerance'], 'String');
-        }
       }
       return obj;
     }
@@ -135,108 +143,147 @@ var CreatePaymentOrderRequest = /*#__PURE__*/function () {
         throw new Error("Expected the field `merchant_id` to be a primitive type in the JSON string but got " + data['merchant_id']);
       }
       // ensure the json data is a string
-      if (data['token_id'] && !(typeof data['token_id'] === 'string' || data['token_id'] instanceof String)) {
-        throw new Error("Expected the field `token_id` to be a primitive type in the JSON string but got " + data['token_id']);
+      if (data['merchant_order_code'] && !(typeof data['merchant_order_code'] === 'string' || data['merchant_order_code'] instanceof String)) {
+        throw new Error("Expected the field `merchant_order_code` to be a primitive type in the JSON string but got " + data['merchant_order_code']);
       }
       // ensure the json data is a string
-      if (data['currency'] && !(typeof data['currency'] === 'string' || data['currency'] instanceof String)) {
-        throw new Error("Expected the field `currency` to be a primitive type in the JSON string but got " + data['currency']);
+      if (data['psp_order_code'] && !(typeof data['psp_order_code'] === 'string' || data['psp_order_code'] instanceof String)) {
+        throw new Error("Expected the field `psp_order_code` to be a primitive type in the JSON string but got " + data['psp_order_code']);
       }
       // ensure the json data is a string
-      if (data['order_amount'] && !(typeof data['order_amount'] === 'string' || data['order_amount'] instanceof String)) {
-        throw new Error("Expected the field `order_amount` to be a primitive type in the JSON string but got " + data['order_amount']);
+      if (data['pricing_currency'] && !(typeof data['pricing_currency'] === 'string' || data['pricing_currency'] instanceof String)) {
+        throw new Error("Expected the field `pricing_currency` to be a primitive type in the JSON string but got " + data['pricing_currency']);
       }
       // ensure the json data is a string
-      if (data['fee_amount'] && !(typeof data['fee_amount'] === 'string' || data['fee_amount'] instanceof String)) {
-        throw new Error("Expected the field `fee_amount` to be a primitive type in the JSON string but got " + data['fee_amount']);
+      if (data['pricing_amount'] && !(typeof data['pricing_amount'] === 'string' || data['pricing_amount'] instanceof String)) {
+        throw new Error("Expected the field `pricing_amount` to be a primitive type in the JSON string but got " + data['pricing_amount']);
       }
       // ensure the json data is a string
-      if (data['merchant_order_code'] && !(typeof data['merchant_order_code'] === 'string' || data['merchant_order_code'] instanceof String)) {
-        throw new Error("Expected the field `merchant_order_code` to be a primitive type in the JSON string but got " + data['merchant_order_code']);
+      if (data['fee_amount'] && !(typeof data['fee_amount'] === 'string' || data['fee_amount'] instanceof String)) {
+        throw new Error("Expected the field `fee_amount` to be a primitive type in the JSON string but got " + data['fee_amount']);
       }
       // ensure the json data is a string
-      if (data['psp_order_code'] && !(typeof data['psp_order_code'] === 'string' || data['psp_order_code'] instanceof String)) {
-        throw new Error("Expected the field `psp_order_code` to be a primitive type in the JSON string but got " + data['psp_order_code']);
+      if (data['payable_currency'] && !(typeof data['payable_currency'] === 'string' || data['payable_currency'] instanceof String)) {
+        throw new Error("Expected the field `payable_currency` to be a primitive type in the JSON string but got " + data['payable_currency']);
       }
       // ensure the json data is a string
-      if (data['custom_exchange_rate'] && !(typeof data['custom_exchange_rate'] === 'string' || data['custom_exchange_rate'] instanceof String)) {
-        throw new Error("Expected the field `custom_exchange_rate` to be a primitive type in the JSON string but got " + data['custom_exchange_rate']);
+      if (data['payable_amount'] && !(typeof data['payable_amount'] === 'string' || data['payable_amount'] instanceof String)) {
+        throw new Error("Expected the field `payable_amount` to be a primitive type in the JSON string but got " + data['payable_amount']);
       }
       // ensure the json data is a string
       if (data['amount_tolerance'] && !(typeof data['amount_tolerance'] === 'string' || data['amount_tolerance'] instanceof String)) {
         throw new Error("Expected the field `amount_tolerance` to be a primitive type in the JSON string but got " + data['amount_tolerance']);
       }
+      // ensure the json data is a string
+      if (data['currency'] && !(typeof data['currency'] === 'string' || data['currency'] instanceof String)) {
+        throw new Error("Expected the field `currency` to be a primitive type in the JSON string but got " + data['currency']);
+      }
+      // ensure the json data is a string
+      if (data['order_amount'] && !(typeof data['order_amount'] === 'string' || data['order_amount'] instanceof String)) {
+        throw new Error("Expected the field `order_amount` to be a primitive type in the JSON string but got " + data['order_amount']);
+      }
+      // ensure the json data is a string
+      if (data['token_id'] && !(typeof data['token_id'] === 'string' || data['token_id'] instanceof String)) {
+        throw new Error("Expected the field `token_id` to be a primitive type in the JSON string but got " + data['token_id']);
+      }
+      // ensure the json data is a string
+      if (data['custom_exchange_rate'] && !(typeof data['custom_exchange_rate'] === 'string' || data['custom_exchange_rate'] instanceof String)) {
+        throw new Error("Expected the field `custom_exchange_rate` to be a primitive type in the JSON string but got " + data['custom_exchange_rate']);
+      }
       return true;
     }
   }]);
 }();
-CreatePaymentOrderRequest.RequiredProperties = ["merchant_id", "token_id", "order_amount", "fee_amount", "psp_order_code"];
+CreatePaymentOrderRequest.RequiredProperties = ["merchant_id", "psp_order_code", "fee_amount"];
 
 /**
- * The merchant ID. This ID is assigned by Cobo when you create the merchant.
+ * The merchant ID.
  * @member {String} merchant_id
  */
 CreatePaymentOrderRequest.prototype['merchant_id'] = undefined;
 
 /**
- * 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` 
- * @member {String} token_id
+ * A unique reference code assigned by the merchant to identify this order in their system.
+ * @member {String} merchant_order_code
  */
-CreatePaymentOrderRequest.prototype['token_id'] = undefined;
+CreatePaymentOrderRequest.prototype['merchant_order_code'] = undefined;
 
 /**
- * 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. 
- * @member {String} currency
- * @default ''
+ * A unique reference code assigned by the developer to identify this order in their system.
+ * @member {String} psp_order_code
  */
-CreatePaymentOrderRequest.prototype['currency'] = '';
+CreatePaymentOrderRequest.prototype['psp_order_code'] = undefined;
 
 /**
- *  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.  
- * @member {String} order_amount
+ * 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` 
+ * @member {String} pricing_currency
  */
-CreatePaymentOrderRequest.prototype['order_amount'] = undefined;
+CreatePaymentOrderRequest.prototype['pricing_currency'] = undefined;
 
 /**
- *  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. 
+ * The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places.
+ * @member {String} pricing_amount
+ */
+CreatePaymentOrderRequest.prototype['pricing_amount'] = undefined;
+
+/**
+ * The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. For example, if order_amount is \"100.00\" and fee_amount is \"2.00\", the customer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant and \"2.00\" settled to the developer. Values must be greater than 0 and contain two decimal places.
  * @member {String} fee_amount
  */
 CreatePaymentOrderRequest.prototype['fee_amount'] = undefined;
 
 /**
- * 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.
- * @member {String} merchant_order_code
+ * 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` 
+ * @member {String} payable_currency
  */
-CreatePaymentOrderRequest.prototype['merchant_order_code'] = undefined;
+CreatePaymentOrderRequest.prototype['payable_currency'] = undefined;
 
 /**
- * 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. 
- * @member {String} psp_order_code
+ * The actual payable amount of the order in the cryptocurrency.
+ * @member {String} payable_amount
  */
-CreatePaymentOrderRequest.prototype['psp_order_code'] = undefined;
+CreatePaymentOrderRequest.prototype['payable_amount'] = undefined;
 
 /**
- * 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. 
+ * The pay-in order will expire after approximately a certain number of seconds: - 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. 
  * @member {Number} expired_in
- * @default 1800
  */
-CreatePaymentOrderRequest.prototype['expired_in'] = 1800;
+CreatePaymentOrderRequest.prototype['expired_in'] = undefined;
+
+/**
+ * Allowed amount deviation, precision to 1 decimal place.
+ * @member {String} amount_tolerance
+ */
+CreatePaymentOrderRequest.prototype['amount_tolerance'] = undefined;
+
+/**
+ * The fiat currency of the order.
+ * @member {String} currency
+ * @default ''
+ */
+CreatePaymentOrderRequest.prototype['currency'] = '';
+
+/**
+ * The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places.
+ * @member {String} order_amount
+ */
+CreatePaymentOrderRequest.prototype['order_amount'] = undefined;
+
+/**
+ * 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` 
+ * @member {String} token_id
+ */
+CreatePaymentOrderRequest.prototype['token_id'] = undefined;
 
 /**
- * This field has been deprecated. 
+ * Indicates whether to allocate a dedicated address for this order.  If false, a shared address from the address pool will be used. 
  * @member {Boolean} use_dedicated_address
  */
 CreatePaymentOrderRequest.prototype['use_dedicated_address'] = undefined;
 
 /**
- *  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. 
+ * A custom exchange rate specified by the merchant.   - Only effective when `currency` is `\"USD\"`.   - Expressed as the amount of USD per 1 unit of the specified cryptocurrency.   - If not provided, the system will use the default internal rate.   Example: If the cryptocurrency is USDT and `custom_exchange_rate` = `\"0.99\"`, it means 1 USDT = 0.99 USD. 
  * @member {String} custom_exchange_rate
  */
 CreatePaymentOrderRequest.prototype['custom_exchange_rate'] = undefined;
-
-/**
- * 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`. 
- * @member {String} amount_tolerance
- */
-CreatePaymentOrderRequest.prototype['amount_tolerance'] = undefined;
 var _default = exports["default"] = CreatePaymentOrderRequest;

package/dist/model/CreatePayoutRequest.js

@@ -0,0 +1,192 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _PaymentPayoutParam = _interopRequireDefault(require("./PaymentPayoutParam"));
+var _PayoutChannel = _interopRequireDefault(require("./PayoutChannel"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+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); }
+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; } } }; }
+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; } }
+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; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+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); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+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); } /**
+ * Cobo Wallet as a Service 2.0
+ *
+ * Contact: help@cobo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The CreatePayoutRequest model module.
+ * @module model/CreatePayoutRequest
+ */
+var CreatePayoutRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>CreatePayoutRequest</code>.
+   * @alias module:model/CreatePayoutRequest
+   * @param request_id {String} The request ID that is used to track a settlement request. The request ID is provided by you and must be unique.
+   * @param payout_channel {module:model/PayoutChannel} 
+   * @param payout_params {Array.<module:model/PaymentPayoutParam>} 
+   */
+  function CreatePayoutRequest(request_id, payout_channel, payout_params) {
+    _classCallCheck(this, CreatePayoutRequest);
+    CreatePayoutRequest.initialize(this, request_id, payout_channel, payout_params);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(CreatePayoutRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj, request_id, payout_channel, payout_params) {
+      obj['request_id'] = request_id;
+      obj['payout_channel'] = payout_channel;
+      obj['payout_params'] = payout_params;
+    }
+
+    /**
+     * Constructs a <code>CreatePayoutRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/CreatePayoutRequest} obj Optional instance to populate.
+     * @return {module:model/CreatePayoutRequest} The populated <code>CreatePayoutRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new CreatePayoutRequest();
+        if (data.hasOwnProperty('request_id')) {
+          obj['request_id'] = _ApiClient["default"].convertToType(data['request_id'], 'String');
+        }
+        if (data.hasOwnProperty('payout_channel')) {
+          obj['payout_channel'] = _PayoutChannel["default"].constructFromObject(data['payout_channel']);
+        }
+        if (data.hasOwnProperty('payout_params')) {
+          obj['payout_params'] = _ApiClient["default"].convertToType(data['payout_params'], [_PaymentPayoutParam["default"]]);
+        }
+        if (data.hasOwnProperty('bank_account_id')) {
+          obj['bank_account_id'] = _ApiClient["default"].convertToType(data['bank_account_id'], 'String');
+        }
+        if (data.hasOwnProperty('currency')) {
+          obj['currency'] = _ApiClient["default"].convertToType(data['currency'], 'String');
+        }
+        if (data.hasOwnProperty('remark')) {
+          obj['remark'] = _ApiClient["default"].convertToType(data['remark'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>CreatePayoutRequest</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreatePayoutRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(CreatePayoutRequest.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (data['request_id'] && !(typeof data['request_id'] === 'string' || data['request_id'] instanceof String)) {
+        throw new Error("Expected the field `request_id` to be a primitive type in the JSON string but got " + data['request_id']);
+      }
+      if (data['payout_params']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['payout_params'])) {
+          throw new Error("Expected the field `payout_params` to be an array in the JSON data but got " + data['payout_params']);
+        }
+        // validate the optional field `payout_params` (array)
+        var _iterator2 = _createForOfIteratorHelper(data['payout_params']),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var item = _step2.value;
+            _PaymentPayoutParam["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+        ;
+      }
+      // ensure the json data is a string
+      if (data['bank_account_id'] && !(typeof data['bank_account_id'] === 'string' || data['bank_account_id'] instanceof String)) {
+        throw new Error("Expected the field `bank_account_id` to be a primitive type in the JSON string but got " + data['bank_account_id']);
+      }
+      // ensure the json data is a string
+      if (data['currency'] && !(typeof data['currency'] === 'string' || data['currency'] instanceof String)) {
+        throw new Error("Expected the field `currency` to be a primitive type in the JSON string but got " + data['currency']);
+      }
+      // ensure the json data is a string
+      if (data['remark'] && !(typeof data['remark'] === 'string' || data['remark'] instanceof String)) {
+        throw new Error("Expected the field `remark` to be a primitive type in the JSON string but got " + data['remark']);
+      }
+      return true;
+    }
+  }]);
+}();
+CreatePayoutRequest.RequiredProperties = ["request_id", "payout_channel", "payout_params"];
+
+/**
+ * The request ID that is used to track a settlement request. The request ID is provided by you and must be unique.
+ * @member {String} request_id
+ */
+CreatePayoutRequest.prototype['request_id'] = undefined;
+
+/**
+ * @member {module:model/PayoutChannel} payout_channel
+ */
+CreatePayoutRequest.prototype['payout_channel'] = undefined;
+
+/**
+ * @member {Array.<module:model/PaymentPayoutParam>} payout_params
+ */
+CreatePayoutRequest.prototype['payout_params'] = undefined;
+
+/**
+ * ｜ Only used in OffRamp payout channel. The ID of the bank account where the settled funds will be deposited.
+ * @member {String} bank_account_id
+ */
+CreatePayoutRequest.prototype['bank_account_id'] = undefined;
+
+/**
+ * The fiat currency for the create payouts.
+ * @member {String} currency
+ */
+CreatePayoutRequest.prototype['currency'] = undefined;
+
+/**
+ * The remark for the create payouts.
+ * @member {String} remark
+ */
+CreatePayoutRequest.prototype['remark'] = undefined;
+var _default = exports["default"] = CreatePayoutRequest;

package/dist/model/CreateRefundRequest.js

@@ -206,19 +206,19 @@ CreateRefundRequest.prototype['refund_type'] = undefined;
 CreateRefundRequest.prototype['order_id'] = undefined;
 
 /**
- * Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).     - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance    - `false`: The merchant is not charged any developer fee  When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified. 
+ * Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).     - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance    - `false`: The merchant is not charged any developer fee  When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified. 
  * @member {Boolean} charge_merchant_fee
  */
 CreateRefundRequest.prototype['charge_merchant_fee'] = undefined;
 
 /**
- * The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).  This field is required when `charge_merchant_fee` is `true`. Must be:   - A positive integer with up to two decimal places.   - Less than the refund amount 
+ * The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).  This field is required when `charge_merchant_fee` is `true`. Must be:   - A positive integer with up to two decimal places.   - Less than the refund amount 
  * @member {String} merchant_fee_amount
  */
 CreateRefundRequest.prototype['merchant_fee_amount'] = undefined;
 
 /**
- * The ID of the cryptocurrency used for the developer fee. It must be the same as `token_id`. 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` 
+ * The ID of the cryptocurrency used for the transaction fee. This is only applicable if `charge_merchant_fee` is set to true. 
  * @member {String} merchant_fee_token_id
  */
 CreateRefundRequest.prototype['merchant_fee_token_id'] = undefined;

package/dist/model/CreateSafeWalletParams.js

@@ -184,7 +184,7 @@ CreateSafeWalletParams.prototype['wallet_type'] = undefined;
 CreateSafeWalletParams.prototype['wallet_subtype'] = undefined;
 
 /**
- * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Web3 Wallets.
+ * Enable the auto-sweep feature for the wallet. This parameter only applies to MPC Wallets and Custodial Wallets (Web3 Wallets).
  * @member {Boolean} enable_auto_sweep
  */
 CreateSafeWalletParams.prototype['enable_auto_sweep'] = undefined;