@cobo/cobo-waas2 1.23.0 → 1.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. package/README.md +68 -6
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AddressBooksApi.js +6 -6
  4. package/dist/api/ComplianceApi.js +132 -2
  5. package/dist/api/DevelopersWebhooksApi.js +2 -2
  6. package/dist/api/FeeStationApi.js +47 -4
  7. package/dist/api/PaymentApi.js +246 -56
  8. package/dist/api/SwapsApi.js +374 -0
  9. package/dist/api/TransactionsApi.js +4 -4
  10. package/dist/index.js +336 -14
  11. package/dist/model/AddressInfo.js +13 -0
  12. package/dist/model/AddressesEventData.js +8 -3
  13. package/dist/model/AddressesEventDataAllOfAddresses.js +18 -0
  14. package/dist/model/BalanceUpdateInfoEventData.js +8 -3
  15. package/dist/model/BridgingFee.js +136 -0
  16. package/dist/model/ChainsEventData.js +8 -3
  17. package/dist/model/CommissionFee.js +110 -0
  18. package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
  19. package/dist/model/ComplianceKytScreeningsUpdateEventData.js +305 -0
  20. package/dist/model/ContractCallDestination.js +48 -8
  21. package/dist/model/ContractCallDestinationType.js +5 -0
  22. package/dist/model/CreateMerchantRequest.js +15 -8
  23. package/dist/model/CreateOrderLinkRequest.js +129 -0
  24. package/dist/model/CreatePaymentOrderRequest.js +27 -1
  25. package/dist/model/CreateRefundRequest.js +2 -2
  26. package/dist/model/CreateSettlement.js +3 -29
  27. package/dist/model/CreateSettlementRequestRequest.js +39 -0
  28. package/dist/model/CreateSwapActivityRequest.js +193 -0
  29. package/dist/model/CustodialTransferDestination.js +1 -1
  30. package/dist/model/EstimateContractCallFeeParams.js +1 -1
  31. package/dist/model/EstimateFeeParams.js +1 -1
  32. package/dist/model/EstimateTransferFeeParams.js +1 -1
  33. package/dist/model/EstimatedEvmEip1559Fee.js +1 -1
  34. package/dist/model/EstimatedEvmLegacyFee.js +1 -1
  35. package/dist/model/EstimatedFILFee.js +1 -1
  36. package/dist/model/EstimatedFixedFee.js +1 -1
  37. package/dist/model/EstimatedSOLFee.js +1 -1
  38. package/dist/model/EstimatedUtxoFee.js +1 -1
  39. package/dist/model/FeeStationCheckFeeStationUsage.js +186 -0
  40. package/dist/model/FeeStationCheckFeeStationUsageResponse.js +200 -0
  41. package/dist/model/FeeStationGasStationType.js +61 -0
  42. package/dist/model/FundsStatusType.js +111 -0
  43. package/dist/model/KytScreeningsDecisionsType.js +71 -0
  44. package/dist/model/KytScreeningsEventData.js +155 -0
  45. package/dist/model/KytScreeningsReviewType.js +61 -0
  46. package/dist/model/KytScreeningsTransaction.js +144 -0
  47. package/dist/model/KytScreeningsTransactionType.js +61 -0
  48. package/dist/model/Link.js +125 -0
  49. package/dist/model/LinkDisplayInfo.js +100 -0
  50. package/dist/model/ListSwapActivities200Response.js +123 -0
  51. package/dist/model/ListSwapEnabledTokens200Response.js +123 -0
  52. package/dist/model/ListTopUpPayerAccounts200Response.js +123 -0
  53. package/dist/model/MPCVaultEventData.js +8 -3
  54. package/dist/model/Merchant.js +12 -3
  55. package/dist/model/MerchantBalance.js +3 -3
  56. package/dist/model/MessageSignDestination.js +8 -70
  57. package/dist/model/Order.js +13 -0
  58. package/dist/model/OrderLinkBusinessInfo.js +261 -0
  59. package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +125 -0
  60. package/dist/model/OtcFee.js +123 -0
  61. package/dist/model/PaymentAddressUpdateEventData.js +8 -3
  62. package/dist/model/PaymentEstimateFee.js +125 -0
  63. package/dist/model/PaymentEstimateFee201Response.js +108 -0
  64. package/dist/model/PaymentEstimateFeeRequest.js +137 -0
  65. package/dist/model/PaymentEstimatedFee.js +173 -0
  66. package/dist/model/PaymentFeeType.js +71 -0
  67. package/dist/model/PaymentOrderEventData.js +26 -3
  68. package/dist/model/PaymentRefundEventData.js +30 -5
  69. package/dist/model/PaymentSettlementEvent.js +70 -9
  70. package/dist/model/PaymentTransactionEventData.js +8 -3
  71. package/dist/model/PspBalance.js +3 -3
  72. package/dist/model/Refund.js +17 -1
  73. package/dist/model/ReviewStatusType.js +91 -0
  74. package/dist/model/SettleRequestStatus.js +5 -0
  75. package/dist/model/Settlement.js +45 -3
  76. package/dist/model/SettlementDetail.js +33 -1
  77. package/dist/model/SettlementInfo.js +7 -7
  78. package/dist/model/SolContractCallAddressLookupTableAccount.js +126 -0
  79. package/dist/model/SolContractCallDestination.js +30 -0
  80. package/dist/model/StellarContractCallContractParam.js +164 -0
  81. package/dist/model/StellarContractCallContractType.js +56 -0
  82. package/dist/model/StellarContractCallDestination.js +125 -0
  83. package/dist/model/StellarContractCallTrustLineOperationType.js +56 -0
  84. package/dist/model/StellarContractCallTrustLineParam.js +133 -0
  85. package/dist/model/SubmitKytResponse.js +122 -0
  86. package/dist/model/SubmitKytScreeningsDecisionsBody.js +122 -0
  87. package/dist/model/{RawMessageSignDestination.js → SubmitKytScreeningsReviewBody.js} +36 -36
  88. package/dist/model/SupportedToken.js +9 -0
  89. package/dist/model/SuspendedTokenEventData.js +8 -3
  90. package/dist/model/SwapActivity.js +9 -9
  91. package/dist/model/SwapActivityApprovers.js +1 -1
  92. package/dist/model/SwapActivityDetail.js +34 -18
  93. package/dist/model/SwapActivitySigners.js +2 -2
  94. package/dist/model/SwapActivityTimeline.js +5 -5
  95. package/dist/model/SwapEstimateFee.js +147 -0
  96. package/dist/model/SwapQuote.js +18 -31
  97. package/dist/model/SwapReceivingTransaction.js +133 -0
  98. package/dist/model/SwapToken.js +9 -9
  99. package/dist/model/TSSRequestWebhookEventData.js +8 -3
  100. package/dist/model/TokenListingEventData.js +8 -3
  101. package/dist/model/TokensEventData.js +8 -3
  102. package/dist/model/TransactionCoboCategory.js +5 -0
  103. package/dist/model/TransactionDestination.js +48 -8
  104. package/dist/model/TransactionDestinationType.js +5 -0
  105. package/dist/model/TransactionEvmEip1559Fee.js +1 -1
  106. package/dist/model/TransactionEvmLegacyFee.js +1 -1
  107. package/dist/model/TransactionFILFee.js +1 -1
  108. package/dist/model/TransactionFixedFee.js +1 -1
  109. package/dist/model/TransactionFuelingInfo.js +13 -0
  110. package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
  111. package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
  112. package/dist/model/TransactionRequestFILFee.js +1 -1
  113. package/dist/model/TransactionRequestSOLFee.js +1 -1
  114. package/dist/model/TransactionRequestUtxoFee.js +1 -1
  115. package/dist/model/TransactionSOLFee.js +1 -1
  116. package/dist/model/TransactionSolContractAddressLookupTableAccount.js +126 -0
  117. package/dist/model/TransactionSolContractDestination.js +30 -0
  118. package/dist/model/TransactionStellarContractParam.js +164 -0
  119. package/dist/model/TransactionStellarContractType.js +56 -0
  120. package/dist/model/{BTCEIP191MessageSignDestination.js → TransactionStellarDestination.js} +38 -35
  121. package/dist/model/TransactionStellarTrustLineOperationType.js +56 -0
  122. package/dist/model/TransactionStellarTrustLineParam.js +133 -0
  123. package/dist/model/TransactionUtxoFee.js +1 -1
  124. package/dist/model/TransactionWebhookEventData.js +8 -3
  125. package/dist/model/UpdateBankAccountByIdRequest.js +108 -0
  126. package/dist/model/UpdateTopUpAddress.js +4 -6
  127. package/dist/model/WalletInfoEventData.js +8 -3
  128. package/dist/model/WalletSetup.js +66 -0
  129. package/dist/model/WebhookEventData.js +81 -11
  130. package/dist/model/WebhookEventDataType.js +7 -2
  131. package/dist/model/WebhookEventType.js +10 -0
  132. package/docs/AddressBooksApi.md +3 -3
  133. package/docs/AddressInfo.md +1 -0
  134. package/docs/AddressesEventData.md +3 -1
  135. package/docs/AddressesEventDataAllOfAddresses.md +1 -0
  136. package/docs/BalanceUpdateInfoEventData.md +3 -1
  137. package/docs/BridgingFee.md +11 -0
  138. package/docs/ChainsEventData.md +3 -1
  139. package/docs/CommissionFee.md +9 -0
  140. package/docs/ComplianceApi.md +158 -1
  141. package/docs/ComplianceDispositionUpdateEventData.md +3 -1
  142. package/docs/ComplianceKytScreeningsUpdateEventData.md +57 -0
  143. package/docs/ContractCallDestination.md +2 -0
  144. package/docs/ContractCallDestinationType.md +2 -0
  145. package/docs/CreateMerchantRequest.md +3 -2
  146. package/docs/CreateOrderLinkRequest.md +10 -0
  147. package/docs/CreatePaymentOrderRequest.md +3 -1
  148. package/docs/CreateRefundRequest.md +2 -2
  149. package/docs/CreateSettlement.md +2 -4
  150. package/docs/CreateSettlementRequestRequest.md +3 -0
  151. package/docs/CreateSwapActivityRequest.md +15 -0
  152. package/docs/DevelopersWebhooksApi.md +1 -1
  153. package/docs/EstimateContractCallFeeParams.md +1 -1
  154. package/docs/EstimateFeeParams.md +1 -1
  155. package/docs/EstimateTransferFeeParams.md +1 -1
  156. package/docs/FeeStationApi.md +53 -0
  157. package/docs/FeeStationCheckFeeStationUsage.md +14 -0
  158. package/docs/FeeStationCheckFeeStationUsageResponse.md +16 -0
  159. package/docs/FeeStationGasStationType.md +12 -0
  160. package/docs/FundsStatusType.md +32 -0
  161. package/docs/KytScreeningsDecisionsType.md +16 -0
  162. package/docs/KytScreeningsEventData.md +13 -0
  163. package/docs/KytScreeningsReviewType.md +12 -0
  164. package/docs/KytScreeningsTransaction.md +12 -0
  165. package/docs/KytScreeningsTransactionType.md +12 -0
  166. package/docs/Link.md +10 -0
  167. package/docs/LinkDisplayInfo.md +10 -0
  168. package/docs/ListSwapActivities200Response.md +10 -0
  169. package/docs/ListSwapEnabledTokens200Response.md +10 -0
  170. package/docs/ListTopUpPayerAccounts200Response.md +10 -0
  171. package/docs/MPCVaultEventData.md +3 -1
  172. package/docs/Merchant.md +3 -2
  173. package/docs/MerchantBalance.md +3 -3
  174. package/docs/MessageSignDestination.md +0 -1
  175. package/docs/Order.md +1 -0
  176. package/docs/OrderLinkBusinessInfo.md +19 -0
  177. package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +10 -0
  178. package/docs/OtcFee.md +10 -0
  179. package/docs/PaymentAddressUpdateEventData.md +3 -1
  180. package/docs/PaymentApi.md +253 -25
  181. package/docs/PaymentEstimateFee.md +10 -0
  182. package/docs/PaymentEstimateFee201Response.md +9 -0
  183. package/docs/PaymentEstimateFeeRequest.md +10 -0
  184. package/docs/PaymentEstimatedFee.md +13 -0
  185. package/docs/PaymentFeeType.md +16 -0
  186. package/docs/PaymentOrderEventData.md +4 -1
  187. package/docs/PaymentRefundEventData.md +5 -2
  188. package/docs/PaymentSettlementEvent.md +9 -4
  189. package/docs/PaymentTransactionEventData.md +3 -1
  190. package/docs/PspBalance.md +3 -3
  191. package/docs/Refund.md +2 -1
  192. package/docs/ReviewStatusType.md +24 -0
  193. package/docs/SettleRequestStatus.md +2 -0
  194. package/docs/Settlement.md +6 -3
  195. package/docs/SettlementDetail.md +3 -1
  196. package/docs/SettlementInfo.md +6 -6
  197. package/docs/SolContractCallAddressLookupTableAccount.md +10 -0
  198. package/docs/SolContractCallDestination.md +1 -0
  199. package/docs/StellarContractCallContractParam.md +11 -0
  200. package/docs/StellarContractCallContractType.md +10 -0
  201. package/docs/StellarContractCallDestination.md +10 -0
  202. package/docs/StellarContractCallTrustLineOperationType.md +10 -0
  203. package/docs/StellarContractCallTrustLineParam.md +11 -0
  204. package/docs/SubmitKytResponse.md +10 -0
  205. package/docs/SubmitKytScreeningsDecisionsBody.md +10 -0
  206. package/docs/SubmitKytScreeningsReviewBody.md +10 -0
  207. package/docs/SupportedToken.md +1 -0
  208. package/docs/SuspendedTokenEventData.md +3 -1
  209. package/docs/SwapActivity.md +9 -9
  210. package/docs/SwapActivityDetail.md +10 -9
  211. package/docs/SwapActivitySigners.md +1 -1
  212. package/docs/SwapActivityTimeline.md +3 -3
  213. package/docs/SwapEstimateFee.md +12 -0
  214. package/docs/SwapQuote.md +10 -11
  215. package/docs/SwapReceivingTransaction.md +11 -0
  216. package/docs/SwapToken.md +6 -6
  217. package/docs/SwapsApi.md +356 -0
  218. package/docs/TSSRequestWebhookEventData.md +3 -1
  219. package/docs/TokenListingEventData.md +3 -1
  220. package/docs/TokensEventData.md +3 -1
  221. package/docs/TransactionCoboCategory.md +2 -0
  222. package/docs/TransactionDestination.md +2 -0
  223. package/docs/TransactionDestinationType.md +2 -0
  224. package/docs/TransactionFuelingInfo.md +1 -0
  225. package/docs/TransactionSolContractAddressLookupTableAccount.md +10 -0
  226. package/docs/TransactionSolContractDestination.md +1 -0
  227. package/docs/TransactionStellarContractParam.md +11 -0
  228. package/docs/TransactionStellarContractType.md +10 -0
  229. package/docs/TransactionStellarDestination.md +10 -0
  230. package/docs/TransactionStellarTrustLineOperationType.md +10 -0
  231. package/docs/TransactionStellarTrustLineParam.md +11 -0
  232. package/docs/TransactionWebhookEventData.md +3 -1
  233. package/docs/TransactionsApi.md +2 -2
  234. package/docs/UpdateBankAccountByIdRequest.md +9 -0
  235. package/docs/UpdateTopUpAddress.md +1 -1
  236. package/docs/WalletInfoEventData.md +3 -1
  237. package/docs/WalletSetup.md +14 -0
  238. package/docs/WebhookEventData.md +12 -3
  239. package/docs/WebhookEventDataType.md +3 -1
  240. package/docs/WebhookEventType.md +4 -0
  241. package/package.json +1 -1
  242. package/docs/BTCEIP191MessageSignDestination.md +0 -10
  243. package/docs/RawMessageSignDestination.md +0 -10
