@cobo/cobo-waas2 1.28.0 → 1.30.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 (238) hide show
  1. package/README.md +88 -16
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AutoSweepApi.js +2 -2
  4. package/dist/api/ComplianceApi.js +144 -4
  5. package/dist/api/FeeStationApi.js +2 -2
  6. package/dist/api/GraphQLApi.js +85 -0
  7. package/dist/api/PaymentApi.js +1161 -154
  8. package/dist/api/StakingsApi.js +2 -2
  9. package/dist/api/SwapsApi.js +3 -0
  10. package/dist/api/TransactionsApi.js +6 -6
  11. package/dist/api/WalletsApi.js +18 -18
  12. package/dist/index.js +357 -28
  13. package/dist/model/AddressRiskLevel.js +71 -0
  14. package/dist/model/AddressesEventData.js +13 -3
  15. package/dist/model/{AllocationRecord.js → AllocationItem.js} +38 -35
  16. package/dist/model/{AllocationRequest.js → AllocationParam.js} +29 -26
  17. package/dist/model/BalanceUpdateInfoEventData.js +13 -3
  18. package/dist/model/BatchAllocation.js +12 -12
  19. package/dist/model/BatchAllocationDetail.js +15 -17
  20. package/dist/model/BridgingFee.js +3 -3
  21. package/dist/model/ChainsEventData.js +13 -3
  22. package/dist/model/CommissionFee.js +2 -2
  23. package/dist/model/ComplianceDispositionUpdateEventData.js +13 -3
  24. package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +346 -0
  25. package/dist/model/ComplianceKytScreeningsUpdateEventData.js +13 -3
  26. package/dist/model/ContractCallParams.js +3 -3
  27. package/dist/model/CounterpartyWalletAddressDetail.js +2 -2
  28. package/dist/model/CreateBatchAllocationRequest.js +19 -19
  29. package/dist/model/CreateBulkSendRequest.js +167 -0
  30. package/dist/model/CreateBulkSendRequestPayoutParamsInner.js +153 -0
  31. package/dist/model/CreateCounterpartyEntry201Response.js +143 -0
  32. package/dist/model/CreateCounterpartyEntryRequest.js +141 -0
  33. package/dist/model/CreateDestinationEntry201Response.js +172 -0
  34. package/dist/model/CreateDestinationEntryRequest.js +172 -0
  35. package/dist/model/CreateKyaScreeningsBody.js +129 -0
  36. package/dist/model/CreateMerchantRequest.js +1 -1
  37. package/dist/model/CreatePaymentOrderRequest.js +17 -15
  38. package/dist/model/CreatePayoutRequest.js +35 -28
  39. package/dist/model/CreateRefundRequest.js +2 -2
  40. package/dist/model/CreateReportRequest.js +156 -0
  41. package/dist/model/CreateTopUpAddresses.js +139 -0
  42. package/dist/model/CreateTopUpAddresses201Response.js +107 -0
  43. package/dist/model/CreateWalletAddress.js +2 -2
  44. package/dist/model/DeleteCounterpartyById200Response.js +110 -0
  45. package/dist/model/DeleteCounterpartyEntry200Response.js +110 -0
  46. package/dist/model/DeleteDestinationById200Response.js +110 -0
  47. package/dist/model/DeleteDestinationEntry200Response.js +110 -0
  48. package/dist/model/EntryType.js +61 -0
  49. package/dist/model/GetCounterpartyEntry200Response.js +90 -0
  50. package/dist/model/GetDestinationEntry200Response.js +106 -0
  51. package/dist/model/{ListPayoutItems200Response.js → GetReports200Response.js} +22 -22
  52. package/dist/model/KyaRiskAssessment.js +151 -0
  53. package/dist/model/KyaRiskDetail.js +126 -0
  54. package/dist/model/KyaRiskLevel.js +66 -0
  55. package/dist/model/KyaScreeningRequest.js +154 -0
  56. package/dist/model/KyaScreeningResult.js +222 -0
  57. package/dist/model/KyaScreeningResultRiskAssessment.js +171 -0
  58. package/dist/model/KyaScreeningStatus.js +71 -0
  59. package/dist/model/KyaScreeningsEventData.js +174 -0
  60. package/dist/model/LinkDisplayInfo.js +1 -1
  61. package/dist/model/{ListAllocations200Response.js → ListAllocationItems200Response.js} +22 -22
  62. package/dist/model/ListBulkSendItems200Response.js +123 -0
  63. package/dist/model/ListCounterpartyEntries200Response.js +123 -0
  64. package/dist/model/ListDestinationEntries200Response.js +153 -0
  65. package/dist/model/ListKyaScreenings200Response.js +145 -0
  66. package/dist/model/MPCVaultEventData.js +13 -3
  67. package/dist/model/MerchantBalance.js +4 -4
  68. package/dist/model/Order.js +10 -10
  69. package/dist/model/OrderLinkBusinessInfo.js +22 -16
  70. package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +2 -4
  71. package/dist/model/OrderLinkBusinessInfoPayableAmountsInner.js +4 -4
  72. package/dist/model/PaymentAddressUpdateEventData.js +13 -3
  73. package/dist/model/PaymentAllocationAmount.js +2 -2
  74. package/dist/model/PaymentBulkSend.js +182 -0
  75. package/dist/model/PaymentBulkSendEvent.js +359 -0
  76. package/dist/model/PaymentBulkSendExecutionMode.js +61 -0
  77. package/dist/model/PaymentBulkSendItem.js +190 -0
  78. package/dist/model/{PaymentPayoutItemStatus.js → PaymentBulkSendItemStatus.js} +11 -11
  79. package/dist/model/PaymentBulkSendItemValidationStatus.js +66 -0
  80. package/dist/model/PaymentBulkSendStatus.js +81 -0
  81. package/dist/model/PaymentEstimateFeeRequest.js +13 -0
  82. package/dist/model/PaymentFeeType.js +15 -0
  83. package/dist/model/PaymentOrderEventData.js +31 -21
  84. package/dist/model/PaymentPayout.js +64 -46
  85. package/dist/model/PaymentPayoutDetail.js +166 -52
  86. package/dist/model/PaymentPayoutEvent.js +152 -80
  87. package/dist/model/PaymentPayoutItem.js +9 -166
  88. package/dist/model/PaymentPayoutParam.js +6 -46
  89. package/dist/model/PaymentPayoutRecipientInfo.js +126 -0
  90. package/dist/model/PaymentPayoutStatus.js +9 -4
  91. package/dist/model/PaymentRefundEventData.js +13 -3
  92. package/dist/model/PaymentSettlementEvent.js +13 -3
  93. package/dist/model/PaymentTransactionEventData.js +13 -3
  94. package/dist/model/PspBalance.js +4 -4
  95. package/dist/model/RefundLinkBusinessInfo.js +1 -1
  96. package/dist/model/Report.js +209 -0
  97. package/dist/model/ReportExportFormat.js +66 -0
  98. package/dist/model/ReportStatus.js +61 -0
  99. package/dist/model/ReportType.js +121 -0
  100. package/dist/model/SuspendedTokenEventData.js +13 -3
  101. package/dist/model/TSSRequestWebhookEventData.js +13 -3
  102. package/dist/model/TokenListingEventData.js +13 -3
  103. package/dist/model/TokensEventData.js +13 -3
  104. package/dist/model/TransactionCoboCategory.js +5 -0
  105. package/dist/model/TransactionExtraType.js +5 -0
  106. package/dist/model/TransactionWalletConnectInfo.js +146 -0
  107. package/dist/model/TransactionWebhookEventData.js +13 -3
  108. package/dist/model/TransferParams.js +2 -2
  109. package/dist/model/UpdateCounterpartyRequest.js +160 -0
  110. package/dist/model/UpdateDestinationEntry200Response.js +90 -0
  111. package/dist/model/UpdateDestinationEntryRequest.js +135 -0
  112. package/dist/model/UpdateDestinationRequest.js +173 -0
  113. package/dist/model/UpdateMerchantByIdRequest.js +1 -1
  114. package/dist/model/WalletAddress.js +20 -2
  115. package/dist/model/WalletInfoEventData.js +13 -3
  116. package/dist/model/WebhookEventData.js +121 -28
  117. package/dist/model/WebhookEventDataType.js +12 -2
  118. package/dist/model/WebhookEventType.js +15 -0
  119. package/docs/AddressRiskLevel.md +16 -0
  120. package/docs/AddressesEventData.md +5 -1
  121. package/docs/AllocationItem.md +15 -0
  122. package/docs/AllocationParam.md +13 -0
  123. package/docs/AutoSweepApi.md +1 -1
  124. package/docs/BalanceUpdateInfoEventData.md +5 -1
  125. package/docs/BatchAllocation.md +2 -2
  126. package/docs/BatchAllocationDetail.md +1 -1
  127. package/docs/BridgingFee.md +2 -2
  128. package/docs/ChainsEventData.md +5 -1
  129. package/docs/CommissionFee.md +1 -1
  130. package/docs/ComplianceApi.md +163 -0
  131. package/docs/ComplianceDispositionUpdateEventData.md +5 -1
  132. package/docs/ComplianceKyaScreeningsUpdateEventData.md +64 -0
  133. package/docs/ComplianceKytScreeningsUpdateEventData.md +5 -1
  134. package/docs/ContractCallParams.md +2 -2
  135. package/docs/CounterpartyWalletAddressDetail.md +1 -1
  136. package/docs/CreateBatchAllocationRequest.md +2 -2
  137. package/docs/CreateBulkSendRequest.md +12 -0
  138. package/docs/CreateBulkSendRequestPayoutParamsInner.md +12 -0
  139. package/docs/CreateCounterpartyEntry201Response.md +10 -0
  140. package/docs/CreateCounterpartyEntryRequest.md +10 -0
  141. package/docs/CreateDestinationEntry201Response.md +11 -0
  142. package/docs/CreateDestinationEntryRequest.md +11 -0
  143. package/docs/CreateKyaScreeningsBody.md +9 -0
  144. package/docs/CreateMerchantRequest.md +1 -1
  145. package/docs/CreatePaymentOrderRequest.md +11 -11
  146. package/docs/CreatePayoutRequest.md +4 -4
  147. package/docs/CreateRefundRequest.md +2 -2
  148. package/docs/CreateReportRequest.md +13 -0
  149. package/docs/CreateTopUpAddresses.md +11 -0
  150. package/docs/CreateTopUpAddresses201Response.md +9 -0
  151. package/docs/CreateWalletAddress.md +1 -1
  152. package/docs/DeleteCounterpartyById200Response.md +9 -0
  153. package/docs/DeleteCounterpartyEntry200Response.md +9 -0
  154. package/docs/DeleteDestinationById200Response.md +9 -0
  155. package/docs/DeleteDestinationEntry200Response.md +9 -0
  156. package/docs/EntryType.md +12 -0
  157. package/docs/FeeStationApi.md +1 -1
  158. package/docs/GetCounterpartyEntry200Response.md +9 -0
  159. package/docs/GetDestinationEntry200Response.md +10 -0
  160. package/docs/{ListAllocations200Response.md → GetReports200Response.md} +2 -2
  161. package/docs/GraphQLApi.md +61 -0
  162. package/docs/KyaRiskAssessment.md +11 -0
  163. package/docs/KyaRiskDetail.md +10 -0
  164. package/docs/KyaRiskLevel.md +14 -0
  165. package/docs/KyaScreeningRequest.md +12 -0
  166. package/docs/KyaScreeningResult.md +17 -0
  167. package/docs/KyaScreeningResultRiskAssessment.md +11 -0
  168. package/docs/KyaScreeningStatus.md +16 -0
  169. package/docs/KyaScreeningsEventData.md +14 -0
  170. package/docs/LinkDisplayInfo.md +1 -1
  171. package/docs/{ListPayoutItems200Response.md → ListAllocationItems200Response.md} +2 -2
  172. package/docs/ListBulkSendItems200Response.md +10 -0
  173. package/docs/ListCounterpartyEntries200Response.md +10 -0
  174. package/docs/ListDestinationEntries200Response.md +11 -0
  175. package/docs/ListKyaScreenings200Response.md +10 -0
  176. package/docs/MPCVaultEventData.md +5 -1
  177. package/docs/MerchantBalance.md +4 -4
  178. package/docs/Order.md +8 -8
  179. package/docs/OrderLinkBusinessInfo.md +11 -11
  180. package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +2 -2
  181. package/docs/OrderLinkBusinessInfoPayableAmountsInner.md +2 -2
  182. package/docs/PaymentAddressUpdateEventData.md +5 -1
  183. package/docs/PaymentAllocationAmount.md +1 -1
  184. package/docs/PaymentApi.md +1296 -198
  185. package/docs/PaymentBulkSend.md +15 -0
  186. package/docs/PaymentBulkSendEvent.md +65 -0
  187. package/docs/PaymentBulkSendExecutionMode.md +12 -0
  188. package/docs/PaymentBulkSendItem.md +15 -0
  189. package/docs/{PaymentPayoutItemStatus.md → PaymentBulkSendItemStatus.md} +3 -3
  190. package/docs/PaymentBulkSendItemValidationStatus.md +14 -0
  191. package/docs/PaymentBulkSendStatus.md +20 -0
  192. package/docs/PaymentEstimateFeeRequest.md +1 -0
  193. package/docs/PaymentFeeType.md +6 -0
  194. package/docs/PaymentOrderEventData.md +13 -9
  195. package/docs/PaymentPayout.md +8 -7
  196. package/docs/PaymentPayoutDetail.md +10 -8
  197. package/docs/PaymentPayoutEvent.md +15 -9
  198. package/docs/PaymentPayoutItem.md +2 -13
  199. package/docs/PaymentPayoutParam.md +1 -4
  200. package/docs/PaymentPayoutRecipientInfo.md +12 -0
  201. package/docs/PaymentPayoutStatus.md +4 -2
  202. package/docs/PaymentRefundEventData.md +5 -1
  203. package/docs/PaymentSettlementEvent.md +5 -1
  204. package/docs/PaymentTransactionEventData.md +5 -1
  205. package/docs/PspBalance.md +4 -4
  206. package/docs/RefundLinkBusinessInfo.md +1 -1
  207. package/docs/Report.md +17 -0
  208. package/docs/ReportExportFormat.md +14 -0
  209. package/docs/ReportStatus.md +12 -0
  210. package/docs/ReportType.md +36 -0
  211. package/docs/StakingsApi.md +1 -1
  212. package/docs/SuspendedTokenEventData.md +5 -1
  213. package/docs/SwapsApi.md +2 -0
  214. package/docs/TSSRequestWebhookEventData.md +5 -1
  215. package/docs/TokenListingEventData.md +5 -1
  216. package/docs/TokensEventData.md +5 -1
  217. package/docs/TransactionCoboCategory.md +2 -0
  218. package/docs/TransactionExtraType.md +2 -0
  219. package/docs/TransactionWalletConnectInfo.md +12 -0
  220. package/docs/TransactionWebhookEventData.md +5 -1
  221. package/docs/TransactionsApi.md +3 -3
  222. package/docs/TransferParams.md +1 -1
  223. package/docs/UpdateCounterpartyRequest.md +13 -0
  224. package/docs/UpdateDestinationEntry200Response.md +9 -0
  225. package/docs/UpdateDestinationEntryRequest.md +11 -0
  226. package/docs/UpdateDestinationRequest.md +14 -0
  227. package/docs/UpdateMerchantByIdRequest.md +1 -1
  228. package/docs/WalletAddress.md +3 -1
  229. package/docs/WalletInfoEventData.md +5 -1
  230. package/docs/WalletsApi.md +9 -9
  231. package/docs/WebhookEventData.md +28 -18
  232. package/docs/WebhookEventDataType.md +5 -1
  233. package/docs/WebhookEventType.md +6 -0
  234. package/package.json +1 -1
  235. package/dist/model/PaymentPayoutItemDetail.js +0 -298
  236. package/docs/AllocationRecord.md +0 -15
  237. package/docs/AllocationRequest.md +0 -13
  238. package/docs/PaymentPayoutItemDetail.md +0 -22
