@cobo/cobo-waas2 1.24.0 → 1.26.0

package/docs/FeeStationSponsorTransactionDescription.md

@@ -0,0 +1,10 @@
+# CoboWaas2.FeeStationSponsorTransactionDescription
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_fee_amount** | **String** | The total amount used to sponsor the gas fee required for executing the main transaction on behalf of the user. | 
+**commission_fee** | **String** | The commission fee charged for sponsoring the gas fee.  | 
+
+

package/docs/FundsStatusType.md

@@ -0,0 +1,32 @@
+# CoboWaas2.FundsStatusType
+
+## Enum
+
+
+* `Frozen` (value: `"Frozen"`)
+
+* `Refunding` (value: `"Refunding"`)
+
+* `Refunded` (value: `"Refunded"`)
+
+* `RefundFailed` (value: `"RefundFailed"`)
+
+* `Unfreezing` (value: `"Unfreezing"`)
+
+* `Unfrozen` (value: `"Unfrozen"`)
+
+* `UnfreezingFailed` (value: `"UnfreezingFailed"`)
+
+* `Isolating` (value: `"Isolating"`)
+
+* `Isolated` (value: `"Isolated"`)
+
+* `IsolationFailed` (value: `"IsolationFailed"`)
+
+* `CoboDisposition` (value: `"CoboDisposition"`)
+
+* `Normal` (value: `"Normal"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/KytScreeningsDecisionsType.md

@@ -0,0 +1,16 @@
+# CoboWaas2.KytScreeningsDecisionsType
+
+## Enum
+
+
+* `Approval` (value: `"Approval"`)
+
+* `ApprovalWithAlert` (value: `"ApprovalWithAlert"`)
+
+* `Rejection` (value: `"Rejection"`)
+
+* `ManualReview` (value: `"ManualReview"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/KytScreeningsEventData.md

@@ -0,0 +1,13 @@
+# CoboWaas2.KytScreeningsEventData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The transaction ID. | 
+**transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) |  | 
+**review_status** | [**ReviewStatusType**](ReviewStatusType.md) |  | 
+**funds_status** | [**FundsStatusType**](FundsStatusType.md) |  | 
+**updated_timestamp** | **Number** | The time when the KYT screening information was updated, in Unix timestamp format, measured in milliseconds. | 
+
+

package/docs/KytScreeningsReviewType.md

@@ -0,0 +1,12 @@
+# CoboWaas2.KytScreeningsReviewType
+
+## Enum
+
+
+* `Approval` (value: `"Approval"`)
+
+* `Rejection` (value: `"Rejection"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/KytScreeningsTransaction.md

@@ -0,0 +1,12 @@
+# CoboWaas2.KytScreeningsTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The UUID of the transaction that was screened. | 
+**transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) |  | 
+**review_status** | [**ReviewStatusType**](ReviewStatusType.md) |  | 
+**funds_status** | [**FundsStatusType**](FundsStatusType.md) |  | 
+
+

package/docs/KytScreeningsTransactionType.md

@@ -0,0 +1,12 @@
+# CoboWaas2.KytScreeningsTransactionType
+
+## Enum
+
+
+* `Deposit` (value: `"Deposit"`)
+
+* `Withdrawal` (value: `"Withdrawal"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/Link.md

@@ -0,0 +1,10 @@
+# CoboWaas2.Link
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The base URL of the payment page. This URL should be combined with the `token` parameter to form the complete payment link.  | 
+**token** | **String** | The unique payment token that should be appended to the URL as a query parameter. This token authenticates and identifies the specific payment session.  The complete payment link should be constructed as: `[url]?token=[token]`  | 
+
+

package/docs/LinkDisplayInfo.md

@@ -0,0 +1,10 @@
+# CoboWaas2.LinkDisplayInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**developer_name** | **String** | The brand name to display to end users during the payment process.  | [optional] 
+**logo** | **String** | The URL of your logo image to display to end users during the payment process.  | [optional] 
+
+

package/docs/MPCVaultEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
 **vault_id** | **String** | The vault ID. | [optional] 
 **project_id** | **String** | The project ID. | [optional] 
 **name** | **String** | The vault name. | [optional] 
@@ -49,6 +49,8 @@ Name | Type | Description | Notes
 
 * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
 
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/Merchant.md

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **merchant_id** | **String** | The merchant ID. | 
 **name** | **String** | The merchant name. | 
-**wallet_id** | **String** | The ID of the linked wallet. | 
-**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. If you are a merchant (directly serving the payer), you do not need to configure the developer fee rate. | [optional] 
+**wallet_id** | **String** | This field has been deprecated. | 
+**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. | [optional] 
 **wallet_setup** | [**WalletSetup**](WalletSetup.md) |  | [optional] 
 **created_timestamp** | **Number** | The creation time of the merchant, represented as a UNIX timestamp in seconds. | [optional] 
 **updated_timestamp** | **Number** | The last update time of the merchant, represented as a UNIX timestamp in seconds. | [optional] 

package/docs/MerchantBalance.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **total_received_amount** | **String** | The total amount of the token that has been received by the merchant. | [optional] 
 **settled_amount** | **String** | The total amount of the token that has been paid out from the merchant's balance. | [optional] 
 **refunded_amount** | **String** | The total amount of the token that has been refunded from the merchant's balance. | [optional] 
-**total_balance** | **String** |  The total balance of the token available for payout or refund for the merchant.  `total_balance` = `total_received_amount` - `settled_amount` - `refunded_amount`  For more information, please refer to [Amounts and Balances](/v2_cn/payments/amounts-and-balances)  | [optional] 
+**total_balance** | **String** |  The total balance of the token available for payout or refund for the merchant.  `total_balance` = `total_received_amount` - `settled_amount` - `refunded_amount`  For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances)  | [optional] 
 **available_balance** | **String** | This field has been deprecated. | [optional] 
 
 

