@cobo/cobo-waas2 1.15.0 → 1.17.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 (140) hide show
  1. package/README.md +42 -6
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/PreRequestScript.js +27 -33
  4. package/dist/api/AddressBooksApi.js +4 -4
  5. package/dist/api/AppWorkflowsApi.js +275 -0
  6. package/dist/api/DevelopersApi.js +4 -4
  7. package/dist/api/DevelopersWebhooksApi.js +12 -12
  8. package/dist/api/FeeStationApi.js +12 -12
  9. package/dist/api/OAuthApi.js +93 -6
  10. package/dist/api/PaymentApi.js +107 -161
  11. package/dist/api/StakingsApi.js +28 -28
  12. package/dist/api/TransactionsApi.js +4 -4
  13. package/dist/api/WalletsApi.js +102 -51
  14. package/dist/api/WalletsExchangeWalletApi.js +8 -8
  15. package/dist/api/WalletsMPCWalletsApi.js +20 -20
  16. package/dist/index.js +224 -14
  17. package/dist/model/AppWorkflow.js +173 -0
  18. package/dist/model/AppWorkflowField.js +137 -0
  19. package/dist/model/AppWorkflowPolicy.js +144 -0
  20. package/dist/model/ApprovalEntry.js +148 -0
  21. package/dist/model/ApprovalRequest.js +180 -0
  22. package/dist/model/ApprovalRequestDetail.js +177 -0
  23. package/dist/model/ApprovalStatus.js +71 -0
  24. package/dist/model/ApprovalUser.js +146 -0
  25. package/dist/model/BabylonStakeExtra.js +16 -0
  26. package/dist/model/BatchCheckUtxo201Response.js +107 -0
  27. package/dist/model/BatchCheckUtxoRequest.js +142 -0
  28. package/dist/model/{CreateBankAccountRequest.js → BatchUTXOParam.js} +43 -28
  29. package/dist/model/ChainInfo.js +9 -0
  30. package/dist/model/CreateApprovalRequest201Response.js +110 -0
  31. package/dist/model/CreatePaymentOrderRequest.js +5 -5
  32. package/dist/model/CreateRefundRequest.js +35 -0
  33. package/dist/model/CreateSettlement.js +39 -29
  34. package/dist/model/CreateStakeActivityExtra.js +6 -0
  35. package/dist/model/CryptoAddress.js +171 -0
  36. package/dist/model/{OrderAddressInfo.js → CustodialTransferDestination.js} +36 -46
  37. package/dist/model/CustodialWeb3TransferSource.js +1 -1
  38. package/dist/model/EstimateContractCallFeeParams.js +13 -0
  39. package/dist/model/EstimateFeeParams.js +6 -0
  40. package/dist/model/EstimateTransferFeeParams.js +13 -0
  41. package/dist/model/ExchangePermissionToken201Response.js +122 -0
  42. package/dist/model/ExchangePermissionTokenRequest.js +110 -0
  43. package/dist/model/ListApprovalRequests200Response.js +123 -0
  44. package/dist/model/MpcTransferSource.js +1 -1
  45. package/dist/model/Order.js +4 -4
  46. package/dist/model/PaymentOrderEventData.js +6 -6
  47. package/dist/model/PayoutChannel.js +61 -0
  48. package/dist/model/PolicyAction.js +123 -0
  49. package/dist/model/PolicyActionContent.js +169 -0
  50. package/dist/model/PolicyActionType.js +66 -0
  51. package/dist/model/PolicyCondition.js +148 -0
  52. package/dist/model/PolicyFieldOperator.js +76 -0
  53. package/dist/model/PolicyFieldValueType.js +61 -0
  54. package/dist/model/RefreshPermissionTokenRequest.js +110 -0
  55. package/dist/model/RequestApproval.js +188 -0
  56. package/dist/model/RevokeApprovalRequest201Response.js +119 -0
  57. package/dist/model/RevokeApprovalRequestRequest.js +110 -0
  58. package/dist/model/SettlementDetail.js +22 -0
  59. package/dist/model/SupportedToken.js +222 -0
  60. package/dist/model/SwapActivityApprovers.js +122 -0
  61. package/dist/model/SwapActivityDetail.js +30 -0
  62. package/dist/model/SwapApproversStatus.js +66 -0
  63. package/dist/model/TransactionCoboCategory.js +102 -7
  64. package/dist/model/TransactionDestination.js +4 -0
  65. package/dist/model/TransactionDestinationType.js +5 -0
  66. package/dist/model/TransactionRbfSource.js +1 -1
  67. package/dist/model/TransactionSubStatus.js +10 -0
  68. package/dist/model/TransactionTransferToWalletDestination.js +2 -2
  69. package/dist/model/TransferDestination.js +42 -14
  70. package/dist/model/TransferDestinationType.js +5 -0
  71. package/dist/model/UTXO.js +9 -0
  72. package/docs/AddressBooksApi.md +2 -2
  73. package/docs/AppWorkflow.md +12 -0
  74. package/docs/AppWorkflowField.md +11 -0
  75. package/docs/AppWorkflowPolicy.md +10 -0
  76. package/docs/AppWorkflowsApi.md +273 -0
  77. package/docs/ApprovalEntry.md +11 -0
  78. package/docs/ApprovalRequest.md +13 -0
  79. package/docs/ApprovalRequestDetail.md +13 -0
  80. package/docs/ApprovalStatus.md +16 -0
  81. package/docs/ApprovalUser.md +12 -0
  82. package/docs/BabylonStakeExtra.md +1 -0
  83. package/docs/BatchCheckUtxo201Response.md +9 -0
  84. package/docs/BatchCheckUtxoRequest.md +10 -0
  85. package/docs/BatchUTXOParam.md +10 -0
  86. package/docs/ChainInfo.md +1 -0
  87. package/docs/CreateApprovalRequest201Response.md +9 -0
  88. package/docs/CreatePaymentOrderRequest.md +1 -1
  89. package/docs/CreateRefundRequest.md +3 -0
  90. package/docs/CreateSettlement.md +5 -2
  91. package/docs/CreateStakeActivityExtra.md +1 -0
  92. package/docs/CryptoAddress.md +14 -0
  93. package/docs/CustodialTransferDestination.md +11 -0
  94. package/docs/CustodialWeb3TransferSource.md +1 -1
  95. package/docs/DevelopersApi.md +2 -2
  96. package/docs/DevelopersWebhooksApi.md +6 -6
  97. package/docs/EstimateContractCallFeeParams.md +1 -0
  98. package/docs/EstimateFeeParams.md +1 -0
  99. package/docs/EstimateTransferFeeParams.md +1 -0
  100. package/docs/ExchangePermissionToken201Response.md +12 -0
  101. package/docs/ExchangePermissionTokenRequest.md +9 -0
  102. package/docs/FeeStationApi.md +6 -6
  103. package/docs/ListApprovalRequests200Response.md +10 -0
  104. package/docs/MpcTransferSource.md +1 -1
  105. package/docs/OAuthApi.md +102 -0
  106. package/docs/Order.md +2 -2
  107. package/docs/PaymentApi.md +86 -147
  108. package/docs/PaymentOrderEventData.md +2 -2
  109. package/docs/PayoutChannel.md +12 -0
  110. package/docs/PolicyAction.md +10 -0
  111. package/docs/PolicyActionContent.md +25 -0
  112. package/docs/PolicyActionType.md +14 -0
  113. package/docs/PolicyCondition.md +12 -0
  114. package/docs/PolicyFieldOperator.md +18 -0
  115. package/docs/PolicyFieldValueType.md +12 -0
  116. package/docs/RefreshPermissionTokenRequest.md +9 -0
  117. package/docs/RequestApproval.md +13 -0
  118. package/docs/RevokeApprovalRequest201Response.md +10 -0
  119. package/docs/RevokeApprovalRequestRequest.md +9 -0
  120. package/docs/SettlementDetail.md +2 -0
  121. package/docs/StakingsApi.md +14 -14
  122. package/docs/SupportedToken.md +17 -0
  123. package/docs/SwapActivityApprovers.md +10 -0
  124. package/docs/SwapActivityDetail.md +1 -0
  125. package/docs/SwapApproversStatus.md +14 -0
  126. package/docs/TransactionCoboCategory.md +41 -3
  127. package/docs/TransactionDestinationType.md +2 -0
  128. package/docs/TransactionRbfSource.md +1 -1
  129. package/docs/TransactionSubStatus.md +4 -0
  130. package/docs/TransactionTransferToWalletDestination.md +1 -1
  131. package/docs/TransactionsApi.md +2 -2
  132. package/docs/TransferDestination.md +1 -1
  133. package/docs/TransferDestinationType.md +2 -0
  134. package/docs/UTXO.md +1 -0
  135. package/docs/WalletsApi.md +78 -23
  136. package/docs/WalletsExchangeWalletApi.md +4 -4
  137. package/docs/WalletsMPCWalletsApi.md +10 -10
  138. package/package.json +1 -1
  139. package/docs/CreateBankAccountRequest.md +0 -9
  140. package/docs/OrderAddressInfo.md +0 -12