@@ -0,0 +1,15 @@
1
+ # CoboWaas2.PaymentBulkSend
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **bulk_send_id** | **String** | The bulk send ID. |
8
+ **source_account** | **String** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. |
9
+ **description** | **String** | The description for the entire bulk send batch. | [optional]
10
+ **execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | |
11
+ **status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) | |
12
+ **created_timestamp** | **Number** | The created time of the bulk send, represented as a UNIX timestamp in seconds. |
13
+ **updated_timestamp** | **Number** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. |
14
+
15
+
@@ -0,0 +1,65 @@
1
+ # CoboWaas2.PaymentBulkSendEvent
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
8
+ **bulk_send_id** | **String** | The bulk send ID. |
9
+ **source_account** | **String** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. |
10
+ **description** | **String** | The description for the entire bulk send batch. | [optional]
11
+ **execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | |
12
+ **status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) | |
13
+ **created_timestamp** | **Number** | The created time of the bulk send, represented as a UNIX timestamp in seconds. |
14
+ **updated_timestamp** | **Number** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. |
15
+
16
+
17
+
18
+ ## Enum: DataTypeEnum
19
+
20
+
21
+ * `Transaction` (value: `"Transaction"`)
22
+
23
+ * `TSSRequest` (value: `"TSSRequest"`)
24
+
25
+ * `Addresses` (value: `"Addresses"`)
26
+
27
+ * `WalletInfo` (value: `"WalletInfo"`)
28
+
29
+ * `MPCVault` (value: `"MPCVault"`)
30
+
31
+ * `Chains` (value: `"Chains"`)
32
+
33
+ * `Tokens` (value: `"Tokens"`)
34
+
35
+ * `TokenListing` (value: `"TokenListing"`)
36
+
37
+ * `PaymentOrder` (value: `"PaymentOrder"`)
38
+
39
+ * `PaymentRefund` (value: `"PaymentRefund"`)
40
+
41
+ * `PaymentSettlement` (value: `"PaymentSettlement"`)
42
+
43
+ * `PaymentTransaction` (value: `"PaymentTransaction"`)
44
+
45
+ * `PaymentAddressUpdate` (value: `"PaymentAddressUpdate"`)
46
+
47
+ * `PaymentPayout` (value: `"PaymentPayout"`)
48
+
49
+ * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
50
+
51
+ * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
52
+
53
+ * `SuspendedToken` (value: `"SuspendedToken"`)
54
+
55
+ * `ComplianceDisposition` (value: `"ComplianceDisposition"`)
56
+
57
+ * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
58
+
59
+ * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
60
+
61
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
62
+
63
+
64
+
65
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.PaymentBulkSendExecutionMode
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Strict` (value: `"Strict"`)
7
+
8
+ * `Partial` (value: `"Partial"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+
@@ -0,0 +1,15 @@
1
+ # CoboWaas2.PaymentBulkSendItem
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **bulk_send_item_id** | **String** | The payout item ID. |
8
+ **token_id** | **String** | The token ID of the payout item. |
9
+ **receiving_address** | **String** | The receiving address of the payout item. |
10
+ **amount** | **String** | The amount of the payout item. |
11
+ **description** | **String** | The note of the payout item. | [optional]
12
+ **status** | [**PaymentBulkSendItemStatus**](PaymentBulkSendItemStatus.md) | |
13
+ **validation_status** | [**PaymentBulkSendItemValidationStatus**](PaymentBulkSendItemValidationStatus.md) | |
14
+
15
+
@@ -1,4 +1,4 @@
1
- # CoboWaas2.PaymentPayoutItemStatus
1
+ # CoboWaas2.PaymentBulkSendItemStatus
2
2
 