@@ -0,0 +1,57 @@
1
+ # CoboWaas2.ComplianceKytScreeningsUpdateEventData
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **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. |
8
+ **transaction_id** | **String** | The transaction ID. |
9
+ **transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) | |
10
+ **review_status** | [**ReviewStatusType**](ReviewStatusType.md) | |
11
+ **funds_status** | [**FundsStatusType**](FundsStatusType.md) | |
12
+ **updated_timestamp** | **Number** | The time when the KYT screening information was updated, in Unix timestamp format, measured in milliseconds. |
13
+
14
+
15
+
16
+ ## Enum: DataTypeEnum
17
+
18
+
19
+ * `Transaction` (value: `"Transaction"`)
20
+
21
+ * `TSSRequest` (value: `"TSSRequest"`)
22
+
23
+ * `Addresses` (value: `"Addresses"`)
24
+
25
+ * `WalletInfo` (value: `"WalletInfo"`)
26
+
27
+ * `MPCVault` (value: `"MPCVault"`)
28
+
29
+ * `Chains` (value: `"Chains"`)
30
+
31
+ * `Tokens` (value: `"Tokens"`)
32
+
33
+ * `TokenListing` (value: `"TokenListing"`)
34
+
35
+ * `PaymentOrder` (value: `"PaymentOrder"`)
36
+
37
+ * `PaymentRefund` (value: `"PaymentRefund"`)
38
+
39
+ * `PaymentSettlement` (value: `"PaymentSettlement"`)
40
+
41
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
42
+
43
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
44
+
45
+ * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
46
+
47
+ * `SuspendedToken` (value: `"SuspendedToken"`)
48
+
49
+ * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
50
+
51
+ * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
52
+
53
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
54
+
55
+
56
+
57
+
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
9
9
  **value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