package/docs/Order.md

@@ -23,5 +23,6 @@ Name | Type | Description | Notes
 **updated_timestamp** | **Number** | The last update time of the order, represented as a UNIX timestamp in seconds. | [optional] 
 **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the pay-in process. | [optional] 
 **settlement_status** | [**SettleStatus**](SettleStatus.md) |  | [optional] 
+**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur.  When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.  | [optional] 
 
 

package/docs/OrderLinkBusinessInfo.md

@@ -0,0 +1,19 @@
+# CoboWaas2.OrderLinkBusinessInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_ids** | **[String]** | An array of token IDs representing the cryptocurrencies and chains available for payment. These options will be shown to users on the payment page for them to choose from. Supported token IDs include:   - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
+**custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) | A list of custom exchange rates defining how much one unit of a specific cryptocurrency (`token_id`) is valued in the selected fiat or crypto currency (`currency`). If this field is omitted, the system’s default exchange rates will apply.  Each item specifies a `token_id` and its corresponding `exchange_rate`. For example, to treat 1 USDT (on Ethereum) as equivalent to 0.99 USD, provide:  ```json {   \"custom_exchange_rates\": [     {       \"token_id\": \"ETH_USDT\",       \"exchange_rate\": \"0.99\"     }   ],   \"currency\": \"USD\" } ```  | [optional] 
+**currency** | **String** | The currency in which both the order amount (`order_amount`) and the developer fee (`fee_amount`) are denominated. Only the following values are supported: `USD`, `USDT`, or `USDC`.  | 
+**fee_amount** | **String** | The developer fee for the order, denominated in the currency specified by `currency`.   If you are a merchant directly serving payers, set this field to `0`. Developer fees are only relevant for platforms like payment service providers (PSPs) that charge fees to their downstream merchants.  The developer fee is added to the base amount (`order_amount`) to determine the final charge. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\"  - Total charged to customer: \"102.00\"  Values can contain up to two decimal places.  | 
+**merchant_id** | **String** | The merchant ID. | 
+**order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`), denominated in the currency specified by `currency`.  Values must be greater than `0` and contain two decimal places.   | 
+**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] 
+**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.  | 
+**expired_in** | **Number** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration:  - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event.  | [optional] [default to 1800]
+**use_dedicated_address** | **Boolean** | This field has been deprecated.  | [optional] 
+**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur.  When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.  | [optional] 
+
+

package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md

@@ -0,0 +1,10 @@
+# CoboWaas2.OrderLinkBusinessInfoCustomExchangeRatesInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The token ID. | 
+**exchange_rate** | **String** | The exchange rate to use for this token. | 
+
+

package/docs/OtcFee.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**fee_rate** | **String** | The otc fee rate. | 
-**token_id** | **String** | The token id in otc. | [optional] 
+**fee_rate** | **String** | The exchange rate used to convert cryptos to fiat currencies during off-ramp. The final fiat amount is calculated using the following formula:  Final Fiat Amount = (Token Amount - Bridging Fee) × Exchange Rate  Note: The actual fiat amount received may be lower due to additional bank transfer fees.  | 
+**token_id** | **String** | The ID of the token you want to off-ramp. | [optional] 
 
 

package/docs/PaymentAddressUpdateEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
 **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. | 
 **payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. | 
 **chain** | **String** | The chain ID. | 
@@ -48,6 +48,8 @@ Name | Type | Description | Notes
 
 * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
 
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentApi.md

@@ -8,8 +8,10 @@ Method | HTTP request | Description
 [**createCryptoAddress**](PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
 [**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
 [**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
+[**createOrderLink**](PaymentApi.md#createOrderLink) | **POST** /payments/links/orders | Create order link
 [**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
 [**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
+[**createRefundLink**](PaymentApi.md#createRefundLink) | **POST** /payments/links/refunds | Create refund link
 [**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
 [**deleteCryptoAddress**](PaymentApi.md#deleteCryptoAddress) | **POST** /payments/crypto_addresses/{crypto_address_id}/delete | Delete crypto address
 [**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
@@ -33,7 +35,7 @@ Method | HTTP request | Description
 [**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
 [**listTopUpPayerAccounts**](PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
 [**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
-[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Payment estimate fee
+[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
 [**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
 [**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
 [**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
@@ -202,7 +204,7 @@ Name | Type | Description  | Notes
 
 Create merchant
 
-This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet.  Upon successful creation, a merchant ID is generated and returned along with the merchant's information.  If you are a merchant (directly serving the payer), you only need to create one merchant and do not need to configure the developer fee rate. The developer fee rate only applies to platforms such as payment service providers (PSPs) that charge fees to their downstream merchants. 
+This operation creates a merchant. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. For more information on merchant creation, please refer to [Preparation](https://www.cobo.com/developers/v2/payments/preparation#create-merchant). 
 
 ### Example
 
@@ -248,6 +250,58 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## createOrderLink
+
+> Link createOrderLink(opts)
+
+Create order link
+
+This operation generates a payment link for a pay-in order. The link directs users to a hosted payment page where they can complete their payment for the order. You can share the link directly with users or embed the payment page in your website or application using an iframe.  For more details, see [Payment Link](https://www.cobo.com/developers/v2/payments/payment-link). 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PaymentApi();
+const opts = {
+  'CreateOrderLinkRequest': new CoboWaas2.CreateOrderLinkRequest()
+};
+apiInstance.createOrderLink(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **CreateOrderLinkRequest** | [**CreateOrderLinkRequest**](CreateOrderLinkRequest.md)| The request body to create a payment link for a pay-in order. | [optional] 
+
+### Return type
+
+[**Link**](Link.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## createPaymentOrder
 
 > Order createPaymentOrder(opts)
@@ -352,6 +406,58 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## createRefundLink
+
+> Link createRefundLink(opts)
+
+Create refund link
+
+This operation creates a payment link for a refund. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PaymentApi();
+const opts = {
+  'CreateRefundLinkRequest': new CoboWaas2.CreateRefundLinkRequest()
+};
+apiInstance.createRefundLink(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **CreateRefundLinkRequest** | [**CreateRefundLinkRequest**](CreateRefundLinkRequest.md)| The request body to create a payment link for a refund. | [optional] 
+
+### Return type
+
+[**Link**](Link.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## createSettlementRequest
 
 > Settlement createSettlementRequest(opts)
@@ -410,7 +516,7 @@ Name | Type | Description  | Notes
 
 Delete crypto address
 
-This operation unregisters a crypto address from being used for crypto withdrawals. 
+This operation unregisters a crypto address from being used for crypto payouts. 
 
 ### Example
 
@@ -460,7 +566,7 @@ Name | Type | Description  | Notes
 
 Get exchange rate
 
-This operation retrieves the current exchange rate between a specified currency pair. 
+This operation retrieves the current exchange rate between a specified currency pair. The exchange rate is updated approximately every 10 minutes.  &lt;Note&gt;This operation returns the exchange rate for reference only. The actual exchange rate may vary due to market fluctuations and other factors.&lt;/Note&gt; 
 
 ### Example
 
@@ -618,7 +724,7 @@ Name | Type | Description  | Notes
 
 Get developer balance
 
-This operation retrieves the balance information for you as the developer. The balance information is grouped by token.  For more information, please refer to [Amounts and Balances](/v2/payments/amounts-and-balances) 
+This operation retrieves the balance information for you as the developer. The balance information is grouped by token.  For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). 
 
 ### Example
 
@@ -1098,7 +1204,7 @@ Name | Type | Description  | Notes
 
 List merchant balances
 
- This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the &#x60;merchant_ids&#x60; parameter, the balance information for all merchants will be returned.  For more information, please refer to [Amounts and Balances](/v2/payments/amounts-and-balances) 
+ This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the &#x60;merchant_ids&#x60; parameter, the balance information for all merchants will be returned.  For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). 
 
 ### Example
 
@@ -1193,8 +1299,8 @@ Name | Type | Description  | Notes
  **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.  | [optional] 
  **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.  | [optional] 
  **keyword** | **String**| A search term used for fuzzy matching of merchant names. | [optional] 
- **wallet_id** | **String**| The wallet ID. | [optional] 
- **wallet_setup** | [**WalletSetup**](.md)| WalletSetup defines the type of funds used in the merchant account, either \&quot;Shared\&quot; or \&quot;Separate\&quot; is allowed when creating a merchant: - &#x60;Default&#x60;: Wallet of psp owned default merchant. - &#x60;Shared&#x60;: Shared wallet of non-psp owned merchants. - &#x60;Separate&#x60;: Separate wallet of non-psp owned merchants.  | [optional] 
+ **wallet_id** | **String**| This parameter has been deprecated. | [optional] 
+ **wallet_setup** | [**WalletSetup**](.md)| The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses.  - &#x60;Shared&#x60;: Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously. - &#x60;Separate&#x60;: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant. - &#x60;Default&#x60;: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization).  | [optional] 
 
 ### Return type
 
@@ -1614,9 +1720,9 @@ Name | Type | Description  | Notes
 
 > PaymentEstimateFee201Response paymentEstimateFee(opts)
 
-Payment estimate fee
+Estimate fees
 
-This operation to payment estimate fee. 
+This operation calculates fees for payment-related operations, including: - **Pay-in**: Fees for accepting payments - **Refunds**: Fees for refunding the payment - **Crypto payouts**: Fees for payouts in crypto - **Fiat off-ramp**: Fees for fiat currency transfers via off-ramp.    The returned fees represent the charges that would apply if the operation were executed immediately. Note that actual fees may vary over time based on your usage volume and applicable fee rates. 
 
 ### Example
 
@@ -1646,7 +1752,7 @@ apiInstance.paymentEstimateFee(opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **PaymentEstimateFeeRequest** | [**PaymentEstimateFeeRequest**](PaymentEstimateFeeRequest.md)| The request body to create a estimated fee request. | [optional] 
+ **PaymentEstimateFeeRequest** | [**PaymentEstimateFeeRequest**](PaymentEstimateFeeRequest.md)| The request body for fee estimation. | [optional] 
 
 ### Return type
 
@@ -1884,7 +1990,7 @@ Name | Type | Description  | Notes
 
 Update top-up address
 
-This operation updates the dedicated top-up address assigned to a specific payer under a merchant on a specified chain. 
+This operation updates the dedicated top-up address assigned to a specific payer under a merchant on a specified chain.  &lt;Note&gt;   You can update the top-up address for a given payer a maximum of 10 times. If you exceed this limit, the API request will return an error. &lt;/Note&gt; 
 
 ### Example
 

package/docs/PaymentEstimateFee.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token_id** | **String** | The ID of the cryptocurrency you want to OffRamp settle. | 
-**amount** | **String** | The OffRamp settlement amount.  | 
+**token_id** | **String** | The token ID for which fees will be calculated. | 
+**amount** | **String** | The transaction amount for which fees will be calculated. | 
 
 

package/docs/PaymentEstimateFee201Response.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**[PaymentEstimatedFee]**](PaymentEstimatedFee.md) |  | [optional] 
+**data** | [**[PaymentEstimatedFee]**](PaymentEstimatedFee.md) | A list of estimated fees for the requested operations. | [optional] 
 
 

package/docs/PaymentEstimateFeeRequest.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **fee_type** | [**PaymentFeeType**](PaymentFeeType.md) |  | [optional] 
-**estimate_fees** | [**[PaymentEstimateFee]**](PaymentEstimateFee.md) |  | 
+**estimate_fees** | [**[PaymentEstimateFee]**](PaymentEstimateFee.md) | A list of token IDs and amounts for which fees will be calculated. | 
 
 

package/docs/PaymentEstimatedFee.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token_id** | **String** | The ID of the cryptocurrency you want to payment. | 
-**amount** | **String** | The payment amount.  | 
+**token_id** | **String** | The token ID for which fees will be calculated. | 
+**amount** | **String** | The transaction amount for which fees will be calculated. | 
 **commission_fee** | [**CommissionFee**](CommissionFee.md) |  | [optional] 
 **bridging_fee** | [**BridgingFee**](BridgingFee.md) |  | [optional] 
 **otc_fee** | [**OtcFee**](OtcFee.md) |  | [optional] 

package/docs/PaymentOrderEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
 **order_id** | **String** | The order ID. | 
 **merchant_id** | **String** | The merchant ID. | [optional] 
 **token_id** | **String** |  The ID of the cryptocurrency used for payment. Supported tokens:  - 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`  | 