3
3
  ## Enum
4
4
 
@@ -9,10 +9,10 @@
9
9
 
10
10
  * `Completed` (value: `"Completed"`)
11
11
 
12
- * `PartiallyCompleted` (value: `"PartiallyCompleted"`)
13
-
14
12
  * `Failed` (value: `"Failed"`)
15
13
 
14
+ * `NotExecuted` (value: `"NotExecuted"`)
15
+
16
16
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
17
17
 
18
18
 
@@ -0,0 +1,14 @@
1
+ # CoboWaas2.PaymentBulkSendItemValidationStatus
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Pending` (value: `"Pending"`)
7
+
8
+ * `Validated` (value: `"Validated"`)
9
+
10
+ * `ValidationFailed` (value: `"ValidationFailed"`)
11
+
12
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
13
+
14
+
@@ -0,0 +1,20 @@
1
+ # CoboWaas2.PaymentBulkSendStatus
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Pending` (value: `"Pending"`)
7
+
8
+ * `Validating` (value: `"Validating"`)
9
+
10
+ * `Transferring` (value: `"Transferring"`)
11
+
12
+ * `Completed` (value: `"Completed"`)
13
+
14
+ * `PartiallyCompleted` (value: `"PartiallyCompleted"`)
15
+
16
+ * `Failed` (value: `"Failed"`)
17
+
18
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
19
+
20
+
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **fee_type** | [**PaymentFeeType**](PaymentFeeType.md) | | [optional]
8
8
  **estimate_fees** | [**[PaymentEstimateFee]**](PaymentEstimateFee.md) | A list of token IDs and amounts for which fees will be calculated. |