10
10
  **calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters. |
11
11
  **instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
12
+ **address_lookup_table_accounts** | [**[SolContractCallAddressLookupTableAccount]**](SolContractCallAddressLookupTableAccount.md) | | [optional]
13
+ **contract_param** | [**StellarContractCallContractParam**](StellarContractCallContractParam.md) | |
12
14
 
13
15
 
@@ -7,6 +7,8 @@
7
7
 
8
8
  * `SOL_Contract` (value: `"SOL_Contract"`)
9
9
 
10
+ * `STELLAR_Contract` (value: `"STELLAR_Contract"`)
11
+
10
12
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
13
 
12
14
 
@@ -5,7 +5,8 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | The merchant name. |
8
- **wallet_id** | **String** | The ID of the wallet linked to the merchant. |
9
- **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]
8
+ **wallet_id** | **String** | This field has been deprecated. | [optional]
9
+ **developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. For more information on developer fee rate, please refer to [Amounts and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). | [optional]
10
+ **wallet_setup** | [**WalletSetup**](WalletSetup.md) | | [optional]
10
11
 
11
12
 
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.CreateOrderLinkRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **business_info** | [**OrderLinkBusinessInfo**](OrderLinkBusinessInfo.md) | |
8
+ **display_info** | [**LinkDisplayInfo**](LinkDisplayInfo.md) | | [optional]
9
+
10
+
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
12
12
  **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters. | [optional]