@@ -157,8 +157,8 @@ Name | Type | Description | Notes
157
157
  **chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. 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). | [optional]
158
158
  **addresses** | **String**| A list of wallet addresses, separated by comma. For addresses requiring a memo, append the memo after the address using the '|' separator (e.g., \"address|memo\"). | [optional]
159
159
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
160
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
161
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
160
+ **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]
161
+ **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]
162
162
 
163
163
  ### Return type
164
164
 
@@ -236,8 +236,8 @@ Name | Type | Description | Notes
236
236
  **min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
237
237
  **max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change. | [optional]
238
238
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
239
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
240
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
239
+ **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]
240
+ **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]
241
241
  **direction** | **String**| The sort direction. Possible values include: - `ASC`: Sort the results in ascending order. - `DESC`: Sort the results in descending order. | [optional] [default to '']
242
242
 
243
243
  ### Return type
@@ -295,8 +295,8 @@ Name | Type | Description | Notes
295
295
  ------------- | ------------- | ------------- | -------------
296
296
  **token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a 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). | [optional]
297
297
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
298
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
299
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
298
+ **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]
299
+ **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]
300
300
 
301
301
  ### Return type
302
302
 
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.ListApprovalRequests200Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**[ApprovalRequest]**](ApprovalRequest.md) | | [optional]
8
+ **pagination** | [**Pagination**](Pagination.md) | | [optional]
9
+
10
+
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **source_type** | [**WalletSubtype**](WalletSubtype.md) | |
8
8
  **wallet_id** | **String** | The wallet ID. |