9
+ **recipient_token_id** | **String** | The token ID that the recipient will receive. Required only when `fee_type` is `CryptoPayoutBridge`. | [optional]
9
10
 
10
11
 
@@ -11,6 +11,12 @@
11
11
 
12
12
  * `OffRampSettlement` (value: `"OffRampSettlement"`)
13
13
 
14
+ * `CryptoPayout` (value: `"CryptoPayout"`)
15
+
16
+ * `CryptoPayoutBridge` (value: `"CryptoPayoutBridge"`)
17
+
18
+ * `OffRampPayout` (value: `"OffRampPayout"`)
19
+
14
20
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
15
21
 
16
22
 
@@ -4,19 +4,19 @@
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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. |
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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
8
8
  **order_id** | **String** | The order ID. |
9
9
  **merchant_id** | **String** | The merchant ID. | [optional]
10
10
  **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
11
11
  **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
12
- **pricing_currency** | **String** | The fiat currency of the order. | [optional]
13
- **pricing_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional]
14
- **fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. |
12
+ **pricing_currency** | **String** | The pricing currency of the order. | [optional]
13
+ **pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). | [optional]
14
+ **fee_amount** | **String** | The developer fee for the order. It is added to the base amount to determine the final charge. |
15
15
  **payable_currency** | **String** | The ID of the cryptocurrency used for payment. | [optional]
