@cobo/cobo-waas2 1.28.0 → 1.29.0

package/dist/model/OrderLinkBusinessInfo.js

@@ -36,7 +36,7 @@ var OrderLinkBusinessInfo = /*#__PURE__*/function () {
    * @alias module:model/OrderLinkBusinessInfo
    * @param merchant_id {String} The merchant ID.
    * @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 fee_amount {String} The developer fee for the order, in the currency specified by `currency`. If `currency` is not specified, the fee is in the cryptocurrency specified by `token_id`.  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. 
+   * @param fee_amount {String} The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. 
    */
   function OrderLinkBusinessInfo(merchant_id, psp_order_code, fee_amount) {
     _classCallCheck(this, OrderLinkBusinessInfo);
@@ -251,31 +251,31 @@ OrderLinkBusinessInfo.prototype['merchant_order_code'] = undefined;
 OrderLinkBusinessInfo.prototype['psp_order_code'] = undefined;
 
 /**
- * The currency for the base order amount and the developer fee. Currently, only `USD`/`USDT`/`USDC` are supported. 
+ * The pricing currency that denominates `pricing_amount` and `fee_amount`. Currently, only `USD`/`USDT`/`USDC` are supported. This field is required. 
  * @member {String} pricing_currency
  */
 OrderLinkBusinessInfo.prototype['pricing_currency'] = undefined;
 
 /**
- * The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`. If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`.  Values must be greater than `0` and contain two decimal places. 
+ * The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. 
  * @member {String} pricing_amount
  */
 OrderLinkBusinessInfo.prototype['pricing_amount'] = undefined;
 
 /**
- * The developer fee for the order, in the currency specified by `currency`. If `currency` is not specified, the fee is in the cryptocurrency specified by `token_id`.  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. 
+ * The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. 
  * @member {String} fee_amount
  */
 OrderLinkBusinessInfo.prototype['fee_amount'] = undefined;
 
 /**
- * List of supported cryptocurrency token IDs for this payment. Each token ID must be from the supported values. 
+ * The IDs of the cryptocurrencies 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 {Array.<String>} payable_currencies
  */
 OrderLinkBusinessInfo.prototype['payable_currencies'] = undefined;
 
 /**
- * Optional list of payable amounts for different tokens. If provided, these amounts will be used instead of calculating the amounts based on the exchange rate. 
+ * The total amounts the payer needs to pay for each currency in `payable_currencies`. If this field is left blank, the system will automatically calculate the amounts at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate.  Values must be greater than 0 and contain two decimal places. 
  * @member {Array.<module:model/OrderLinkBusinessInfoPayableAmountsInner>} payable_amounts
  */
 OrderLinkBusinessInfo.prototype['payable_amounts'] = undefined;
@@ -288,37 +288,37 @@ OrderLinkBusinessInfo.prototype['payable_amounts'] = undefined;
 OrderLinkBusinessInfo.prototype['expired_in'] = 1800;
 
 /**
- * Allowed amount deviation, precision to 1 decimal place.
+ * The allowed amount deviation, with precision up to 1 decimal place.  For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) 
  * @member {String} amount_tolerance
  */
 OrderLinkBusinessInfo.prototype['amount_tolerance'] = undefined;
 
 /**
- * The currency for the base order amount and the developer fee. Currently, only `USD`/`USDT`/`USDC` are supported. 
+ * This field has been deprecated. Please use `pricing_currency` instead.
  * @member {String} currency
  */
 OrderLinkBusinessInfo.prototype['currency'] = undefined;
 
 /**
- * The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`. If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`.  Values must be greater than `0` and contain two decimal places. 
+ * This field has been deprecated. Please use `pricing_amount` instead.
  * @member {String} order_amount
  */
 OrderLinkBusinessInfo.prototype['order_amount'] = undefined;
 
 /**
- * List of supported cryptocurrency token IDs for this payment. Each token ID must be from the supported values. 
+ * This field has been deprecated. Please use `payable_currencies` instead. 
  * @member {Array.<String>} token_ids
  */
 OrderLinkBusinessInfo.prototype['token_ids'] = undefined;
 
 /**
- * Optional list of final exchange rates for different tokens. If provided, these rates will be used instead of real-time market rates. 
+ * This field has been deprecated. 
  * @member {Array.<module:model/OrderLinkBusinessInfoCustomExchangeRatesInner>} custom_exchange_rates
  */
 OrderLinkBusinessInfo.prototype['custom_exchange_rates'] = undefined;
 
 /**
- * Whether to allocate a dedicated address for this order.  - `true`: A dedicated address will be allocated for this order. - `false`: A shared address from the address pool will be used. 
+ * This field has been deprecated.
  * @member {Boolean} use_dedicated_address
  */
 OrderLinkBusinessInfo.prototype['use_dedicated_address'] = undefined;

package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js

@@ -32,8 +32,8 @@ var OrderLinkBusinessInfoCustomExchangeRatesInner = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>OrderLinkBusinessInfoCustomExchangeRatesInner</code>.
    * @alias module:model/OrderLinkBusinessInfoCustomExchangeRatesInner
-   * @param token_id {String} The cryptocurrency token ID
-   * @param exchange_rate {String} The fixed exchange rate to use for this token
+   * @param token_id {String} 
+   * @param exchange_rate {String} 
    */
   function OrderLinkBusinessInfoCustomExchangeRatesInner(token_id, exchange_rate) {
     _classCallCheck(this, OrderLinkBusinessInfoCustomExchangeRatesInner);
@@ -112,13 +112,11 @@ var OrderLinkBusinessInfoCustomExchangeRatesInner = /*#__PURE__*/function () {
 OrderLinkBusinessInfoCustomExchangeRatesInner.RequiredProperties = ["token_id", "exchange_rate"];
 
 /**
- * The cryptocurrency token ID
  * @member {String} token_id
  */
 OrderLinkBusinessInfoCustomExchangeRatesInner.prototype['token_id'] = undefined;
 
 /**
- * The fixed exchange rate to use for this token
  * @member {String} exchange_rate
  */
 OrderLinkBusinessInfoCustomExchangeRatesInner.prototype['exchange_rate'] = undefined;

package/dist/model/OrderLinkBusinessInfoPayableAmountsInner.js

@@ -32,8 +32,8 @@ var OrderLinkBusinessInfoPayableAmountsInner = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>OrderLinkBusinessInfoPayableAmountsInner</code>.
    * @alias module:model/OrderLinkBusinessInfoPayableAmountsInner
-   * @param token_id {String} The cryptocurrency token ID
-   * @param amount {String} The actual payable amount of the order in the cryptocurrency.
+   * @param token_id {String} 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` 
+   * @param amount {String} The payable amount in the specified currency.
    */
   function OrderLinkBusinessInfoPayableAmountsInner(token_id, amount) {
     _classCallCheck(this, OrderLinkBusinessInfoPayableAmountsInner);
@@ -112,13 +112,13 @@ var OrderLinkBusinessInfoPayableAmountsInner = /*#__PURE__*/function () {
 OrderLinkBusinessInfoPayableAmountsInner.RequiredProperties = ["token_id", "amount"];
 
 /**
- * The cryptocurrency token ID
+ * 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
  */
 OrderLinkBusinessInfoPayableAmountsInner.prototype['token_id'] = undefined;
 
 /**
- * The actual payable amount of the order in the cryptocurrency.
+ * The payable amount in the specified currency.
  * @member {String} amount
  */
 OrderLinkBusinessInfoPayableAmountsInner.prototype['amount'] = undefined;

package/dist/model/PaymentAddressUpdateEventData.js

@@ -34,7 +34,7 @@ var PaymentAddressUpdateEventData = /*#__PURE__*/function () {
    * Constructs a new <code>PaymentAddressUpdateEventData</code>.
    * @alias module:model/PaymentAddressUpdateEventData
    * @implements module:model/WebhookEventDataType
-   * @param data_type {module:model/PaymentAddressUpdateEventData.DataTypeEnum}  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. - `PaymentPayout`: The payment payout 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.
+   * @param data_type {module:model/PaymentAddressUpdateEventData.DataTypeEnum}  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
    * @param custom_payer_id {String} A unique identifier assigned by the developer to track and identify individual payers in their system.
    * @param payer_id {String} A unique identifier assigned by Cobo to track and identify individual payers.
    * @param chain {String} The chain ID.
@@ -152,7 +152,7 @@ var PaymentAddressUpdateEventData = /*#__PURE__*/function () {
 PaymentAddressUpdateEventData.RequiredProperties = ["data_type", "custom_payer_id", "payer_id", "chain", "previous_address", "updated_address"];
 
 /**
- *  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. - `PaymentPayout`: The payment payout 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.
+ *  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
  * @member {module:model/PaymentAddressUpdateEventData.DataTypeEnum} data_type
  */
 PaymentAddressUpdateEventData.prototype['data_type'] = undefined;
@@ -189,7 +189,7 @@ PaymentAddressUpdateEventData.prototype['updated_address'] = undefined;
 
 // Implement WebhookEventDataType interface:
 /**
- *  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. - `PaymentPayout`: The payment payout 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.
+ *  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -290,6 +290,11 @@ PaymentAddressUpdateEventData['DataTypeEnum'] = {
    * @const
    */
   "ComplianceKytScreenings": "ComplianceKytScreenings",
+  /**
+   * value: "ComplianceKyaScreenings"
+   * @const
+   */
+  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
   /**
    * value: "unknown_default_open_api"
    * @const

package/dist/model/PaymentAllocationAmount.js

@@ -33,7 +33,7 @@ var PaymentAllocationAmount = /*#__PURE__*/function () {
    * Constructs a new <code>PaymentAllocationAmount</code>.
    * @alias module:model/PaymentAllocationAmount
    * @param token_id {String} The ID of the cryptocurrency.
-   * @param allocation_amount {String} The allocation amount.
+   * @param allocation_amount {String} The available amount that can be allocated from the source account to the destination account for the given cryptocurrency.
    */
   function PaymentAllocationAmount(token_id, allocation_amount) {
     _classCallCheck(this, PaymentAllocationAmount);
@@ -118,7 +118,7 @@ PaymentAllocationAmount.RequiredProperties = ["token_id", "allocation_amount"];
 PaymentAllocationAmount.prototype['token_id'] = undefined;
 
 /**
- * The allocation amount.
+ * The available amount that can be allocated from the source account to the destination account for the given cryptocurrency.
  * @member {String} allocation_amount
  */
 PaymentAllocationAmount.prototype['allocation_amount'] = undefined;

package/dist/model/PaymentOrderEventData.js

@@ -39,13 +39,13 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
    * @alias module:model/PaymentOrderEventData
    * @implements module:model/WebhookEventDataType
    * @implements module:model/Order
-   * @param data_type {module:model/PaymentOrderEventData.DataTypeEnum}  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. - `PaymentPayout`: The payment payout 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.
+   * @param data_type {module:model/PaymentOrderEventData.DataTypeEnum}  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
    * @param order_id {String} The order 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.
+   * @param fee_amount {String} The developer fee for the order. It is added to the base amount to determine the final charge.
    * @param chain_id {String} The ID of the blockchain network where the payment transaction should be made.
    * @param payable_amount {String} The cryptocurrency amount to be paid for this order.
-   * @param exchange_rate {String} The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD.
+   * @param exchange_rate {String} The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`.    <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note> 
    * @param receive_address {String} The recipient wallet address to be used for the payment transaction.
    * @param status {module:model/OrderStatus} 
    * @param received_token_amount {String} The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT).
@@ -290,7 +290,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
 PaymentOrderEventData.RequiredProperties = ["data_type", "order_id", "psp_order_code", "fee_amount", "chain_id", "payable_amount", "exchange_rate", "receive_address", "status", "received_token_amount"];
 
 /**
- *  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. - `PaymentPayout`: The payment payout 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.
+ *  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
  * @member {module:model/PaymentOrderEventData.DataTypeEnum} data_type
  */
 PaymentOrderEventData.prototype['data_type'] = undefined;
@@ -320,19 +320,19 @@ PaymentOrderEventData.prototype['merchant_order_code'] = undefined;
 PaymentOrderEventData.prototype['psp_order_code'] = undefined;
 
 /**
- * The fiat currency of the order.
+ * The pricing currency of the order.
  * @member {String} pricing_currency
  */
 PaymentOrderEventData.prototype['pricing_currency'] = undefined;
 
 /**
- * The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`).
+ * The base amount of the order, excluding the developer fee (specified in `fee_amount`).
  * @member {String} pricing_amount
  */
 PaymentOrderEventData.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.
+ * The developer fee for the order. It is added to the base amount to determine the final charge.
  * @member {String} fee_amount
  */
 PaymentOrderEventData.prototype['fee_amount'] = undefined;
@@ -356,13 +356,13 @@ PaymentOrderEventData.prototype['chain_id'] = undefined;
 PaymentOrderEventData.prototype['payable_amount'] = undefined;
 
 /**
- * The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD.
+ * The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`.    <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note> 
  * @member {String} exchange_rate
  */
 PaymentOrderEventData.prototype['exchange_rate'] = undefined;
 
 /**
- * Allowed amount deviation.
+ * The allowed amount deviation, with precision up to 1 decimal place.  For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) 
  * @member {String} amount_tolerance
  */
 PaymentOrderEventData.prototype['amount_tolerance'] = undefined;
@@ -409,19 +409,19 @@ PaymentOrderEventData.prototype['updated_timestamp'] = undefined;
 PaymentOrderEventData.prototype['transactions'] = undefined;
 
 /**
- * The fiat currency of the order.
+ * This field has been deprecated. Please use `pricing_currency` instead.
  * @member {String} currency
  */
 PaymentOrderEventData.prototype['currency'] = undefined;
 
 /**
- * The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`).
+ * This field has been deprecated. Please use `pricing_amount` instead.
  * @member {String} order_amount
  */
 PaymentOrderEventData.prototype['order_amount'] = undefined;
 
 /**
- * The ID of the cryptocurrency used for payment.
+ * This field has been deprecated. Please use `payable_currency` instead.
  * @member {String} token_id
  */
 PaymentOrderEventData.prototype['token_id'] = undefined;
@@ -433,7 +433,7 @@ PaymentOrderEventData.prototype['settlement_status'] = undefined;
 
 // Implement WebhookEventDataType interface:
 /**
- *  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. - `PaymentPayout`: The payment payout 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.
+ *  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -459,17 +459,17 @@ _Order["default"].prototype['merchant_order_code'] = undefined;
  */
 _Order["default"].prototype['psp_order_code'] = undefined;
 /**
- * The fiat currency of the order.
+ * The pricing currency of the order.
  * @member {String} pricing_currency
  */
 _Order["default"].prototype['pricing_currency'] = undefined;
 /**
- * The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`).
+ * The base amount of the order, excluding the developer fee (specified in `fee_amount`).
  * @member {String} pricing_amount
  */
 _Order["default"].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.
+ * The developer fee for the order. It is added to the base amount to determine the final charge.
  * @member {String} fee_amount
  */
 _Order["default"].prototype['fee_amount'] = undefined;
@@ -489,12 +489,12 @@ _Order["default"].prototype['chain_id'] = undefined;
  */
 _Order["default"].prototype['payable_amount'] = undefined;
 /**
- * The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD.
+ * The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`.    <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note> 
  * @member {String} exchange_rate
  */
 _Order["default"].prototype['exchange_rate'] = undefined;
 /**
- * Allowed amount deviation.
+ * The allowed amount deviation, with precision up to 1 decimal place.  For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) 
  * @member {String} amount_tolerance
  */
 _Order["default"].prototype['amount_tolerance'] = undefined;
@@ -533,17 +533,17 @@ _Order["default"].prototype['updated_timestamp'] = undefined;
  */
 _Order["default"].prototype['transactions'] = undefined;
 /**
- * The fiat currency of the order.
+ * This field has been deprecated. Please use `pricing_currency` instead.
  * @member {String} currency
  */
 _Order["default"].prototype['currency'] = undefined;
 /**
- * The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`).
+ * This field has been deprecated. Please use `pricing_amount` instead.
  * @member {String} order_amount
  */
 _Order["default"].prototype['order_amount'] = undefined;
 /**
- * The ID of the cryptocurrency used for payment.
+ * This field has been deprecated. Please use `payable_currency` instead.
  * @member {String} token_id
  */
 _Order["default"].prototype['token_id'] = undefined;
@@ -648,6 +648,11 @@ PaymentOrderEventData['DataTypeEnum'] = {
    * @const
    */
   "ComplianceKytScreenings": "ComplianceKytScreenings",
+  /**
+   * value: "ComplianceKyaScreenings"
+   * @const
+   */
+  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
   /**
    * value: "unknown_default_open_api"
    * @const

package/dist/model/PaymentPayout.js

@@ -226,19 +226,19 @@ PaymentPayout.prototype['created_timestamp'] = undefined;
 PaymentPayout.prototype['updated_timestamp'] = undefined;
 
 /**
- * The initiator of this payout, usually the user's API key.
+ * The initiator of this payout, usually the API key used to create the payout.
  * @member {String} initiator
  */
 PaymentPayout.prototype['initiator'] = undefined;
 
 /**
- * The fiat currency for the payout.
+ * The fiat currency you will receive from the payout.
  * @member {String} currency
  */
 PaymentPayout.prototype['currency'] = undefined;
 
 /**
- * The actual amount of this payout. 
+ * The total amount of cryptocurrency actually paid out for this payout. 
  * @member {String} actual_payout_amount
  */
 PaymentPayout.prototype['actual_payout_amount'] = undefined;

package/dist/model/PaymentPayoutDetail.js

@@ -219,7 +219,7 @@ PaymentPayoutDetail.prototype['created_timestamp'] = undefined;
 PaymentPayoutDetail.prototype['updated_timestamp'] = undefined;
 
 /**
- * The initiator of this payout, usually the user's API key.
+ * The initiator of this payout, usually the API key used to create the payout.
  * @member {String} initiator
  */
 PaymentPayoutDetail.prototype['initiator'] = undefined;
@@ -230,13 +230,13 @@ PaymentPayoutDetail.prototype['initiator'] = undefined;
 PaymentPayoutDetail.prototype['payout_channel'] = undefined;
 
 /**
- * The fiat currency for the payout.
+ * The fiat currency you will receive from the payout.
  * @member {String} currency
  */
 PaymentPayoutDetail.prototype['currency'] = undefined;
 
 /**
- * The actual amount of this payout. 
+ * The total amount of cryptocurrency actually paid out for this payout. 
  * @member {String} actual_payout_amount
  */
 PaymentPayoutDetail.prototype['actual_payout_amount'] = undefined;

package/dist/model/PaymentPayoutEvent.js

@@ -40,7 +40,7 @@ var PaymentPayoutEvent = /*#__PURE__*/function () {
    * @alias module:model/PaymentPayoutEvent
    * @implements module:model/WebhookEventDataType
    * @implements module:model/PaymentPayoutDetail
-   * @param data_type {module:model/PaymentPayoutEvent.DataTypeEnum}  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. - `PaymentPayout`: The payment payout 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.
+   * @param data_type {module:model/PaymentPayoutEvent.DataTypeEnum}  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
    * @param payout_id {String} The payout ID generated by Cobo.
    * @param request_id {String} The request ID provided by you when creating the payout.
    * @param status {module:model/PaymentPayoutStatus} 
@@ -202,7 +202,7 @@ var PaymentPayoutEvent = /*#__PURE__*/function () {
 PaymentPayoutEvent.RequiredProperties = ["data_type", "payout_id", "request_id", "status"];
 
 /**
- *  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. - `PaymentPayout`: The payment payout 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.
+ *  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
  * @member {module:model/PaymentPayoutEvent.DataTypeEnum} data_type
  */
 PaymentPayoutEvent.prototype['data_type'] = undefined;
@@ -242,7 +242,7 @@ PaymentPayoutEvent.prototype['created_timestamp'] = undefined;
 PaymentPayoutEvent.prototype['updated_timestamp'] = undefined;
 
 /**
- * The initiator of this payout, usually the user's API key.
+ * The initiator of this payout, usually the API key used to create the payout.
  * @member {String} initiator
  */
 PaymentPayoutEvent.prototype['initiator'] = undefined;
@@ -253,13 +253,13 @@ PaymentPayoutEvent.prototype['initiator'] = undefined;
 PaymentPayoutEvent.prototype['payout_channel'] = undefined;
 
 /**
- * The fiat currency for the payout.
+ * The fiat currency you will receive from the payout.
  * @member {String} currency
  */
 PaymentPayoutEvent.prototype['currency'] = undefined;
 
 /**
- * The actual amount of this payout. 
+ * The total amount of cryptocurrency actually paid out for this payout. 
  * @member {String} actual_payout_amount
  */
 PaymentPayoutEvent.prototype['actual_payout_amount'] = undefined;
@@ -271,7 +271,7 @@ PaymentPayoutEvent.prototype['bank_account'] = undefined;
 
 // Implement WebhookEventDataType interface:
 /**
- *  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. - `PaymentPayout`: The payment payout 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.
+ *  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. - `PaymentPayout`: The payment payout 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -305,7 +305,7 @@ _PaymentPayoutDetail["default"].prototype['created_timestamp'] = undefined;
  */
 _PaymentPayoutDetail["default"].prototype['updated_timestamp'] = undefined;
 /**
- * The initiator of this payout, usually the user's API key.
+ * The initiator of this payout, usually the API key used to create the payout.
  * @member {String} initiator
  */
 _PaymentPayoutDetail["default"].prototype['initiator'] = undefined;
@@ -314,12 +314,12 @@ _PaymentPayoutDetail["default"].prototype['initiator'] = undefined;
  */
 _PaymentPayoutDetail["default"].prototype['payout_channel'] = undefined;
 /**
- * The fiat currency for the payout.
+ * The fiat currency you will receive from the payout.
  * @member {String} currency
  */
 _PaymentPayoutDetail["default"].prototype['currency'] = undefined;
 /**
- * The actual amount of this payout. 
+ * The total amount of cryptocurrency actually paid out for this payout. 
  * @member {String} actual_payout_amount
  */
 _PaymentPayoutDetail["default"].prototype['actual_payout_amount'] = undefined;
@@ -424,6 +424,11 @@ PaymentPayoutEvent['DataTypeEnum'] = {
    * @const
    */
   "ComplianceKytScreenings": "ComplianceKytScreenings",
+  /**
+   * value: "ComplianceKyaScreenings"
+   * @const
+   */
+  "ComplianceKyaScreenings": "ComplianceKyaScreenings",
   /**
    * value: "unknown_default_open_api"
    * @const

package/dist/model/PaymentPayoutItem.js

@@ -38,9 +38,9 @@ var PaymentPayoutItem = /*#__PURE__*/function () {
    * @alias module:model/PaymentPayoutItem
    * @param payout_item_id {String} The payout item ID generated by Cobo.
    * @param payout_id {String} The payout ID generated by Cobo.
-   * @param amount {String} The payout item token_id amount. 
+   * @param amount {String} The amount of the cryptocurrency to pay out. 
    * @param status {module:model/PaymentPayoutItemStatus} 
-   * @param source_account {String} 
+   * @param source_account {String} The source account from which the payout was made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. 
    */
   function PaymentPayoutItem(payout_item_id, payout_id, amount, status, source_account) {
     _classCallCheck(this, PaymentPayoutItem);
@@ -229,19 +229,19 @@ PaymentPayoutItem.prototype['payout_item_id'] = undefined;
 PaymentPayoutItem.prototype['payout_id'] = undefined;
 
 /**
- * The token id of the payout item.
+ * The ID of the cryptocurrency paid out.
  * @member {String} token_id
  */
 PaymentPayoutItem.prototype['token_id'] = undefined;
 
 /**
- * The ID of the blockchain network on which the payout item occurred.
+ * The ID of the blockchain network on which the payout occurred.
  * @member {String} chain_id
  */
 PaymentPayoutItem.prototype['chain_id'] = undefined;
 
 /**
- * The payout item token_id amount. 
+ * The amount of the cryptocurrency to pay out. 
  * @member {String} amount
  */
 PaymentPayoutItem.prototype['amount'] = undefined;
@@ -252,12 +252,13 @@ PaymentPayoutItem.prototype['amount'] = undefined;
 PaymentPayoutItem.prototype['status'] = undefined;
 
 /**
+ * The source account from which the payout was made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. 
  * @member {String} source_account
  */
 PaymentPayoutItem.prototype['source_account'] = undefined;
 
 /**
- * An array of transactions associated with this payout item request. Each transaction represents a separate blockchain operation related to the payout item process.
+ * An array of transactions associated with this payout item. Each transaction represents a separate blockchain operation related to the payout item process.
  * @member {Array.<module:model/PaymentTransaction>} transactions
  */
 PaymentPayoutItem.prototype['transactions'] = undefined;
@@ -275,7 +276,7 @@ PaymentPayoutItem.prototype['created_timestamp'] = undefined;
 PaymentPayoutItem.prototype['updated_timestamp'] = undefined;
 
 /**
- * Unique identifier for the pre-approved crypto address, used to reference the address securely in requests.
+ * The ID of the crypto address used for crypto payouts.
  * @member {String} crypto_address_id
  */
 PaymentPayoutItem.prototype['crypto_address_id'] = undefined;