@cobo/cobo-waas2 1.21.0 → 1.22.0

package/dist/api/PaymentApi.js

@@ -21,13 +21,17 @@ var _GetExchangeRate200Response = _interopRequireDefault(require("../model/GetEx
 var _GetRefunds200Response = _interopRequireDefault(require("../model/GetRefunds200Response"));
 var _GetSettlementInfoByIds200Response = _interopRequireDefault(require("../model/GetSettlementInfoByIds200Response"));
 var _ListForcedSweepRequests200Response = _interopRequireDefault(require("../model/ListForcedSweepRequests200Response"));
+var _ListMerchantBalances200Response = _interopRequireDefault(require("../model/ListMerchantBalances200Response"));
 var _ListMerchants200Response = _interopRequireDefault(require("../model/ListMerchants200Response"));
 var _ListPaymentOrders200Response = _interopRequireDefault(require("../model/ListPaymentOrders200Response"));
+var _ListPaymentWalletBalances200Response = _interopRequireDefault(require("../model/ListPaymentWalletBalances200Response"));
 var _ListSettlementDetails200Response = _interopRequireDefault(require("../model/ListSettlementDetails200Response"));
 var _ListSettlementRequests200Response = _interopRequireDefault(require("../model/ListSettlementRequests200Response"));
 var _ListTopUpPayers200Response = _interopRequireDefault(require("../model/ListTopUpPayers200Response"));
 var _Merchant = _interopRequireDefault(require("../model/Merchant"));
 var _Order = _interopRequireDefault(require("../model/Order"));
+var _PspBalance = _interopRequireDefault(require("../model/PspBalance"));
+var _ReceivedAmountPerAddress = _interopRequireDefault(require("../model/ReceivedAmountPerAddress"));
 var _Refund = _interopRequireDefault(require("../model/Refund"));
 var _Settlement = _interopRequireDefault(require("../model/Settlement"));
 var _SupportedToken = _interopRequireDefault(require("../model/SupportedToken"));
@@ -71,7 +75,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
 
   /**
    * Cancel refund order
-   * This operation cancels a specified refund order. 
+   * This operation cancels a specified refund order. You can only cancel refund orders that have not been processed yet. 
    * @param {String} refund_id The refund order ID.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Refund} and HTTP response
    */
@@ -101,7 +105,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Cancel refund order
-     * This operation cancels a specified refund order. 
+     * This operation cancels a specified refund order. You can only cancel refund orders that have not been processed yet. 
      * @param {String} refund_id The refund order ID.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Refund}
      */
@@ -115,9 +119,9 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Create crypto address
-     * Create a new cryptocurrency address for receiving payouts or transfers.  The address must match the specified `token_id`'s blockchain.  Optionally, a label can be provided to help categorize the address internally. 
+     * This operation registers a crypto address for crypto withdrawal.  The registered address can later be referenced by its ID when creating settlement requests. 
      * @param {Object} opts Optional parameters
-     * @param {module:model/CreateCryptoAddressRequest} [CreateCryptoAddressRequest] The request body to create a crypto address.
+     * @param {module:model/CreateCryptoAddressRequest} [CreateCryptoAddressRequest] The request body to register a crypto address.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CryptoAddress} and HTTP response
      */
   }, {
@@ -141,9 +145,9 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Create crypto address
-     * Create a new cryptocurrency address for receiving payouts or transfers.  The address must match the specified `token_id`'s blockchain.  Optionally, a label can be provided to help categorize the address internally. 
+     * This operation registers a crypto address for crypto withdrawal.  The registered address can later be referenced by its ID when creating settlement requests. 
      * @param {Object} opts Optional parameters
-     * @param {module:model/CreateCryptoAddressRequest} opts.CreateCryptoAddressRequest The request body to create a crypto address.
+     * @param {module:model/CreateCryptoAddressRequest} opts.CreateCryptoAddressRequest The request body to register a crypto address.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CryptoAddress}
      */
   }, {
@@ -361,7 +365,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Delete crypto address
-     * This operation deletes a crypto address. 
+     * This operation unregisters a crypto address from being used for crypto withdrawals. 
      * @param {String} crypto_address_id The crypto address ID.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteCryptoAddress201Response} and HTTP response
      */