13
13
  **psp_order_code** | **String** | A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters. |
14
14
  **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]
15
- **use_dedicated_address** | **Boolean** | 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. | [optional]
15
+ **use_dedicated_address** | **Boolean** | This field has been deprecated. | [optional]
16
+ **custom_exchange_rate** | **String** | A custom exchange rate that defines how much fiat currency equals 1 unit of cryptocurrency. If not provided, the system's default exchange rate will be used. For example, if the fiat currency is USD and the cryptocurrency is USDT, setting `custom_exchange_rate` to `\"0.99\"` means that 1 USDT will be valued at 0.99 USD. | [optional]
17
+ **amount_tolerance** | **String** | Allowed amount deviation, precision to 1 decimal place. | [optional]
16
18
 
17
19
 
@@ -11,8 +11,8 @@ Name | Type | Description | Notes
11
11
  **token_id** | **String** | The ID of the cryptocurrency used for refund. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
12
12
  **refund_type** | [**RefundType**](RefundType.md) | |
13
13
  **order_id** | **String** | The ID of the original pay-in order associated with this refund. Use this to track refunds against specific payments. | [optional]
14
- **charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified. | [optional]
15
- **merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. Required when `charge_merchant_fee` is `true`. Must be: - A positive integer with up to two decimal places. - Less than the refund amount | [optional]
14
+ **charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified. | [optional]
15
+ **merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances). This field is required when `charge_merchant_fee` is `true`. Must be: - A positive integer with up to two decimal places. - Less than the refund amount | [optional]
16
16
  **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. It must be the same as `token_id`. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