16
16
  **chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. |
17
17
  **payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
18
- **exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
19
- **amount_tolerance** | **String** | Allowed amount deviation. | [optional]
18
+ **exchange_rate** | **String** | The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`. <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note> |
19
+ **amount_tolerance** | **String** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional]
20
20
  **receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
21
21
  **status** | [**OrderStatus**](OrderStatus.md) | |
22
22
  **received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
@@ -24,9 +24,9 @@ Name | Type | Description | Notes
24
24
  **created_timestamp** | **Number** | The created time of the order, represented as a UNIX timestamp in seconds. | [optional]
25
25
  **updated_timestamp** | **Number** | The updated time of the order, represented as a UNIX timestamp in seconds. | [optional]
26
26
  **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the settlement process. | [optional]
27
- **currency** | **String** | The fiat currency of the order. | [optional]
28
- **order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). | [optional]
29
- **token_id** | **String** | The ID of the cryptocurrency used for payment. | [optional]
27
+ **currency** | **String** | This field has been deprecated. Please use `pricing_currency` instead. | [optional]
28
+ **order_amount** | **String** | This field has been deprecated. Please use `pricing_amount` instead. | [optional]
29
+ **token_id** | **String** | This field has been deprecated. Please use `payable_currency` instead. | [optional]
30
30
  **settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
31
31
 
32
32
 
@@ -62,6 +62,8 @@ Name | Type | Description | Notes
62
62
 
63
63
  * `PaymentPayout` (value: `"PaymentPayout"`)
64
64
 
65
+ * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
66
+
65
67
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
66
68
 
67
69
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -70,6 +72,8 @@ Name | Type | Description | Notes
70
72
 
71
73
  * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
72
74
 
75
+ * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
76
+
73
77
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
74
78
 
75
79
 
@@ -7,13 +7,14 @@ Name | Type | Description | Notes
7
7
  **payout_id** | **String** | The payout ID generated by Cobo. |
8
8
  **request_id** | **String** | The request ID provided by you when creating the payout. |
9
9
  **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
10
- **payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | | [optional]
11
- **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
12
- **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional]
13
- **updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional]
10
+ **source_account** | **String** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional]
11
+ **payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
12
+ **recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
14
13
  **initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
15
- **currency** | **String** | The fiat currency for the payout. | [optional]
16
- **actual_payout_amount** | **String** | The actual amount of this payout. | [optional]
17
- **bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
14
+ **actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
15
+ **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
16
+ **remark** | **String** | A note or comment about the payout. | [optional]
17
+ **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
18
+ **updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
18
19
 
19
20
 
@@ -6,14 +6,16 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **payout_id** | **String** | The payout ID generated by Cobo. |
8
8
  **request_id** | **String** | The request ID provided by you when creating the payout. |
9
- **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
10
- **payout_item_details** | [**[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) | | [optional]
11
- **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional]
12
- **updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional]
9
+ **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
10
+ **source_account** | **String** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional]
11
+ **payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
12
+ **recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
13
13
  **initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
14
- **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
15
- **currency** | **String** | The fiat currency for the payout. | [optional]
16
- **actual_payout_amount** | **String** | The actual amount of this payout. | [optional]
17
- **bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
14
+ **actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
15
+ **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
16
+ **remark** | **String** | A note or comment about the payout. | [optional]
17
+ **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
18
+ **updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
19
+ **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional]
18
20
 
19
21
 
@@ -4,18 +4,20 @@
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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. |
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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
8
8
  **payout_id** | **String** | The payout ID generated by Cobo. |
9
9
  **request_id** | **String** | The request ID provided by you when creating the payout. |
10
- **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
11
- **payout_item_details** | [**[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) | | [optional]
12
- **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional]
13
- **updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional]
10
+ **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | |
11
+ **source_account** | **String** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional]
12
+ **payout_items** | [**[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional]
13
+ **recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional]
14
14
  **initiator** | **String** | The initiator of this payout, usually the user's API key. | [optional]
15
- **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
16
- **currency** | **String** | The fiat currency for the payout. | [optional]
17
- **actual_payout_amount** | **String** | The actual amount of this payout. | [optional]
18
- **bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
15
+ **actual_payout_amount** | **String** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional]
16
+ **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | |
17
+ **remark** | **String** | A note or comment about the payout. | [optional]
18
+ **created_timestamp** | **Number** | The created time of the payout, represented as a UNIX timestamp in seconds. |
19
+ **updated_timestamp** | **Number** | The updated time of the payout, represented as a UNIX timestamp in seconds. |
20
+ **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional]
19
21
 
20
22
 
21
23
 
@@ -50,6 +52,8 @@ Name | Type | Description | Notes
50
52
 
51
53
  * `PaymentPayout` (value: `"PaymentPayout"`)
52
54
 
55
+ * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
56
+
53
57
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
54
58
 
55
59
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -58,6 +62,8 @@ Name | Type | Description | Notes
58
62
 
59
63
  * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
60
64
 
65
+ * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
66
+
61
67
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
62
68
 
63
69
 
@@ -4,19 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **payout_item_id** | **String** | The payout item ID generated by Cobo. |
8
- **payout_id** | **String** | The payout ID generated by Cobo. |
9
- **token_id** | **String** | The token id of the payout item. | [optional]
10
- **chain_id** | **String** | The ID of the blockchain network on which the payout item occurred. | [optional]
11
- **amount** | **String** | The payout item token_id amount. |
12
- **status** | [**PaymentPayoutItemStatus**](PaymentPayoutItemStatus.md) | |
13
- **source_account** | **String** | |
14
- **transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this payout item request. Each transaction represents a separate blockchain operation related to the payout item process. | [optional]
15
- **created_timestamp** | **Number** | The created time of the payout item, represented as a UNIX timestamp in seconds. | [optional]
16
- **updated_timestamp** | **Number** | The updated time of the payout item, represented as a UNIX timestamp in seconds. | [optional]
17
- **crypto_address_id** | **String** | Unique identifier for the pre-approved crypto address, used to reference the address securely in requests. | [optional]
18
- **crypto_address** | **String** | The actual blockchain address to which funds were transferred. | [optional]
19
- **commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
7
+ **token_id** | **String** | The token ID of the payout item. |
8
+ **amount** | **String** | The amount of the payout item. |
20
9
  **bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional]
21
10
 
22
11
 
@@ -4,10 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **source_account** | **String** | |
8
- **token_id** | **String** | Only used in Crypto payout channel. The ID of the cryptocurrency you want to settle. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
7
+ **token_id** | **String** | The ID of the cryptocurrency you want to pay out. Specify this field when `payout_channel` is set to `Crypto`. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
9
8
  **amount** | **String** | The payout cryptocurrency amount. |
10
- **crypto_address_id** | **String** | Only used in Crypto payout channel. The ID of the pre-approved crypto address used for Crypto settlements. - The value must refer to a valid address that has been pre-configured and approved for the given token. | [optional]
11
- **crypto_address** | **String** | Only used in Crypto payout channel. The actual blockchain address to which funds will be transferred. If enable destination whitelist, this address must be associated with a destination. | [optional]
12
9
 
13
10
 
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.PaymentPayoutRecipientInfo
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **address** | **String** | The recipient's wallet address where the payout will be sent. | [optional]
8
+ **token_id** | **String** | The token ID for the cryptocurrency to be sent to the recipient. If `recipient_info.token_id` is on a different chain than `payout_param.token_id`, the token will be automatically bridged to the chain specified in `recipient_info.token_id`. | [optional]
9
+ **currency** | **String** | The fiat currency of the bank account to which the payout will be sent. | [optional]
10
+ **bank_account_id** | **String** | The ID of the bank account to which the payout will be sent. You can retrieve the bank account ID by calling [List destination entries](https://www.cobo.com/payments/en/api-references/payment/list-destination-entries). | [optional]
11
+
12
+
@@ -5,7 +5,9 @@
5
5
 
6
6
  * `Pending` (value: `"Pending"`)
7
7
 
8
- * `Processing` (value: `"Processing"`)
8
+ * `Preparing` (value: `"Preparing"`)
9
+
10
+ * `Transferring` (value: `"Transferring"`)
9
11
 
10
12
  * `Completed` (value: `"Completed"`)
11
13
 
@@ -13,7 +15,7 @@
13
15
 
14
16
  * `Failed` (value: `"Failed"`)
15
17
 
16
- * `Canceled` (value: `"Canceled"`)
18
+ * `RejectedByBank` (value: `"RejectedByBank"`)
17
19
 
18
20
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
19
21
 
@@ -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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. |
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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
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]
@@ -57,6 +57,8 @@ Name | Type | Description | Notes
57
57
 
58
58
  * `PaymentPayout` (value: `"PaymentPayout"`)
59
59
 
60
+ * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
61
+
60
62
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
61
63
 
62
64
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -65,6 +67,8 @@ Name | Type | Description | Notes
65
67
 
66
68
  * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
67
69
 
70
+ * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
71
+
68
72
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
69
73
 
70
74
 
@@ -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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. |
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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
8
8
  **settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
9
9
  **request_id** | **String** | The request ID provided by you when creating the settlement request. |
10
10
  **status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
@@ -52,6 +52,8 @@ Name | Type | Description | Notes
52
52
 
53
53
  * `PaymentPayout` (value: `"PaymentPayout"`)
54
54
 
55
+ * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
56
+
55
57
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
56
58
 
57
59
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -60,6 +62,8 @@ Name | Type | Description | Notes
60
62
 
61
63
  * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
62
64
 
65
+ * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
66
+
63
67
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
64
68
 
65
69
 
@@ -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. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. |
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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
8
8
  **transaction_id** | **String** | The transaction ID. |
9
9
  **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
10
10
  **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
@@ -75,6 +75,8 @@ Name | Type | Description | Notes
75
75
 
76
76
  * `PaymentPayout` (value: `"PaymentPayout"`)
77
77
 
78
+ * `PaymentBulkSend` (value: `"PaymentBulkSend"`)
79
+
78
80
  * `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