@@ -24,6 +24,7 @@ Name | Type | Description | Notes
 **updated_timestamp** | **Number** | The last update time of the order, represented as a UNIX timestamp in seconds. | [optional] 
 **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the pay-in process. | [optional] 
 **settlement_status** | [**SettleStatus**](SettleStatus.md) |  | [optional] 
+**amount_tolerance** | **String** | The maximum allowed deviation from the payable amount in the case of underpayment, specified as a positive value with up to one decimal place. If you provide more than one decimal place, an error will occur.  When the actual received amount is within this deviation (inclusive) of the payable amount, the order status will be set to `Completed` rather than `Underpaid`.  | [optional] 
 
 
 
@@ -62,6 +63,8 @@ Name | Type | Description | Notes
 
 * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
 
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentRefundEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
 **request_id** | **String** | The request ID provided by you when creating the refund request. | [optional] 
 **refund_id** | **String** | The refund order ID. | 
 **order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional] 
@@ -61,6 +61,8 @@ Name | Type | Description | Notes
 
 * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
 
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/PaymentSettlementEvent.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. | 
 **settlement_request_id** | **String** | The settlement request ID generated by Cobo. | 
 **request_id** | **String** | The request ID provided by you when creating the settlement request. | 
 **status** | [**SettleRequestStatus**](SettleRequestStatus.md) |  | 
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **acquiring_type** | [**AcquiringType**](AcquiringType.md) |  | [optional] 
 **payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
 **settlement_type** | [**SettlementType**](SettlementType.md) |  | [optional] 
-**currency** | **String** | The fiat currency for the settlement request. | [optional] 
-**received_amount_fiat** | **String** | The received fiat amount of this settlement request.  | [optional] 
+**currency** | **String** | The fiat currency for the off-ramp. | [optional] 
+**received_amount_fiat** | **String** | The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. | [optional] 
 **bank_account** | [**BankAccount**](BankAccount.md) |  | [optional] 
 
 
@@ -56,6 +56,8 @@ Name | Type | Description | Notes
 
 * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
 
+* `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)