9
- **address** | **String** | The wallet address. If you want to specify the UTXOs to be used, please provide the `included_utxos` property. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing. You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail. | [optional]
9
+ **address** | **String** | The wallet address. If you want to specify the UTXOs to be used, please provide the `included_utxos` property. When `included_utxos` is specified, only these specified UTXOs will be used for the transaction. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing. You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail. | [optional]
10
10
  **included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
11
11
  **excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
12
12
  **mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) | | [optional]
package/docs/OAuthApi.md CHANGED
@@ -4,11 +4,63 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**exchangePermissionToken**](OAuthApi.md#exchangePermissionToken) | **POST** /oauth/permission_token/exchange | Exchange Permission Access Token by API Key
7
8
  [**getToken**](OAuthApi.md#getToken) | **GET** /oauth/token | Get Org Access Token
9
+ [**refreshPermissionToken**](OAuthApi.md#refreshPermissionToken) | **POST** /oauth/permission_token/refresh | Refresh Permission Access Token by Permission Refresh Token
8
10
  [**refreshToken**](OAuthApi.md#refreshToken) | **POST** /oauth/token | Refresh Org Access Token
9
11
 
10
12
 
11
13
 
14
+ ## exchangePermissionToken
15
+
16
+ > ExchangePermissionToken201Response exchangePermissionToken(ExchangePermissionTokenRequest)
17
+
18
+ Exchange Permission Access Token by API Key
19
+
20
+ <Note>This operation is only applicable to Cobo Portal Checkout SDK developers. To call this operation, you need to use the Cobo OAuth authentication method that requires an api key.</Note> This operation allows Portal Checkout SDK to obtain a new Permission Access Token with a specified client ID, grant type and a Permission Refresh Token. For security purposes, Permission Access Tokens expire after a certain period. Once they expire, the app needs to call this operation to get a new Permission Access Token and a new Permission Refresh Token.
21
+
22
+ ### Example
23
+
24
+ ```javascript
25
+ const CoboWaas2 = require('@cobo/cobo-waas2');
26
+ // Initialize the API client
27
+ const apiClient = CoboWaas2.ApiClient.instance
28
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
29
+ apiClient.setEnv(CoboWaas2.Env.DEV);
30
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
31
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
32
+ // Call the API
33
+ const apiInstance = new CoboWaas2.OAuthApi();
34
+ const ExchangePermissionTokenRequest = new CoboWaas2.ExchangePermissionTokenRequest();
35
+ apiInstance.exchangePermissionToken(ExchangePermissionTokenRequest).then((data) => {
36
+ console.log('API called successfully. Returned data: ' + data);
37
+ }, (error) => {
38
+ console.error(error);
39
+ });
40
+
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+
46
+ Name | Type | Description | Notes
47
+ ------------- | ------------- | ------------- | -------------
48
+ **ExchangePermissionTokenRequest** | [**ExchangePermissionTokenRequest**](ExchangePermissionTokenRequest.md)| The request body for exchanging an Permission Access Token. |
49
+
50
+ ### Return type
51
+
52
+ [**ExchangePermissionToken201Response**](ExchangePermissionToken201Response.md)
53
+
54
+ ### Authorization
55
+
56
+ [CoboAuth](../README.md#CoboAuth)
57
+
58
+ ### HTTP request headers
59
+
60
+ - **Content-Type**: application/json
61
+ - **Accept**: application/json
62
+
63
+
12
64
  ## getToken
13
65
 
14
66
  > GetToken2XXResponse getToken(client_id, org_id, grant_type)
@@ -63,6 +115,56 @@ Name | Type | Description | Notes
63
115
  - **Accept**: application/json
64
116
 
65
117
 
118
+ ## refreshPermissionToken
119
+
120
+ > ExchangePermissionToken201Response refreshPermissionToken(RefreshPermissionTokenRequest)
121
+
122
+ Refresh Permission Access Token by Permission Refresh Token
123
+
124
+ &lt;Note&gt;This operation is only applicable to Cobo Portal Checkout SDK developers. To call this operation, you need to use the Cobo OAuth authentication method that requires an api key.&lt;/Note&gt; This operation allows Portal Checkout SDK to refresh a new Permission Access Token with a specified client ID, grant type and a Permission Refresh Token. For security purposes, Permission Access Tokens expire after a certain period. Once they expire, the app needs to call this operation to get a new Permission Access Token and a new Permission Refresh Token.
125
+
126
+ ### Example
127
+
128
+ ```javascript
129
+ const CoboWaas2 = require('@cobo/cobo-waas2');
130
+ // Initialize the API client
131
+ const apiClient = CoboWaas2.ApiClient.instance
132
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
133
+ apiClient.setEnv(CoboWaas2.Env.DEV);
134
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
135
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
136
+ // Call the API
137
+ const apiInstance = new CoboWaas2.OAuthApi();
138
+ const RefreshPermissionTokenRequest = new CoboWaas2.RefreshPermissionTokenRequest();
139
+ apiInstance.refreshPermissionToken(RefreshPermissionTokenRequest).then((data) => {
140
+ console.log('API called successfully. Returned data: ' + data);
141
+ }, (error) => {
142
+ console.error(error);
143
+ });
144
+
145
+ ```
146
+
147
+ ### Parameters
148
+
149
+
150
+ Name | Type | Description | Notes
151
+ ------------- | ------------- | ------------- | -------------
152
+ **RefreshPermissionTokenRequest** | [**RefreshPermissionTokenRequest**](RefreshPermissionTokenRequest.md)| The request body for refreshing an Permission Access Token. |
153
+
154
+ ### Return type
155
+
156
+ [**ExchangePermissionToken201Response**](ExchangePermissionToken201Response.md)
157
+
158
+ ### Authorization
159
+
160
+ [CoboAuth](../README.md#CoboAuth)
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: application/json
165
+ - **Accept**: application/json
166
+
167
+
66
168
  ## refreshToken
67
169
 
68
170
  > RefreshToken2XXResponse refreshToken(RefreshTokenRequest)
package/docs/Order.md CHANGED
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **order_id** | **String** | The order ID. |
8
8
  **merchant_id** | **String** | The merchant ID. | [optional]
9
- **token_id** | **String** | The ID of the cryptocurrency used for payment. |
10
- **chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. |
9
+ **token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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; |
10
+ **chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. Supported chains: - USDC: &#x60;ETH&#x60;, &#x60;ARBITRUM&#x60;, &#x60;SOL&#x60;, &#x60;BASE&#x60;, &#x60;MATIC&#x60;, &#x60;BSC&#x60; - USDT: &#x60;TRON&#x60;, &#x60;ETH&#x60;, &#x60;ARBITRUM&#x60;, &#x60;SOL&#x60;, &#x60;BASE&#x60;, &#x60;MATIC&#x60;, &#x60;BSC&#x60; |
11
11
  **payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
12
12
  **receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
13
13
  **currency** | **String** | The fiat currency of the order. |
@@ -4,80 +4,27 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**createBankAccount**](PaymentApi.md#createBankAccount) | **POST** /payments/bank_accounts | Create bank account
8
7
  [**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
9
8
  [**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
10
9
  [**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
11
10
  [**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
12
11
  [**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
13
- [**getPaymentOrderAddressInfo**](PaymentApi.md#getPaymentOrderAddressInfo) | **GET** /payments/orders/address_info | Get pay-in order&#39;s receiving address info
14
12
  [**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
15
13
  [**getRefundDetailById**](PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
16
14
  [**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
17
15
  [**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
18
16
  [**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
19
17
  [**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
18
+ [**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
20
19
  [**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
21
20
  [**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
21
+ [**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List all supported tokens
22
22
  [**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
23
- [**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
24
23
  [**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
25
24
  [**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
26
25
 
27
26
 
28
27
 
29
- ## createBankAccount
30
-
31
- > BankAccount createBankAccount(opts)
32
-
33
- Create bank account
34
-
35
- This operation registers a bank account for payment settlement. Upon successful registration, the bank account details can be retrieved using the assigned bank account ID.
36
-
37
- ### Example
38
-
39
- ```javascript
40
- const CoboWaas2 = require('@cobo/cobo-waas2');
41
- // Initialize the API client
42
- const apiClient = CoboWaas2.ApiClient.instance
43
- // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
44
- apiClient.setEnv(CoboWaas2.Env.DEV);
45
- // Replace `<YOUR_PRIVATE_KEY>` with your private key
46
- apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
47
- // Call the API
48
- const apiInstance = new CoboWaas2.PaymentApi();
49
- const opts = {
50
- 'CreateBankAccountRequest': new CoboWaas2.CreateBankAccountRequest()
51
- };
52
- apiInstance.createBankAccount(opts).then((data) => {
53
- console.log('API called successfully. Returned data: ' + data);
54
- }, (error) => {
55
- console.error(error);
56
- });
57
-
58
- ```
59
-
60
- ### Parameters
61
-
62
-
63
- Name | Type | Description | Notes
64
- ------------- | ------------- | ------------- | -------------
65
- **CreateBankAccountRequest** | [**CreateBankAccountRequest**](CreateBankAccountRequest.md)| The request body to register a bank account. | [optional]
66
-
67
- ### Return type
68
-
69
- [**BankAccount**](BankAccount.md)
70
-
71
- ### Authorization
72
-
73
- [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
74
-
75
- ### HTTP request headers
76
-
77
- - **Content-Type**: application/json
78
- - **Accept**: application/json
79
-
80
-
81
28
  ## createMerchant
82
29
 
83
30
  > Merchant createMerchant(opts)
@@ -338,60 +285,6 @@ Name | Type | Description | Notes
338
285
  - **Accept**: application/json
339
286
 
340
287
 
341
- ## getPaymentOrderAddressInfo
342
-
343
- > OrderAddressInfo getPaymentOrderAddressInfo(opts)
344
-
345
- Get pay-in order&#39;s receiving address info
346
-
347
- This operation retrieves the detailed information about a specific pay-in address.
348
-
349
- ### Example
350
-
351
- ```javascript
352
- const CoboWaas2 = require('@cobo/cobo-waas2');
353
- // Initialize the API client
354
- const apiClient = CoboWaas2.ApiClient.instance
355
- // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
356
- apiClient.setEnv(CoboWaas2.Env.DEV);
357
- // Replace `<YOUR_PRIVATE_KEY>` with your private key
358
- apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
359
- // Call the API
360
- const apiInstance = new CoboWaas2.PaymentApi();
361
- const opts = {
362
- 'token_id': "ETH_USDT",
363
- 'address': "0x9876543210abcdef1234567890abcdef12345678"
364
- };
365
- apiInstance.getPaymentOrderAddressInfo(opts).then((data) => {
366
- console.log('API called successfully. Returned data: ' + data);
367
- }, (error) => {
368
- console.error(error);
369
- });
370
-
371
- ```
372
-
373
- ### Parameters
374
-
375
-
376
- Name | Type | Description | Notes
377
- ------------- | ------------- | ------------- | -------------
378
- **token_id** | **String**| The token ID, which identifies the cryptocurrency. Supported values: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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; | [optional]
379
- **address** | **String**| The receiving address. | [optional]
380
-
381
- ### Return type
382
-
383
- [**OrderAddressInfo**](OrderAddressInfo.md)
384
-
385
- ### Authorization
386
-
387
- [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
388
-
389
- ### HTTP request headers
390
-
391
- - **Content-Type**: Not defined
392
- - **Accept**: application/json
393
-
394
-
395
288
  ## getPaymentOrderDetailById
396
289
 
397
290
  > Order getPaymentOrderDetailById(order_id)
@@ -533,8 +426,8 @@ apiInstance.getRefunds(opts).then((data) => {
533
426
  Name | Type | Description | Notes
534
427
  ------------- | ------------- | ------------- | -------------
535
428
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
536
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;before&#x60; to the ID of Object C (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object A. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. - If you set it to &#x60;infinity&#x60;, the last page of data is returned. | [optional]
537
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;after&#x60; to the ID of Object A (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object C. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. | [optional]
429
+ **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]
430
+ **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]
538
431
  **merchant_id** | **String**| The merchant ID. | [optional]
539
432
  **request_id** | **String**| The request ID. | [optional]
540
433
 
@@ -662,7 +555,7 @@ Name | Type | Description | Notes
662
555
 
663
556
  List all bank accounts
664
557
 
665
- This operation retrieves the information of all bank accounts registered.
558
+ This operation retrieves the information of all bank accounts you have registered for payment settlement. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new bank account.
666
559
 
667
560
  ### Example
668
561
 
@@ -702,6 +595,58 @@ This endpoint does not need any parameter.
702
595
  - **Accept**: application/json
703
596
 
704
597
 
598
+ ## listCryptoAddresses
599
+
600
+ > [CryptoAddress] listCryptoAddresses(opts)
601
+
602
+ List crypto addresses
603
+
604
+ Retrieve a list of cryptocurrency addresses previously created for a given &#x60;token_id&#x60;.
605
+
606
+ ### Example
607
+
608
+ ```javascript
609
+ const CoboWaas2 = require('@cobo/cobo-waas2');
610
+ // Initialize the API client
611
+ const apiClient = CoboWaas2.ApiClient.instance
612
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
613
+ apiClient.setEnv(CoboWaas2.Env.DEV);
614
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
615
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
616
+ // Call the API
617
+ const apiInstance = new CoboWaas2.PaymentApi();
618
+ const opts = {
619
+ 'token_id': "ETH_USDT"
620
+ };
621
+ apiInstance.listCryptoAddresses(opts).then((data) => {
622
+ console.log('API called successfully. Returned data: ' + data);
623
+ }, (error) => {
624
+ console.error(error);
625
+ });
626
+
627
+ ```
628
+
629
+ ### Parameters
630
+
631
+
632
+ Name | Type | Description | Notes
633
+ ------------- | ------------- | ------------- | -------------
634
+ **token_id** | **String**| The token ID, which identifies the cryptocurrency. Supported values: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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; | [optional]
635
+
636
+ ### Return type
637
+
638
+ [**[CryptoAddress]**](CryptoAddress.md)
639
+
640
+ ### Authorization
641
+
642
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
643
+
644
+ ### HTTP request headers
645
+
646
+ - **Content-Type**: Not defined
647
+ - **Accept**: application/json
648
+
649
+
705
650
  ## listMerchants
706
651
 
707
652
  > ListMerchants200Response listMerchants(opts)
@@ -743,8 +688,8 @@ apiInstance.listMerchants(opts).then((data) => {
743
688
  Name | Type | Description | Notes
744
689
  ------------- | ------------- | ------------- | -------------
745
690
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
746
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;before&#x60; to the ID of Object C (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object A. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. - If you set it to &#x60;infinity&#x60;, the last page of data is returned. | [optional]
747
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;after&#x60; to the ID of Object A (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object C. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. | [optional]
691
+ **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]
692
+ **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]
748
693
  **keyword** | **String**| A search term used for fuzzy matching of merchant names. | [optional]
749
694
  **wallet_id** | **String**| The wallet ID. | [optional]
750
695
 
@@ -786,7 +731,8 @@ const opts = {
786
731
  'limit': 10,
787
732
  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
788
733
  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
789
- 'merchant_id': "M1001"
734
+ 'merchant_id': "M1001",
735
+ 'psp_order_id': "P20240201001"
790
736
  };
791
737
  apiInstance.listPaymentOrders(opts).then((data) => {
792
738
  console.log('API called successfully. Returned data: ' + data);
@@ -802,9 +748,10 @@ apiInstance.listPaymentOrders(opts).then((data) => {
802
748
  Name | Type | Description | Notes
803
749
  ------------- | ------------- | ------------- | -------------
804
750
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
805
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;before&#x60; to the ID of Object C (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object A. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. - If you set it to &#x60;infinity&#x60;, the last page of data is returned. | [optional]
806
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;after&#x60; to the ID of Object A (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object C. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. | [optional]
751
+ **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]
752
+ **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]
807
753
  **merchant_id** | **String**| The merchant ID. | [optional]
754
+ **psp_order_id** | **String**| The PSP order ID. | [optional]
808
755
 
809
756
  ### Return type
810
757
 
@@ -820,13 +767,13 @@ Name | Type | Description | Notes
820
767
  - **Accept**: application/json
821
768
 
822
769
 
823
- ## listSettlementRequests
770
+ ## listPaymentSupportedTokens
824
771
 
825
- > ListSettlementRequests200Response listSettlementRequests(opts)
772
+ > [SupportedToken] listPaymentSupportedTokens()
826
773
 
827
- List all settlement requests
774
+ List all supported tokens
828
775
 
829
- This operation retrieves the information of all settlement requests.
776
+ This operation retrieves the information of all supported tokens.
830
777
 
831
778
  ### Example
832
779
 
@@ -840,13 +787,7 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
840
787
  apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
841
788
  // Call the API
842
789
  const apiInstance = new CoboWaas2.PaymentApi();
843
- const opts = {
844
- 'limit': 10,
845
- 'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
846
- 'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
847
- 'request_id': "random_request_id"
848
- };
849
- apiInstance.listSettlementRequests(opts).then((data) => {
790
+ apiInstance.listPaymentSupportedTokens().then((data) => {
850
791
  console.log('API called successfully. Returned data: ' + data);
851
792
  }, (error) => {
852
793
  console.error(error);
@@ -856,17 +797,11 @@ apiInstance.listSettlementRequests(opts).then((data) => {
856
797
 
857
798
  ### Parameters
858
799
 
859
-
860
- Name | Type | Description | Notes
861
- ------------- | ------------- | ------------- | -------------
862
- **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
863
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;before&#x60; to the ID of Object C (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object A. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. - If you set it to &#x60;infinity&#x60;, the last page of data is returned. | [optional]
864
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set &#x60;after&#x60; to the ID of Object A (&#x60;RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk&#x60;), the response will include Object B and Object C. **Notes**: - If you set both &#x60;after&#x60; and &#x60;before&#x60;, an error will occur. - If you leave both &#x60;before&#x60; and &#x60;after&#x60; empty, the first page of data is returned. | [optional]
865
- **request_id** | **String**| The request ID. | [optional]
800
+ This endpoint does not need any parameter.
866
801
 
867
802
  ### Return type
868
803
 
869
- [**ListSettlementRequests200Response**](ListSettlementRequests200Response.md)
804
+ [**[SupportedToken]**](SupportedToken.md)
870
805
 
871
806
  ### Authorization
872
807
 
@@ -878,13 +813,13 @@ Name | Type | Description | Notes
878
813
  - **Accept**: application/json
879
814
 
880
815
 
881
- ## updateBankAccountById
816
+ ## listSettlementRequests
882
817
 
883
- > BankAccount updateBankAccountById(bank_account_id, opts)
818
+ > ListSettlementRequests200Response listSettlementRequests(opts)
884
819
 
885
- Update bank account
820
+ List all settlement requests
886
821
 
887
- This operation updates the information of an existing bank account.
822
+ This operation retrieves the information of all settlement requests.
888
823
 
889
824
  ### Example
890
825
 
@@ -898,11 +833,13 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
898
833
  apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
899
834
  // Call the API
900
835
  const apiInstance = new CoboWaas2.PaymentApi();
901
- const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
902
836
  const opts = {
903
- 'CreateBankAccountRequest': new CoboWaas2.CreateBankAccountRequest()
837
+ 'limit': 10,
838
+ 'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
839
+ 'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
840
+ 'request_id': "random_request_id"
904
841
  };
905
- apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
842
+ apiInstance.listSettlementRequests(opts).then((data) => {
906
843
  console.log('API called successfully. Returned data: ' + data);
907
844
  }, (error) => {
908
845
  console.error(error);
@@ -915,12 +852,14 @@ apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
915
852
 
916
853
  Name | Type | Description | Notes
917
854
  ------------- | ------------- | ------------- | -------------
918
- **bank_account_id** | **String**| The bank account ID. |
919
- **CreateBankAccountRequest** | [**CreateBankAccountRequest**](CreateBankAccountRequest.md)| The request body for updating an existing bank account. | [optional]
855
+ **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
856
+ **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]
857
+ **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]
858
+ **request_id** | **String**| The request ID. | [optional]
920
859
 
921
860
  ### Return type
922
861
 
923
- [**BankAccount**](BankAccount.md)
862
+ [**ListSettlementRequests200Response**](ListSettlementRequests200Response.md)
924
863
 
925
864
  ### Authorization
926
865
 
@@ -928,7 +867,7 @@ Name | Type | Description | Notes
928
867
 
929
868
  ### HTTP request headers
930
869
 
931
- - **Content-Type**: application/json
870
+ - **Content-Type**: Not defined
932
871
  - **Accept**: application/json
933
872
 
934
873
 
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
7
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. |
8
8
  **order_id** | **String** | The order ID. |
9
9
  **merchant_id** | **String** | The merchant ID. | [optional]
10
- **token_id** | **String** | The ID of the cryptocurrency used for payment. |
11
- **chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. |
10
+ **token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: &#x60;ETH_USDC&#x60;, &#x60;ARBITRUM_USDC&#x60;, &#x60;SOL_USDC&#x60;, &#x60;BASE_USDC&#x60;, &#x60;MATIC_USDC&#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; |
11
+ **chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. Supported chains: - USDC: &#x60;ETH&#x60;, &#x60;ARBITRUM&#x60;, &#x60;SOL&#x60;, &#x60;BASE&#x60;, &#x60;MATIC&#x60;, &#x60;BSC&#x60; - USDT: &#x60;TRON&#x60;, &#x60;ETH&#x60;, &#x60;ARBITRUM&#x60;, &#x60;SOL&#x60;, &#x60;BASE&#x60;, &#x60;MATIC&#x60;, &#x60;BSC&#x60; |
12
12
  **payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
13
13
  **receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
14
14
  **currency** | **String** | The fiat currency of the order. |
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.PayoutChannel
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Crypto` (value: `"Crypto"`)
7
+
8
+ * `OffRamp` (value: `"OffRamp"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.PolicyAction
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **action_type** | [**PolicyActionType**](PolicyActionType.md) | |
8
+ **content** | [**PolicyActionContent**](PolicyActionContent.md) | | [optional]
9
+
10
+