79
81
 
80
82
  * `SuspendedToken` (value: `"SuspendedToken"`)
@@ -83,6 +85,8 @@ Name | Type | Description | Notes
83
85
 
84
86
  * `ComplianceKytScreenings` (value: `"ComplianceKytScreenings"`)
85
87
 
88
+ * `ComplianceKyaScreenings` (value: `"ComplianceKyaScreenings"`)
89
+
86
90
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
87
91
 
88
92
 
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
7
7
  **token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. |
8
8
  **developer_fee_amount** | **String** | The total amount of the token that has been received as developer fee. | [optional]
9
9
  **settled_amount** | **String** | The total amount of the token that has been paid out from the developer's balance. | [optional]
10
- **payout_amount** | **String** | The psp payout amount. | [optional]
10
+ **payout_amount** | **String** | This field is reserved for future use. | [optional]
11
11
  **refunded_amount** | **String** | The total amount of the token that has been refunded from the developer's balance. | [optional]
12
- **total_balance** | **String** | The total balance of the token available for payout or refund for the developer. `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount` For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances) | [optional]
13
- **available_balance** | **String** | The psp available balance. | [optional]
14
- **locked_balance** | **String** | The psp locked balance. | [optional]
12
+ **total_balance** | **String** | The total balance of the token available for payout or refund for the developer. For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances) | [optional]
13
+ **available_balance** | **String** | This field has been deprecated. | [optional]
14
+ **locked_balance** | **String** | This field is reserved for future use. | [optional]
15
15
 