17
17
 
18
18
 
@@ -5,11 +5,9 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **merchant_id** | **String** | The merchant ID. Specify this field when `settlement_type` is set to `Merchant`. | [optional]
8
- **token_id** | **String** | The ID of the cryptocurrency you want to settle. Specify this field when `payout_channel` is set to `Crypto`. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
9
- **currency** | **String** | The fiat currency for settling the cryptocurrency. Currently, only `USD` is supported. Specify this field when `payout_channel` is set to `OffRamp`. | [optional]
8
+ **token_id** | **String** | The ID of the cryptocurrency you want to settle. Specify this field when `payout_channel` is set to `Crypto`. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
10
9
  **amount** | **String** | The amount of cryptocurrency to be settled. When settling merchant balance from orders (`acquiring_type` is `Order` and `settlement_type` is `Merchant`), do not specify this field as the amount will be automatically calculated based on the order amounts. | [optional]
11
- **bank_account_id** | **String** | The ID of the bank account where the settled funds will be deposited. This field is only applicable when `payout_channel` is set to `OffRamp`. Call [List all bank accounts](/v2/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts. | [optional]
12
- **crypto_address_id** | **String** | The ID of the crypto address used for crypto withdrawal. Specify this field when `payout_channel` is set to `Crypto`. Call [List all crypto addresses](/v2/api-references/payments/list-all-crypto-addresses) to retrieve registered crypto addresses. | [optional]
10
+ **crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. Specify this field when `payout_channel` is set to `Crypto`. Call [List crypto addresses](https://www.cobo.com/developers/v2/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses. | [optional]
13
11
  **order_ids** | **[String]** | | [optional]
14
12
 
15
13
 
@@ -9,5 +9,8 @@ Name | Type | Description | Notes
9
9
  **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
10
10
  **settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
11
11
  **settlements** | [**[CreateSettlement]**](CreateSettlement.md) | |
12
+ **bank_account_id** | **String** | The ID of the bank account where the funds will be deposited. You can call [List all bank accounts](https://www.cobo.com/developers/v2/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts. This field is only applicable for off-ramp. | [optional]
13
+ **currency** | **String** | The fiat currency to receive after off-ramping. Currently, only `USD` is supported. Specify this field when `payout_channel` is set to `OffRamp`. | [optional]
14
+ **remark** | **String** | The remark for the payout request. | [optional]
12
15
 
13
16
 
@@ -0,0 +1,15 @@
1
+ # CoboWaas2.CreateSwapActivityRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **wallet_id** | **String** | The ID of the wallet used to pay. |
8
+ **address** | **String** | The address of the wallet used to pay. | [optional]
9
+ **quote_id** | **String** | The unique identifier of the swap quote. |
10
+ **app_initiator** | **String** | The initiator of the swap activity. It is optional and defaults to your API key if not specified. | [optional]
11
+ **request_id** | **String** | The request ID of the swap activity. | [optional]
12
+ **receiver_address** | **String** | The destination address of the swap activity. This property is required only when the swap type is `Bridge` and the wallet is not a Custodial Wallet (Asset Wallet). | [optional]
13
+ **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
14
+
15
+
@@ -457,7 +457,7 @@ Name | Type | Description | Notes
457
457
 
458
458
  Trigger test event
459
459
 
460
- This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload.
460
+ This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload. <Note>Currently, you can only trigger test webhook events with the event data types `Transaction` and `TSSRequest`.</Note>
461
461
 
462
462
  ### Example
463
463
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
7
+ **request_id** | **String** | The request ID that is used to track a transaction request. | [optional]
8
8
  **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
9
9
  **chain_id** | **String** | The chain ID of the chain on which the smart contract is issued. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). |
10
10
  **source** | [**ContractCallSource**](ContractCallSource.md) | |
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
7
+ **request_id** | **String** | The request ID that is used to track a transaction request. | [optional]
8
8
  **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
9
9
  **source** | [**ContractCallSource**](ContractCallSource.md) | |
10
10
  **token_id** | **String** | The token ID of the transferred token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
7
+ **request_id** | **String** | The request ID that is used to track a transaction request. | [optional]
8
8
  **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
9
9
  **source** | [**TransferSource**](TransferSource.md) | |
10
10
  **token_id** | **String** | The token ID of the transferred token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**checkFeeStationUsage**](FeeStationApi.md#checkFeeStationUsage) | **POST** /fee_station/check_fee_station_usage | Check Fee Station usage
7
8
  [**estimateFeeStationFee**](FeeStationApi.md#estimateFeeStationFee) | **POST** /fee_station/transactions/estimate_fee | Estimate fee for Fee Station transaction
8
9
  [**getFeeStationTransactionById**](FeeStationApi.md#getFeeStationTransactionById) | **GET** /fee_station/transactions/{transaction_id} | Get Fee Station transaction information
9
10
  [**listFeeStationAddresses**](FeeStationApi.md#listFeeStationAddresses) | **GET** /fee_station/addresses | List Fee Station addresses
@@ -12,6 +13,58 @@ Method | HTTP request | Description
12
13
 
13
14
 
14
15
 
16
+ ## checkFeeStationUsage
17
+
18
+ > FeeStationCheckFeeStationUsageResponse checkFeeStationUsage(opts)
19
+
20
+ Check Fee Station usage
21
+
22
+ This operation evaluates Fee Station usage for the current transaction. It determines whether Fee station can be used, checks if the Fee Station balance is sufficient, and returns a breakdown of the amounts involved, including any portion that must be covered by the user or sponsored in USDT (U).
23
+
24
+ ### Example
25
+
26
+ ```javascript
27
+ const CoboWaas2 = require('@cobo/cobo-waas2');
28
+ // Initialize the API client
29
+ const apiClient = CoboWaas2.ApiClient.instance
30
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
31
+ apiClient.setEnv(CoboWaas2.Env.DEV);
32
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
33
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
34
+ // Call the API
35
+ const apiInstance = new CoboWaas2.FeeStationApi();
36
+ const opts = {
37
+ 'FeeStationCheckFeeStationUsage': new CoboWaas2.FeeStationCheckFeeStationUsage()
38
+ };
39
+ apiInstance.checkFeeStationUsage(opts).then((data) => {
40
+ console.log('API called successfully. Returned data: ' + data);
41
+ }, (error) => {
42
+ console.error(error);
43
+ });
44
+
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+
50
+ Name | Type | Description | Notes
51
+ ------------- | ------------- | ------------- | -------------
52
+ **FeeStationCheckFeeStationUsage** | [**FeeStationCheckFeeStationUsage**](FeeStationCheckFeeStationUsage.md)| The information for evaluating Fee Station usage. | [optional]
53
+
54
+ ### Return type
55
+
56
+ [**FeeStationCheckFeeStationUsageResponse**](FeeStationCheckFeeStationUsageResponse.md)
57
+
58
+ ### Authorization
59
+
60
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: application/json
65
+ - **Accept**: application/json
66
+
67
+
15
68
  ## estimateFeeStationFee
16
69
 
17
70
  > EstimatedFixedFee estimateFeeStationFee(opts)
@@ -0,0 +1,14 @@
1
+ # CoboWaas2.FeeStationCheckFeeStationUsage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. |
8
+ **amount** | **String** | The amount of tokens to be transferred in this request. |
9
+ **token_id** | **String** | The token ID of the transferred token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
10
+ **estimated_fee_amount** | **String** | The estimated transaction fee required for this transfer, before applying any Fee Station rules. |
11
+ **from_address** | **String** | The blockchain address that initiates the transfer. |
12
+ **from_wallet_id** | **String** | The wallet ID. |
13
+
14
+
@@ -0,0 +1,16 @@
1
+ # CoboWaas2.FeeStationCheckFeeStationUsageResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **token_id** | **String** | The token used to pay the gas fee for this specific transaction. You can retrieve the IDs of all supported tokens by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
8
+ **gas_station_type** | [**FeeStationGasStationType**](FeeStationGasStationType.md) | |
9
+ **is_fee_station_applicable** | **Boolean** | Indicates whether Fee Station is applied for this transfer request. |
10
+ **is_balance_sufficient** | **Boolean** | If Fee Station is used, indicates whether its balance is sufficient to cover the required gas fee. |
11
+ **balance** | **String** | The current token balance available in Fee Station. |
12
+ **total_fee_amount** | **String** | The total gas amount required for this transfer request. |
13
+ **is_sponsor_applicable** | **Boolean** | Indicates whether USDT (U) sponsorship is applied when Fee Station balance is insufficient. |
14
+ **sponsored_fee_amount** | **String** | The amount of gas fee sponsored by USDT (U) when applicable. |
15
+
16
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.FeeStationGasStationType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `FeeStation` (value: `"FeeStation"`)
7
+
8
+ * `CoboOperationStation` (value: `"CoboOperationStation"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+
@@ -0,0 +1,32 @@
1
+ # CoboWaas2.FundsStatusType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Frozen` (value: `"Frozen"`)
7
+
8
+ * `Refunding` (value: `"Refunding"`)
9
+
10
+ * `Refunded` (value: `"Refunded"`)
11
+
12
+ * `RefundFailed` (value: `"RefundFailed"`)
13
+
14
+ * `Unfreezing` (value: `"Unfreezing"`)
15
+
16
+ * `Unfrozen` (value: `"Unfrozen"`)
17
+
18
+ * `UnfreezingFailed` (value: `"UnfreezingFailed"`)
19
+
20
+ * `Isolating` (value: `"Isolating"`)
21
+
22
+ * `Isolated` (value: `"Isolated"`)
23
+
24
+ * `IsolationFailed` (value: `"IsolationFailed"`)
25
+
26
+ * `CoboDisposition` (value: `"CoboDisposition"`)
27
+
28
+ * `Normal` (value: `"Normal"`)
29
+
30
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
31
+
32
+
@@ -0,0 +1,16 @@
1
+ # CoboWaas2.KytScreeningsDecisionsType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Approval` (value: `"Approval"`)
7
+
8
+ * `ApprovalWithAlert` (value: `"ApprovalWithAlert"`)
9
+
10
+ * `Rejection` (value: `"Rejection"`)
11
+
12
+ * `ManualReview` (value: `"ManualReview"`)
13
+
14
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
15
+
16
+
@@ -0,0 +1,13 @@
1
+ # CoboWaas2.KytScreeningsEventData
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **transaction_id** | **String** | The transaction ID. |
8
+ **transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) | |
9
+ **review_status** | [**ReviewStatusType**](ReviewStatusType.md) | |
10
+ **funds_status** | [**FundsStatusType**](FundsStatusType.md) | |
11
+ **updated_timestamp** | **Number** | The time when the KYT screening information was updated, in Unix timestamp format, measured in milliseconds. |
12
+
13
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.KytScreeningsReviewType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Approval` (value: `"Approval"`)
7
+
8
+ * `Rejection` (value: `"Rejection"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.KytScreeningsTransaction
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **transaction_id** | **String** | The UUID of the transaction that was screened. |
8
+ **transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) | |
9
+ **review_status** | [**ReviewStatusType**](ReviewStatusType.md) | |
10
+ **funds_status** | [**FundsStatusType**](FundsStatusType.md) | |
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.KytScreeningsTransactionType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Deposit` (value: `"Deposit"`)
7
+
8
+ * `Withdrawal` (value: `"Withdrawal"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+
package/docs/Link.md ADDED
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.Link
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **url** | **String** | The base URL of the payment page. This URL should be combined with the token parameter to form the complete payment link. Example: &#x60;https://checkout.cobo.com/payment&#x60; |
8
+ **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: &#x60;[url]?token&#x3D;[token]&#x60; |
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.LinkDisplayInfo
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **developer_name** | **String** | Optional display name for the developer/platform. This name may be shown to end users during the payment process. | [optional]
8
+ **logo** | **String** | Optional URL to the developer&#39;s logo image. The logo may be displayed to end users during the payment process. Supported formats: PNG, JPG, SVG. Maximum file size: 2MB. | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.ListSwapActivities200Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**[SwapActivity]**](SwapActivity.md) | | [optional]
8
+ **pagination** | [**Pagination**](Pagination.md) | | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.ListSwapEnabledTokens200Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**[SwapToken]**](SwapToken.md) | | [optional]
8
+ **pagination** | [**Pagination**](Pagination.md) | | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.ListTopUpPayerAccounts200Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**[PayerAccount]**](PayerAccount.md) | | [optional]
8
+ **pagination** | [**Pagination**](Pagination.md) | | [optional]
9
+
10
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. |
7
+ **data_type** | **String** | The data type of the event. - &#x60;Transaction&#x60;: The transaction event data. - &#x60;TSSRequest&#x60;: The TSS request event data. - &#x60;Addresses&#x60;: The addresses event data. - &#x60;WalletInfo&#x60;: The wallet information event data. - &#x60;MPCVault&#x60;: The MPC vault event data. - &#x60;Chains&#x60;: The enabled chain event data. - &#x60;Tokens&#x60;: The enabled token event data. - &#x60;TokenListing&#x60;: The token listing event data. - &#x60;PaymentOrder&#x60;: The payment order event data. - &#x60;PaymentRefund&#x60;: The payment refund event data. - &#x60;PaymentSettlement&#x60;: The payment settlement event data. - &#x60;PaymentTransaction&#x60;: The payment transaction event data. - &#x60;PaymentAddressUpdate&#x60;: The top-up address update event data. - &#x60;BalanceUpdateInfo&#x60;: The balance update event data. - &#x60;SuspendedToken&#x60;: The token suspension event data. - &#x60;ComplianceDisposition&#x60;: The compliance disposition event data. - &#x60;ComplianceKytScreenings&#x60;: The compliance KYT screenings event data. |
8
8
  **vault_id** | **String** | The vault ID. | [optional]
9
9
  **project_id** | **String** | The project ID. | [optional]
10
10
  **name** | **String** | The vault name. | [optional]
@@ -49,6 +49,8 @@ Name | Type | Description | Notes
49
49
 
50
50
  * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
51
51
 
52
+ * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
53
+
52
54
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
53
55
 
54
56
 
package/docs/Merchant.md CHANGED
@@ -6,8 +6,9 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **merchant_id** | **String** | The merchant ID. |
8
8
  **name** | **String** | The merchant name. |
9
- **wallet_id** | **String** | The ID of the linked wallet. |
10
- **developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \&quot;0.1\&quot; 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]
9
+ **wallet_id** | **String** | This field has been deprecated. |
10
+ **developer_fee_rate** | **String** | The developer fee rate applied to this merchant. | [optional]
11
+ **wallet_setup** | [**WalletSetup**](WalletSetup.md) | | [optional]
11
12
  **created_timestamp** | **Number** | The creation time of the merchant, represented as a UNIX timestamp in seconds. | [optional]
