@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
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
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. |
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
8
  **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
9
9
  **payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. |
10
10
  **chain** | **String** | The chain ID. |
@@ -48,6 +48,8 @@ Name | Type | Description | Notes
48
48
 
49
49
  * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
50
50
 
51
+ * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
52
+
51
53
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
52
54
 
53
55
 
@@ -8,6 +8,7 @@ Method | HTTP request | Description
8
8
  [**createCryptoAddress**](PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
9
9
  [**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
10
10
  [**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
11
+ [**createOrderLink**](PaymentApi.md#createOrderLink) | **POST** /payments/links/orders | Create order link
11
12
  [**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
12
13
  [**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
13
14
  [**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
@@ -31,7 +32,10 @@ Method | HTTP request | Description
31
32
  [**listPaymentWalletBalances**](PaymentApi.md#listPaymentWalletBalances) | **GET** /payments/balance/payment_wallets | List payment wallet balances
32
33
  [**listSettlementDetails**](PaymentApi.md#listSettlementDetails) | **GET** /payments/settlement_details | List all settlement details
33
34
  [**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
35
+ [**listTopUpPayerAccounts**](PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
34
36
  [**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
37
+ [**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
38
+ [**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
35
39
  [**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
36
40
  [**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
37
41
  [**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
@@ -95,7 +99,7 @@ Name | Type | Description | Notes
95
99
 
96
100
  Create crypto address
97
101
 
98
- This operation registers a crypto address for crypto withdrawal. The registered address can later be referenced by its ID when creating settlement requests.
102
+ This operation registers a crypto address for crypto payouts. The registered address can later be referenced by its ID when creating settlement requests.
99
103
 
100
104
  ### Example
101
105
 
@@ -147,7 +151,7 @@ Name | Type | Description | Notes
147
151
 
148
152
  Create forced sweep
149
153
 
150
- This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address.
154
+ <Warning>This operation has been deprecated.</Warning> This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address.
151
155
 
152
156
  ### Example
153
157
 
@@ -199,7 +203,7 @@ Name | Type | Description | Notes
199
203
 
200
204
  Create merchant
201
205
 
202
- This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. If you are a merchant (directly serving the payer), you only need to create one merchant and do not need to configure the developer fee rate. The developer fee rate only applies to platforms such as payment service providers (PSPs) that charge fees to their downstream merchants.
206
+ This operation creates a merchant. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. For more information on merchant creation, please refer to [Preparation](https://www.cobo.com/developers/v2/payments/preparation#create-merchant).
203
207
 
204
208
  ### Example
205
209
 
@@ -245,6 +249,58 @@ Name | Type | Description | Notes
245
249
  - **Accept**: application/json
246
250
 
247
251
 
252
+ ## createOrderLink
253
+
254
+ > Link createOrderLink(opts)
255
+
256
+ Create order link
257
+
258
+ This operation creates a payment link of a pay-in order.
259
+
260
+ ### Example
261
+
262
+ ```javascript
263
+ const CoboWaas2 = require('@cobo/cobo-waas2');
264
+ // Initialize the API client
265
+ const apiClient = CoboWaas2.ApiClient.instance
266
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
267
+ apiClient.setEnv(CoboWaas2.Env.DEV);
268
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
269
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
270
+ // Call the API
271
+ const apiInstance = new CoboWaas2.PaymentApi();
272
+ const opts = {
273
+ 'CreateOrderLinkRequest': new CoboWaas2.CreateOrderLinkRequest()
274
+ };
275
+ apiInstance.createOrderLink(opts).then((data) => {
276
+ console.log('API called successfully. Returned data: ' + data);
277
+ }, (error) => {
278
+ console.error(error);
279
+ });
280
+
281
+ ```
282
+
283
+ ### Parameters
284
+
285
+
286
+ Name | Type | Description | Notes
287
+ ------------- | ------------- | ------------- | -------------
288
+ **CreateOrderLinkRequest** | [**CreateOrderLinkRequest**](CreateOrderLinkRequest.md)| The request body to create a payment link of a pay-in order. | [optional]
289
+
290
+ ### Return type
291
+
292
+ [**Link**](Link.md)
293
+
294
+ ### Authorization
295
+
296
+ [CoboAuth](../README.md#CoboAuth)
297
+
298
+ ### HTTP request headers
299
+
300
+ - **Content-Type**: application/json
301
+ - **Accept**: application/json
302
+
303
+
248
304
  ## createPaymentOrder
249
305
 
250
306
  > Order createPaymentOrder(opts)
@@ -407,7 +463,7 @@ Name | Type | Description | Notes
407
463
 
408
464
  Delete crypto address
409
465
 
410
- This operation unregisters a crypto address from being used for crypto withdrawals.
466
+ This operation unregisters a crypto address from being used for crypto payouts.
411
467
 
412
468
  ### Example
413
469
 
@@ -457,7 +513,7 @@ Name | Type | Description | Notes
457
513
 
458
514
  Get exchange rate
459
515
 
460
- This operation retrieves the current exchange rate between a specified currency pair.
516
+ This operation retrieves the current exchange rate between a specified currency pair. The exchange rate is updated approximately every 10 minutes. &lt;Note&gt;This operation returns the exchange rate for reference only. The actual exchange rate may vary due to market fluctuations and other factors.&lt;/Note&gt;
461
517
 
462
518
  ### Example
463
519
 
@@ -505,7 +561,7 @@ Name | Type | Description | Notes
505
561
 
506
562
  ## getPayerBalanceByAddress
507
563
 
508
- > [ReceivedAmountPerAddress] getPayerBalanceByAddress(merchant_id, payer_id, token_id)
564
+ > [ReceivedAmountPerAddress] getPayerBalanceByAddress(payer_id, token_id, opts)
509
565
 
510
566
  Get payer balance
511
567
 
@@ -523,10 +579,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
523
579
  apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
524
580
  // Call the API
525
581
  const apiInstance = new CoboWaas2.PaymentApi();
526
- const merchant_id = "M1001";
527
582
  const payer_id = "P20250619T0310056d7aa";
528
583
  const token_id = "ETH_USDT";
529
- apiInstance.getPayerBalanceByAddress(merchant_id, payer_id, token_id).then((data) => {
584
+ const opts = {
585
+ 'merchant_id': "M1001"
586
+ };
587
+ apiInstance.getPayerBalanceByAddress(payer_id, token_id, opts).then((data) => {
530
588
  console.log('API called successfully. Returned data: ' + data);
531
589
  }, (error) => {
532
590
  console.error(error);
@@ -539,9 +597,9 @@ apiInstance.getPayerBalanceByAddress(merchant_id, payer_id, token_id).then((data
539
597
 
540
598
  Name | Type | Description | Notes
541
599
  ------------- | ------------- | ------------- | -------------
542
- **merchant_id** | **String**| The merchant ID. |
543
600
  **payer_id** | **String**| Unique payer identifier on the Cobo side, auto-generated by the system. |
544
601
  **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;. Supported values include: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60; - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60; |
602
+ **merchant_id** | **String**| The merchant ID. | [optional]
545
603
 
546
604
  ### Return type
547
605
 
@@ -613,7 +671,7 @@ Name | Type | Description | Notes
613
671
 
614
672
  Get developer balance
615
673
 
616
- This operation retrieves the balance information for you as the developer. The balance information is grouped by token.
674
+ This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).
617
675
 
618
676
  ### Example
619
677
 
@@ -825,7 +883,7 @@ Name | Type | Description | Notes
825
883
 
826
884
  Get withdrawable balances
827
885
 
828
- This operation retrieves the balances of specified merchants or the developer.
886
+ &lt;Warning&gt;This operation has been deprecated.&lt;/Warning&gt; This operation retrieves the balances of specified merchants or the developer.
829
887
 
830
888
  ### Example
831
889
 
@@ -877,7 +935,7 @@ Name | Type | Description | Notes
877
935
 
878
936
  ## getTopUpAddress
879
937
 
880
- > TopUpAddress getTopUpAddress(merchant_id, token_id, custom_payer_id)
938
+ > TopUpAddress getTopUpAddress(token_id, custom_payer_id, opts)
881
939
 
882
940
  Get top-up address
883
941
 
@@ -895,10 +953,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
895
953
  apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
896
954
  // Call the API
897
955
  const apiInstance = new CoboWaas2.PaymentApi();
898
- const merchant_id = "M1001";
899
956
  const token_id = "ETH_USDT";
900
957
  const custom_payer_id = "payer_0001";
901
- apiInstance.getTopUpAddress(merchant_id, token_id, custom_payer_id).then((data) => {
958
+ const opts = {
959
+ 'merchant_id': "M1001"
960
+ };
961
+ apiInstance.getTopUpAddress(token_id, custom_payer_id, opts).then((data) => {
902
962
  console.log('API called successfully. Returned data: ' + data);
903
963
  }, (error) => {
904
964
  console.error(error);
@@ -911,9 +971,9 @@ apiInstance.getTopUpAddress(merchant_id, token_id, custom_payer_id).then((data)
911
971
 
912
972
  Name | Type | Description | Notes
913
973
  ------------- | ------------- | ------------- | -------------
914
- **merchant_id** | **String**| The merchant ID. |
915
974
  **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;. Supported values include: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60; - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60; |
916
975
  **custom_payer_id** | **String**| A unique identifier assigned by the developer to track and identify individual payers in their system. |
976
+ **merchant_id** | **String**| The merchant ID. | [optional]
917
977
 
918
978
  ### Return type
919
979
 
@@ -981,7 +1041,7 @@ This endpoint does not need any parameter.
981
1041
 
982
1042
  List crypto addresses
983
1043
 
984
- This operation retrieves a list of crypto addresses registered for crypto withdrawal. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new crypto address.
1044
+ This operation retrieves a list of crypto addresses registered for crypto payouts. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new crypto address.
985
1045
 
986
1046
  ### Example
987
1047
 
@@ -1033,7 +1093,7 @@ Name | Type | Description | Notes
1033
1093
 
1034
1094
  List forced sweeps
1035
1095
 
1036
- This operation retrieves the information of all forced sweeps.
1096
+ &lt;Warning&gt;This operation has been deprecated.&lt;/Warning&gt; This operation retrieves the information of all forced sweeps.
1037
1097
 
1038
1098
  ### Example
1039
1099
 
@@ -1091,7 +1151,7 @@ Name | Type | Description | Notes
1091
1151
 
1092
1152
  List merchant balances
1093
1153
 
1094
- This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the &#x60;merchant_ids&#x60; parameter, the balance information for all merchants will be returned.
1154
+ This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the &#x60;merchant_ids&#x60; parameter, the balance information for all merchants will be returned. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).
1095
1155
 
1096
1156
  ### Example
1097
1157
 
@@ -1166,7 +1226,8 @@ const opts = {
1166
1226
  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
1167
1227
  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
1168
1228
  'keyword': "keyword",
1169
- 'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479"
1229
+ 'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479",
1230
+ 'wallet_setup': new CoboWaas2.WalletSetup()
1170
1231
  };
1171
1232
  apiInstance.listMerchants(opts).then((data) => {
1172
1233
  console.log('API called successfully. Returned data: ' + data);
@@ -1185,7 +1246,8 @@ Name | Type | Description | Notes
1185
1246
  **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
1186
1247
  **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
1187
1248
  **keyword** | **String**| A search term used for fuzzy matching of merchant names. | [optional]
1188
- **wallet_id** | **String**| The wallet ID. | [optional]
1249
+ **wallet_id** | **String**| This parameter has been deprecated. | [optional]
1250
+ **wallet_setup** | [**WalletSetup**](.md)| The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses. - &#x60;Shared&#x60;: Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously. - &#x60;Separate&#x60;: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant. - &#x60;Default&#x60;: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization). | [optional]
1189
1251
 
1190
1252
  ### Return type
1191
1253
 
@@ -1315,7 +1377,7 @@ This endpoint does not need any parameter.
1315
1377
 
1316
1378
  List payment wallet balances
1317
1379
 
1318
- This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the &#x60;wallet_ids&#x60; parameter, the balance information for all payment wallets will be returned.
1380
+ &lt;Warning&gt;This operation has been deprecated.&lt;/Warning&gt; This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the &#x60;wallet_ids&#x60; parameter, the balance information for all payment wallets will be returned.
1319
1381
 
1320
1382
  ### Example
1321
1383
 
@@ -1481,9 +1543,69 @@ Name | Type | Description | Notes
1481
1543
  - **Accept**: application/json
1482
1544
 
1483
1545
 
1546
+ ## listTopUpPayerAccounts
1547
+
1548
+ > ListTopUpPayerAccounts200Response listTopUpPayerAccounts(opts)
1549
+
1550
+ List top-up payer accounts
1551
+
1552
+ This operation retrieves the accounts of all payers. You can filter the result by merchant ID and payer_id.
1553
+
1554
+ ### Example
1555
+
1556
+ ```javascript
1557
+ const CoboWaas2 = require('@cobo/cobo-waas2');
1558
+ // Initialize the API client
1559
+ const apiClient = CoboWaas2.ApiClient.instance
1560
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
1561
+ apiClient.setEnv(CoboWaas2.Env.DEV);
1562
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
1563
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
1564
+ // Call the API
1565
+ const apiInstance = new CoboWaas2.PaymentApi();
1566
+ const opts = {
1567
+ 'limit': 10,
1568
+ 'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
1569
+ 'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
1570
+ 'merchant_id': "M1001",
1571
+ 'payer_id': "P20250619T0310056d7aa"
1572
+ };
1573
+ apiInstance.listTopUpPayerAccounts(opts).then((data) => {
1574
+ console.log('API called successfully. Returned data: ' + data);
1575
+ }, (error) => {
1576
+ console.error(error);
1577
+ });
1578
+
1579
+ ```
1580
+
1581
+ ### Parameters
1582
+
1583
+
1584
+ Name | Type | Description | Notes
1585
+ ------------- | ------------- | ------------- | -------------
1586
+ **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
1587
+ **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
1588
+ **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
1589
+ **merchant_id** | **String**| The merchant ID. | [optional]
1590
+ **payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
1591
+
1592
+ ### Return type
1593
+
1594
+ [**ListTopUpPayerAccounts200Response**](ListTopUpPayerAccounts200Response.md)
1595
+
1596
+ ### Authorization
1597
+
1598
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
1599
+
1600
+ ### HTTP request headers
1601
+
1602
+ - **Content-Type**: Not defined
1603
+ - **Accept**: application/json
1604
+
1605
+
1484
1606
  ## listTopUpPayers
1485
1607
 
1486
- > ListTopUpPayers200Response listTopUpPayers(merchant_id, opts)
1608
+ > ListTopUpPayers200Response listTopUpPayers(opts)
1487
1609
 
1488
1610
  List payers
1489
1611
 
@@ -1501,14 +1623,14 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
1501
1623
  apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
1502
1624
  // Call the API
1503
1625
  const apiInstance = new CoboWaas2.PaymentApi();
1504
- const merchant_id = "M1001";
1505
1626
  const opts = {
1506
1627
  'limit': 10,
1507
1628
  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
1508
1629
  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
1630
+ 'merchant_id': "M1001",
1509
1631
  'payer_id': "P20250619T0310056d7aa"
1510
1632
  };
1511
- apiInstance.listTopUpPayers(merchant_id, opts).then((data) => {
1633
+ apiInstance.listTopUpPayers(opts).then((data) => {
1512
1634
  console.log('API called successfully. Returned data: ' + data);
1513
1635
  }, (error) => {
1514
1636
  console.error(error);
@@ -1521,10 +1643,10 @@ apiInstance.listTopUpPayers(merchant_id, opts).then((data) => {
1521
1643
 
1522
1644
  Name | Type | Description | Notes
1523
1645
  ------------- | ------------- | ------------- | -------------
1524
- **merchant_id** | **String**| The merchant ID. |
1525
1646
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
1526
1647
  **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
1527
1648
  **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
1649
+ **merchant_id** | **String**| The merchant ID. | [optional]
1528
1650
  **payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
1529
1651
 
1530
1652
  ### Return type
@@ -1541,6 +1663,112 @@ Name | Type | Description | Notes
1541
1663
  - **Accept**: application/json
1542
1664
 
1543
1665
 
1666
+ ## paymentEstimateFee
1667
+
1668
+ > PaymentEstimateFee201Response paymentEstimateFee(opts)
1669
+
1670
+ Estimate fees
1671
+
1672
+ This operation calculates fees for payment-related operations, including: - **Pay-in**: Fees for accepting payments - **Refunds**: Fees for refunding the payment - **Crypto payouts**: Fees for payouts in crypto - **Fiat off-ramp**: Fees for fiat currency transfers via off-ramp. The returned fees represent the charges that would apply if the operation were executed immediately. Note that actual fees may vary over time based on your usage volume and applicable fee rates.
1673
+
1674
+ ### Example
1675
+
1676
+ ```javascript
1677
+ const CoboWaas2 = require('@cobo/cobo-waas2');
1678
+ // Initialize the API client
1679
+ const apiClient = CoboWaas2.ApiClient.instance
1680
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
1681
+ apiClient.setEnv(CoboWaas2.Env.DEV);
1682
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
1683
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
1684
+ // Call the API
1685
+ const apiInstance = new CoboWaas2.PaymentApi();
1686
+ const opts = {
1687
+ 'PaymentEstimateFeeRequest': new CoboWaas2.PaymentEstimateFeeRequest()
1688
+ };
1689
+ apiInstance.paymentEstimateFee(opts).then((data) => {
1690
+ console.log('API called successfully. Returned data: ' + data);
1691
+ }, (error) => {
1692
+ console.error(error);
1693
+ });
1694
+
1695
+ ```
1696
+
1697
+ ### Parameters
1698
+
1699
+
1700
+ Name | Type | Description | Notes
1701
+ ------------- | ------------- | ------------- | -------------
1702
+ **PaymentEstimateFeeRequest** | [**PaymentEstimateFeeRequest**](PaymentEstimateFeeRequest.md)| The request body for fee estimation. | [optional]
1703
+
1704
+ ### Return type
1705
+
1706
+ [**PaymentEstimateFee201Response**](PaymentEstimateFee201Response.md)
1707
+
1708
+ ### Authorization
1709
+
1710
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
1711
+
1712
+ ### HTTP request headers
1713
+
1714
+ - **Content-Type**: application/json
1715
+ - **Accept**: application/json
1716
+
1717
+
1718
+ ## updateBankAccountById
1719
+
1720
+ > BankAccount updateBankAccountById(bank_account_id, opts)
1721
+
1722
+ Update bank account
1723
+
1724
+ This operation updates the information of an existing bank account.
1725
+
1726
+ ### Example
1727
+
1728
+ ```javascript
1729
+ const CoboWaas2 = require('@cobo/cobo-waas2');
1730
+ // Initialize the API client
1731
+ const apiClient = CoboWaas2.ApiClient.instance
1732
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
1733
+ apiClient.setEnv(CoboWaas2.Env.DEV);
1734
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
1735
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
1736
+ // Call the API
1737
+ const apiInstance = new CoboWaas2.PaymentApi();
1738
+ const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
1739
+ const opts = {
1740
+ 'UpdateBankAccountByIdRequest': new CoboWaas2.UpdateBankAccountByIdRequest()
1741
+ };
1742
+ apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
1743
+ console.log('API called successfully. Returned data: ' + data);
1744
+ }, (error) => {
1745
+ console.error(error);
1746
+ });
1747
+
1748
+ ```
1749
+
1750
+ ### Parameters
1751
+
1752
+
1753
+ Name | Type | Description | Notes
1754
+ ------------- | ------------- | ------------- | -------------
1755
+ **bank_account_id** | **String**| The bank account ID. |
1756
+ **UpdateBankAccountByIdRequest** | [**UpdateBankAccountByIdRequest**](UpdateBankAccountByIdRequest.md)| The request body for updating an existing bank account. | [optional]
1757
+
1758
+ ### Return type
1759
+
1760
+ [**BankAccount**](BankAccount.md)
1761
+
1762
+ ### Authorization
1763
+
1764
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
1765
+
1766
+ ### HTTP request headers
1767
+
1768
+ - **Content-Type**: application/json
1769
+ - **Accept**: application/json
1770
+
1771
+
1544
1772
  ## updateMerchantById
1545
1773
 
1546
1774
  > Merchant updateMerchantById(merchant_id, opts)
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.PaymentEstimateFee
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **token_id** | **String** | The token ID for which fees will be calculated. |
8
+ **amount** | **String** | The transaction amount for which fees will be calculated. |
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CoboWaas2.PaymentEstimateFee201Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**[PaymentEstimatedFee]**](PaymentEstimatedFee.md) | A list of estimated fees for the requested operations. | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.PaymentEstimateFeeRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **fee_type** | [**PaymentFeeType**](PaymentFeeType.md) | | [optional]
8
+ **estimate_fees** | [**[PaymentEstimateFee]**](PaymentEstimateFee.md) | A list of token IDs and amounts for which fees will be calculated. |
9
+
10
+
@@ -0,0 +1,13 @@
1
+ # CoboWaas2.PaymentEstimatedFee
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **token_id** | **String** | The token ID for which fees will be calculated. |
8
+ **amount** | **String** | The transaction amount for which fees will be calculated. |
9
+ **commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
10
+ **bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional]
11
+ **otc_fee** | [**OtcFee**](OtcFee.md) | | [optional]
12
+
13
+
@@ -0,0 +1,16 @@
1
+ # CoboWaas2.PaymentFeeType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Order` (value: `"Order"`)
7
+
8
+ * `Refund` (value: `"Refund"`)
9
+
10
+ * `CryptoSettlement` (value: `"CryptoSettlement"`)
11
+
12
+ * `OffRampSettlement` (value: `"OffRampSettlement"`)
13
+
14
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
15
+
16
+
@@ -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
  **order_id** | **String** | The order ID. |
9
9
  **merchant_id** | **String** | The merchant ID. | [optional]
10
10
  **token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDCOIN&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC2&#x60;, &#x60;BSC_USDC&#x60; - USDT: &#x60;TRON_USDT&#x60;, &#x60;ETH_USDT&#x60;, &#x60;ARBITRUM_USDT&#x60;, &#x60;SOL_USDT&#x60;, &#x60;BASE_USDT&#x60;, &#x60;MATIC_USDT&#x60;, &#x60;BSC_USDT&#x60; |
@@ -24,6 +24,7 @@ Name | Type | Description | Notes
24
24
  **updated_timestamp** | **Number** | The last update time of the order, represented as a UNIX timestamp in seconds. | [optional]
25
25
  **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]
26
26
  **settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
27
+ **amount_tolerance** | **String** | Allowed amount deviation. | [optional]
27
28
 
28
29
 
29
30
 
@@ -62,6 +63,8 @@ Name | Type | Description | Notes
62
63
 
63
64
  * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
64
65
 
66
+ * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
67
+
65
68
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
66
69
 
67
70
 
@@ -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
  **request_id** | **String** | The request ID provided by you when creating the refund request. | [optional]
9
9
  **refund_id** | **String** | The refund order ID. |
10
10
  **order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional]
@@ -17,11 +17,12 @@ Name | Type | Description | Notes
17
17
  **refund_type** | [**RefundType**](RefundType.md) | | [optional]
18
18
  **created_timestamp** | **Number** | The creation time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
19
19
  **updated_timestamp** | **Number** | The last update time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
20
- **initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payment Management App&#39;s ID. - Format &#x60;api_key_&lt;API_KEY&gt;&#x60;: Indicates the settlement request was initiated via the Payment API using the API key. - Format &#x60;app_&lt;APP_ID&gt;&#x60;: Indicates the settlement request was initiated through the Payment Management App using the App ID. | [optional]
20
+ **initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payments App&#39;s ID. - Format &#x60;api_key_&lt;API_KEY&gt;&#x60;: Indicates the settlement request was initiated via the Payments API using the API key. - Format &#x60;app_&lt;APP_ID&gt;&#x60;: Indicates the settlement request was initiated through the Payments App using the App ID. | [optional]
21
21
  **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional]
22
22
  **charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund. - &#x60;true&#x60;: The fee amount (specified in &#x60;merchant_fee_amount&#x60;) will be deducted from the merchant&#39;s balance and added to the developer&#39;s balance - &#x60;false&#x60;: The merchant is not charged any developer fee. | [optional]
23
23
  **merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by &#x60;merchant_fee_token_id&#x60;. This is only applicable if &#x60;charge_merchant_fee&#x60; is set to &#x60;true&#x60;. | [optional]
24
24
  **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if &#x60;charge_merchant_fee&#x60; is set to true. | [optional]
25
+ **commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
25
26
 
26
27
 
27
28
 
@@ -60,6 +61,8 @@ Name | Type | Description | Notes
60
61
 
61
62
  * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
62
63
 
64
+ * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
65
+
63
66
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
64
67
 
65
68