16
16
 
@@ -8,6 +8,6 @@ Name | Type | Description | Notes
8
8
  **amount** | **String** | The amount to refund, denominated in the cryptocurrency of the original payment transaction. The amount must be a positive number and can have up to two decimal places. |
9
9
  **refund_source** | [**RefundType**](RefundType.md) | |
10
10
  **merchant_id** | **String** | The merchant ID, required if `refund_source` is `Merchant`. The fund will be deducted from the specified merchant's balance. | [optional]
11
- **fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency of the original payment transaction. This field is only valid when `refund_source` is `Merchant`. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances). Must be: - A positive integer with up to two decimal places. - Less than the refund amount | [optional]
11
+ **fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency of the original payment transaction. This field is only valid when `refund_source` is `Merchant`. For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances). Must be: - A positive integer with up to two decimal places. - Less than the refund amount | [optional]
12
12
 
13
13
 
package/docs/Report.md ADDED
@@ -0,0 +1,17 @@
1
+ # CoboWaas2.Report
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **report_id** | **String** | The report ID generated by Cobo. |
8
+ **report_types** | [**[ReportType]**](ReportType.md) | The types of the report. |
9
+ **start_time** | **Number** | The start time of the report. Unix timestamp measured in seconds. |
10
+ **end_time** | **Number** | The end time of the report. Unix timestamp measured in seconds. |
11
+ **created_timestamp** | **Number** | The created time of the report. Unix timestamp measured in seconds. |
12
+ **report_url** | **String** | The URL of the report. | [optional]
13
+ **report_export_format** | [**ReportExportFormat**](ReportExportFormat.md) | |
14
+ **report_status** | [**ReportStatus**](ReportStatus.md) | |
15
+ **initiator** | **String** | The initiator of this report. Usually the API key used to generate the report. |
16
+
17
+
@@ -0,0 +1,14 @@
1
+ # CoboWaas2.ReportExportFormat
2
+
3
+ ## Enum
4
+
5
+
6
+ * `CSV` (value: `"CSV"`)
7
+
8
+ * `XLSX` (value: `"XLSX"`)
9
+
10
+ * `ZIP` (value: `"ZIP"`)
11
+
12
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
13
+
14
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.ReportStatus
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Completed` (value: `"Completed"`)
7
+
8
+ * `Failed` (value: `"Failed"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+