12
13
  **updated_timestamp** | **Number** | The last update time of the merchant, represented as a UNIX timestamp in seconds. | [optional]
13
14
 
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
8
8
  **token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format &#x60;{CHAIN}_{TOKEN}&#x60;. |
9
9
  **acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
10
10
  **total_received_amount** | **String** | The total amount of the token that has been received by the merchant. | [optional]
11
- **settled_amount** | **String** | The total amount of the token that has been settled from the merchant&#39;s balance. | [optional]
11
+ **settled_amount** | **String** | The total amount of the token that has been paid out from the merchant&#39;s balance. | [optional]
12
12
  **refunded_amount** | **String** | The total amount of the token that has been refunded from the merchant&#39;s balance. | [optional]
13
- **total_balance** | **String** | The total balance of the token for the merchant. | [optional]
14
- **available_balance** | **String** | The balance available for settlement or refund, in the specified cryptocurrency. | [optional]
13
+ **total_balance** | **String** | The total balance of the token available for payout or refund for the merchant. &#x60;total_balance&#x60; &#x3D; &#x60;total_received_amount&#x60; - &#x60;settled_amount&#x60; - &#x60;refunded_amount&#x60; For more information, please refer to [Amounts and Balances](/v2_cn/payments/amounts-and-balances) | [optional]
14
+ **available_balance** | **String** | This field has been deprecated. | [optional]
15
15
 