@@ -391,7 +395,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Delete crypto address
-     * This operation deletes a crypto address. 
+     * This operation unregisters a crypto address from being used for crypto withdrawals. 
      * @param {String} crypto_address_id The crypto address ID.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteCryptoAddress201Response}
      */
@@ -454,6 +458,64 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Get payer balance by address
+     * This operation retrieves aggregated balance details for a specific token and payer, with amounts grouped by address. 
+     * @param {String} merchant_id The merchant ID.
+     * @param {String} payer_id Unique payer identifier on the Cobo side, auto-generated by the system.
+     * @param {String} token_id 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` 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/ReceivedAmountPerAddress>} and HTTP response
+     */
+  }, {
+    key: "getPayerBalanceByAddressWithHttpInfo",
+    value: function getPayerBalanceByAddressWithHttpInfo(merchant_id, payer_id, token_id) {
+      var postBody = null;
+      if (postBody && postBody.toJSON) {
+        postBody = postBody.toJSON();
+      }
+      // verify the required parameter 'merchant_id' is set
+      if (merchant_id === undefined || merchant_id === null) {
+        throw new Error("Missing the required parameter 'merchant_id' when calling getPayerBalanceByAddress");
+      }
+      // verify the required parameter 'payer_id' is set
+      if (payer_id === undefined || payer_id === null) {
+        throw new Error("Missing the required parameter 'payer_id' when calling getPayerBalanceByAddress");
+      }
+      // verify the required parameter 'token_id' is set
+      if (token_id === undefined || token_id === null) {
+        throw new Error("Missing the required parameter 'token_id' when calling getPayerBalanceByAddress");
+      }
+      var pathParams = {};
+      var queryParams = {
+        'merchant_id': merchant_id,
+        'payer_id': payer_id,
+        'token_id': token_id
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['OAuth2', 'CoboAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = [_ReceivedAmountPerAddress["default"]];
+      return this.apiClient.callApi('/payments/balance/payer/address', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Get payer balance by address
+     * This operation retrieves aggregated balance details for a specific token and payer, with amounts grouped by address. 
+     * @param {String} merchant_id The merchant ID.
+     * @param {String} payer_id Unique payer identifier on the Cobo side, auto-generated by the system.
+     * @param {String} token_id 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` 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/ReceivedAmountPerAddress>}
+     */
+  }, {
+    key: "getPayerBalanceByAddress",
+    value: function getPayerBalanceByAddress(merchant_id, payer_id, token_id) {
+      return this.getPayerBalanceByAddressWithHttpInfo(merchant_id, payer_id, token_id).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Get pay-in order information
      * This operation retrieves details of a specific pay-in order. 
@@ -498,6 +560,50 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Get psp balance
+     * This operation retrieves the information of psp balance. 
+     * @param {String} token_id 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` 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PspBalance} and HTTP response
+     */
+  }, {
+    key: "getPspBalanceWithHttpInfo",
+    value: function getPspBalanceWithHttpInfo(token_id) {
+      var postBody = null;
+      if (postBody && postBody.toJSON) {
+        postBody = postBody.toJSON();
+      }
+      // verify the required parameter 'token_id' is set
+      if (token_id === undefined || token_id === null) {
+        throw new Error("Missing the required parameter 'token_id' when calling getPspBalance");
+      }
+      var pathParams = {};
+      var queryParams = {
+        'token_id': token_id
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['OAuth2', 'CoboAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _PspBalance["default"];
+      return this.apiClient.callApi('/payments/balance/psp', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Get psp balance
+     * This operation retrieves the information of psp balance. 
+     * @param {String} token_id 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` 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PspBalance}
+     */
+  }, {
+    key: "getPspBalance",
+    value: function getPspBalance(token_id) {
+      return this.getPspBalanceWithHttpInfo(token_id).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Get refund order information
      * This operation retrieves the detailed information about a specified refund order. 
@@ -551,7 +657,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [after] A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. 
      * @param {String} [merchant_id] The merchant ID.
      * @param {String} [request_id] The request ID.
-     * @param {String} [statuses] A list of  statuses of order, refund or settle request.
+     * @param {String} [statuses] A list of order, refund or settlement statuses. You can refer to the following operations for the possible status values:  - [Get pay-in order information](https://www.cobo.com/developers/v2/api-references/payment/get-pay-in-order-information)  - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information)  - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRefunds200Response} and HTTP response
      */
   }, {
@@ -589,7 +695,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} opts.after A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. 
      * @param {String} opts.merchant_id The merchant ID.
      * @param {String} opts.request_id The request ID.
-     * @param {String} opts.statuses A list of  statuses of order, refund or settle request.
+     * @param {String} opts.statuses A list of order, refund or settlement statuses. You can refer to the following operations for the possible status values:  - [Get pay-in order information](https://www.cobo.com/developers/v2/api-references/payment/get-pay-in-order-information)  - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information)  - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRefunds200Response}
      */
   }, {
@@ -882,6 +988,63 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * List merchant balances
+     * This operation retrieves the information of merchant balances. 
+     * @param {String} token_id 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` 
+     * @param {module:model/AcquiringType} acquiring_type AcquiringType defines the acquisition logic used in the payment flow: - `Order`: Each order is created with a specific amount and associated payment request. Funds are settled on a per-order basis. - `TopUp`: Recharge-style flow where funds are topped up to a payer balance or account. Useful for flexible or usage-based payment models. 
+     * @param {Object} opts Optional parameters
+     * @param {String} [merchant_ids] A list of merchant IDs to query.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMerchantBalances200Response} and HTTP response
+     */
+  }, {
+    key: "listMerchantBalancesWithHttpInfo",
+    value: function listMerchantBalancesWithHttpInfo(token_id, acquiring_type, opts) {
+      opts = opts || {};
+      var postBody = null;
+      if (postBody && postBody.toJSON) {
+        postBody = postBody.toJSON();
+      }
+      // verify the required parameter 'token_id' is set
+      if (token_id === undefined || token_id === null) {
+        throw new Error("Missing the required parameter 'token_id' when calling listMerchantBalances");
+      }
+      // verify the required parameter 'acquiring_type' is set
+      if (acquiring_type === undefined || acquiring_type === null) {
+        throw new Error("Missing the required parameter 'acquiring_type' when calling listMerchantBalances");
+      }
+      var pathParams = {};
+      var queryParams = {
+        'merchant_ids': opts['merchant_ids'],
+        'token_id': token_id,
+        'acquiring_type': acquiring_type
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['OAuth2', 'CoboAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _ListMerchantBalances200Response["default"];
+      return this.apiClient.callApi('/payments/balance/merchants', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * List merchant balances
+     * This operation retrieves the information of merchant balances. 
+     * @param {String} token_id 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` 
+     * @param {module:model/AcquiringType} acquiring_type AcquiringType defines the acquisition logic used in the payment flow: - `Order`: Each order is created with a specific amount and associated payment request. Funds are settled on a per-order basis. - `TopUp`: Recharge-style flow where funds are topped up to a payer balance or account. Useful for flexible or usage-based payment models. 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.merchant_ids A list of merchant IDs to query.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMerchantBalances200Response}
+     */
+  }, {
+    key: "listMerchantBalances",
+    value: function listMerchantBalances(token_id, acquiring_type, opts) {
+      return this.listMerchantBalancesWithHttpInfo(token_id, acquiring_type, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * List all merchants
      * This operation retrieves the information of all merchants.   You can filter the results by using a keyword for fuzzy search on merchant names or by specifying a wallet ID. 
@@ -946,7 +1109,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [after] A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. 
      * @param {String} [merchant_id] The merchant ID.
      * @param {String} [psp_order_id] A unique reference code assigned by the developer to identify this order in their system.
-     * @param {String} [statuses] A list of  statuses of order, refund or settle request.
+     * @param {String} [statuses] A list of order, refund or settlement statuses. You can refer to the following operations for the possible status values:  - [Get pay-in order information](https://www.cobo.com/developers/v2/api-references/payment/get-pay-in-order-information)  - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information)  - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPaymentOrders200Response} and HTTP response
      */
   }, {
@@ -984,7 +1147,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} opts.after A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. 
      * @param {String} opts.merchant_id The merchant ID.
      * @param {String} opts.psp_order_id A unique reference code assigned by the developer to identify this order in their system.
-     * @param {String} opts.statuses A list of  statuses of order, refund or settle request.
+     * @param {String} opts.statuses A list of order, refund or settlement statuses. You can refer to the following operations for the possible status values:  - [Get pay-in order information](https://www.cobo.com/developers/v2/api-references/payment/get-pay-in-order-information)  - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information)  - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPaymentOrders200Response}
      */
   }, {
@@ -1031,6 +1194,56 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * List payment wallet balances
+     * This operation retrieves the information of payment wallet balances. 
+     * @param {String} token_id 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` 
+     * @param {Object} opts Optional parameters
+     * @param {String} [wallet_ids] A list of wallet IDs to query.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPaymentWalletBalances200Response} and HTTP response
+     */
+  }, {
+    key: "listPaymentWalletBalancesWithHttpInfo",
+    value: function listPaymentWalletBalancesWithHttpInfo(token_id, opts) {
+      opts = opts || {};
+      var postBody = null;
+      if (postBody && postBody.toJSON) {
+        postBody = postBody.toJSON();
+      }
+      // verify the required parameter 'token_id' is set
+      if (token_id === undefined || token_id === null) {
+        throw new Error("Missing the required parameter 'token_id' when calling listPaymentWalletBalances");
+      }
+      var pathParams = {};
+      var queryParams = {
+        'wallet_ids': opts['wallet_ids'],
+        'token_id': token_id
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['OAuth2', 'CoboAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _ListPaymentWalletBalances200Response["default"];
+      return this.apiClient.callApi('/payments/balance/payment_wallets', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * List payment wallet balances
+     * This operation retrieves the information of payment wallet balances. 
+     * @param {String} token_id 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` 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.wallet_ids A list of wallet IDs to query.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPaymentWalletBalances200Response}
+     */
+  }, {
+    key: "listPaymentWalletBalances",
+    value: function listPaymentWalletBalances(token_id, opts) {
+      return this.listPaymentWalletBalancesWithHttpInfo(token_id, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * List all settlement details
      * This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. 
@@ -1039,7 +1252,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [before] A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. 
      * @param {String} [after] A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. 
      * @param {String} [merchant_id] The merchant ID.
-     * @param {String} [statuses] A list of  statuses of order, refund or settle request.
+     * @param {String} [statuses] A list of order, refund or settlement statuses. You can refer to the following operations for the possible status values:  - [Get pay-in order information](https://www.cobo.com/developers/v2/api-references/payment/get-pay-in-order-information)  - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information)  - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListSettlementDetails200Response} and HTTP response
      */
   }, {
@@ -1075,7 +1288,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} opts.before A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. 
      * @param {String} opts.after A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. 
      * @param {String} opts.merchant_id The merchant ID.
-     * @param {String} opts.statuses A list of  statuses of order, refund or settle request.
+     * @param {String} opts.statuses A list of order, refund or settlement statuses. You can refer to the following operations for the possible status values:  - [Get pay-in order information](https://www.cobo.com/developers/v2/api-references/payment/get-pay-in-order-information)  - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information)  - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListSettlementDetails200Response}
      */
   }, {
@@ -1296,8 +1509,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Update refund order information
-     * This operation updates a specified refund order. 
+     * Update refund order
+     * This operation updates a specified refund order by modifying its recipient address. You can only update the recipient address for refund orders that have not been processed yet. 
      * @param {String} refund_id The refund order ID.
      * @param {Object} opts Optional parameters
      * @param {module:model/UpdateRefundByIdRequest} [UpdateRefundByIdRequest] The request body to update a refund order.
@@ -1329,8 +1542,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Update refund order information
-     * This operation updates a specified refund order. 
+     * Update refund order
+     * This operation updates a specified refund order by modifying its recipient address. You can only update the recipient address for refund orders that have not been processed yet. 
      * @param {String} refund_id The refund order ID.
      * @param {Object} opts Optional parameters
      * @param {module:model/UpdateRefundByIdRequest} opts.UpdateRefundByIdRequest The request body to update a refund order.