16
16
 
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
7
7
  **destination_type** | [**MessageSignDestinationType**](MessageSignDestinationType.md) | |
8
8
  **message** | **String** | The raw data of the message to be signed, encoded in Base64 format. |
9
9
  **structured_data** | **{String: Object}** | The structured data to be signed, formatted as a JSON object according to the EIP-712 standard. |
10
- **msg_hash** | **String** | Message hash to be signed, in hexadecimal format. |
11
10
  **message_bip137** | **String** | Message to be signed, in hexadecimal format. |
12
11
  **message_bip322** | **String** | Message to be signed, in hexadecimal format. |
13
12
  **message_cosmos_adr36** | **String** | Message to be signed, in hexadecimal format. |
package/docs/Order.md CHANGED
@@ -23,5 +23,6 @@ Name | Type | Description | Notes
23
23
  **updated_timestamp** | **Number** | The last update time of the order, represented as a UNIX timestamp in seconds. | [optional]
24
24
  **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]
25
25
  **settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
26
+ **amount_tolerance** | **String** | Allowed amount deviation. | [optional]
26
27
 
27
28
 
@@ -0,0 +1,19 @@
1
+ # CoboWaas2.OrderLinkBusinessInfo
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **token_ids** | **[String]** | List of supported cryptocurrency token IDs for this payment. Each token ID must be from the supported values. |
8
+ **custom_exchange_rates** | [**[OrderLinkBusinessInfoCustomExchangeRatesInner]**](OrderLinkBusinessInfoCustomExchangeRatesInner.md) | Optional list of final exchange rates for different tokens. If provided, these rates will be used instead of real-time market rates. | [optional]
9
+ **currency** | **String** | The currency for the base order amount and the developer fee. Currently, only &#x60;USD&#x60;/&#x60;USDT&#x60;/&#x60;USDC&#x60; are supported. |
10
+ **fee_amount** | **String** | The developer fee for the order, in the currency specified by &#x60;currency&#x60;. If &#x60;currency&#x60; is not specified, the fee is in the cryptocurrency specified by &#x60;token_id&#x60;. If you are a merchant directly serving payers, set this field to &#x60;0&#x60;. 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 (&#x60;order_amount&#x60;) to determine the final charge. For example: - Base amount (&#x60;order_amount&#x60;): \&quot;100.00\&quot; - Developer fee (&#x60;fee_amount&#x60;): \&quot;2.00\&quot; - Total charged to customer: \&quot;102.00\&quot; Values can contain up to two decimal places. |
11
+ **merchant_id** | **String** | The merchant ID. |
12
+ **order_amount** | **String** | The base amount of the order, excluding the developer fee (specified in &#x60;fee_amount&#x60;), in the currency specified by &#x60;currency&#x60;. If &#x60;currency&#x60; is not specified, the amount is in the cryptocurrency specified by &#x60;token_id&#x60;. Values must be greater than &#x60;0&#x60; and contain two decimal places. |
13
+ **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]
14
+ **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. |
15
+ **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 &#x60;1800&#x60;, 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 &#x60;received_token_amount&#x60; 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 &#x60;transactionLate&#x60; webhook event. | [optional] [default to 1800]
16
+ **use_dedicated_address** | **Boolean** | Whether to allocate a dedicated address for this order. - &#x60;true&#x60;: A dedicated address will be allocated for this order. - &#x60;false&#x60;: A shared address from the address pool will be used. | [optional]
17
+ **amount_tolerance** | **String** | Allowed amount deviation, precision to 1 decimal place. | [optional]
18
+
19
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.OrderLinkBusinessInfoCustomExchangeRatesInner
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **token_id** | **String** | The cryptocurrency token ID |
8
+ **exchange_rate** | **String** | The fixed exchange rate to use for this token |
9
+
10
+
package/docs/OtcFee.md ADDED
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.OtcFee
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **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 &#x3D; (Token Amount - Bridging Fee) × Exchange Rate Note: The actual fiat amount received may be lower due to additional bank transfer fees. |
8
+ **token_id** | **String** | The ID of the token you want to off-ramp. | [optional]
9
+
10
+