@cobo/cobo-waas2 1.28.0 → 1.29.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.
- package/README.md +66 -9
- package/dist/ApiClient.js +1 -1
- package/dist/api/AutoSweepApi.js +2 -2
- package/dist/api/ComplianceApi.js +144 -4
- package/dist/api/FeeStationApi.js +2 -2
- package/dist/api/PaymentApi.js +960 -85
- package/dist/api/StakingsApi.js +2 -2
- package/dist/api/TransactionsApi.js +6 -6
- package/dist/index.js +245 -0
- package/dist/model/AddressRiskLevel.js +71 -0
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/AllocationRecord.js +8 -5
- package/dist/model/AllocationRequest.js +10 -7
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/BatchAllocation.js +1 -1
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/CommissionFee.js +2 -2
- package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
- package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +341 -0
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +8 -3
- package/dist/model/ContractCallParams.js +2 -2
- package/dist/model/CounterpartyWalletAddressDetail.js +2 -2
- package/dist/model/CreateBatchAllocationRequest.js +2 -2
- package/dist/model/CreateCounterpartyEntry201Response.js +143 -0
- package/dist/model/CreateCounterpartyEntryRequest.js +141 -0
- package/dist/model/CreateDestinationEntry201Response.js +172 -0
- package/dist/model/CreateDestinationEntryRequest.js +172 -0
- package/dist/model/CreateKyaScreeningsBody.js +129 -0
- package/dist/model/CreateMerchantRequest.js +1 -1
- package/dist/model/CreatePaymentOrderRequest.js +11 -11
- package/dist/model/CreatePayoutRequest.js +5 -5
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateReportRequest.js +156 -0
- package/dist/model/CreateWalletAddress.js +2 -2
- package/dist/model/DeleteCounterpartyById200Response.js +110 -0
- package/dist/model/DeleteCounterpartyEntry200Response.js +110 -0
- package/dist/model/DeleteDestinationById200Response.js +110 -0
- package/dist/model/DeleteDestinationEntry200Response.js +110 -0
- package/dist/model/EntryType.js +61 -0
- package/dist/model/GetCounterpartyEntry200Response.js +90 -0
- package/dist/model/GetDestinationEntry200Response.js +106 -0
- package/dist/model/GetReports200Response.js +123 -0
- package/dist/model/KyaRiskAssessment.js +151 -0
- package/dist/model/KyaRiskDetail.js +126 -0
- package/dist/model/KyaRiskLevel.js +66 -0
- package/dist/model/KyaScreeningRequest.js +154 -0
- package/dist/model/KyaScreeningResult.js +222 -0
- package/dist/model/KyaScreeningResultRiskAssessment.js +171 -0
- package/dist/model/KyaScreeningStatus.js +71 -0
- package/dist/model/KyaScreeningsEventData.js +174 -0
- package/dist/model/LinkDisplayInfo.js +1 -1
- package/dist/model/ListCounterpartyEntries200Response.js +123 -0
- package/dist/model/ListDestinationEntries200Response.js +153 -0
- package/dist/model/ListKyaScreenings200Response.js +145 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/MerchantBalance.js +4 -4
- package/dist/model/Order.js +10 -10
- package/dist/model/OrderLinkBusinessInfo.js +12 -12
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +2 -4
- package/dist/model/OrderLinkBusinessInfoPayableAmountsInner.js +4 -4
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentAllocationAmount.js +2 -2
- package/dist/model/PaymentOrderEventData.js +26 -21
- package/dist/model/PaymentPayout.js +3 -3
- package/dist/model/PaymentPayoutDetail.js +3 -3
- package/dist/model/PaymentPayoutEvent.js +14 -9
- package/dist/model/PaymentPayoutItem.js +8 -7
- package/dist/model/PaymentPayoutItemDetail.js +8 -7
- package/dist/model/PaymentPayoutParam.js +8 -7
- package/dist/model/PaymentRefundEventData.js +8 -3
- package/dist/model/PaymentSettlementEvent.js +8 -3
- package/dist/model/PaymentTransactionEventData.js +8 -3
- package/dist/model/PspBalance.js +4 -4
- package/dist/model/RefundLinkBusinessInfo.js +1 -1
- package/dist/model/Report.js +209 -0
- package/dist/model/ReportExportFormat.js +66 -0
- package/dist/model/ReportStatus.js +61 -0
- package/dist/model/ReportType.js +121 -0
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/TransferParams.js +2 -2
- package/dist/model/UpdateCounterpartyRequest.js +160 -0
- package/dist/model/UpdateDestinationEntry200Response.js +90 -0
- package/dist/model/UpdateDestinationEntryRequest.js +135 -0
- package/dist/model/UpdateDestinationRequest.js +173 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/WalletAddress.js +20 -2
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEventData.js +58 -24
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +5 -0
- package/docs/AddressRiskLevel.md +16 -0
- package/docs/AddressesEventData.md +3 -1
- package/docs/AllocationRecord.md +5 -5
- package/docs/AllocationRequest.md +5 -5
- package/docs/AutoSweepApi.md +1 -1
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/BatchAllocation.md +1 -1
- package/docs/ChainsEventData.md +3 -1
- package/docs/CommissionFee.md +1 -1
- package/docs/ComplianceApi.md +163 -0
- package/docs/ComplianceDispositionUpdateEventData.md +3 -1
- package/docs/ComplianceKyaScreeningsUpdateEventData.md +62 -0
- package/docs/ComplianceKytScreeningsUpdateEventData.md +3 -1
- package/docs/ContractCallParams.md +1 -1
- package/docs/CounterpartyWalletAddressDetail.md +1 -1
- package/docs/CreateBatchAllocationRequest.md +1 -1
- package/docs/CreateCounterpartyEntry201Response.md +10 -0
- package/docs/CreateCounterpartyEntryRequest.md +10 -0
- package/docs/CreateDestinationEntry201Response.md +11 -0
- package/docs/CreateDestinationEntryRequest.md +11 -0
- package/docs/CreateKyaScreeningsBody.md +9 -0
- package/docs/CreateMerchantRequest.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +10 -10
- package/docs/CreatePayoutRequest.md +4 -4
- package/docs/CreateRefundRequest.md +2 -2
- package/docs/CreateReportRequest.md +13 -0
- package/docs/CreateWalletAddress.md +1 -1
- package/docs/DeleteCounterpartyById200Response.md +9 -0
- package/docs/DeleteCounterpartyEntry200Response.md +9 -0
- package/docs/DeleteDestinationById200Response.md +9 -0
- package/docs/DeleteDestinationEntry200Response.md +9 -0
- package/docs/EntryType.md +12 -0
- package/docs/FeeStationApi.md +1 -1
- package/docs/GetCounterpartyEntry200Response.md +9 -0
- package/docs/GetDestinationEntry200Response.md +10 -0
- package/docs/GetReports200Response.md +10 -0
- package/docs/KyaRiskAssessment.md +11 -0
- package/docs/KyaRiskDetail.md +10 -0
- package/docs/KyaRiskLevel.md +14 -0
- package/docs/KyaScreeningRequest.md +12 -0
- package/docs/KyaScreeningResult.md +17 -0
- package/docs/KyaScreeningResultRiskAssessment.md +11 -0
- package/docs/KyaScreeningStatus.md +16 -0
- package/docs/KyaScreeningsEventData.md +14 -0
- package/docs/LinkDisplayInfo.md +1 -1
- package/docs/ListCounterpartyEntries200Response.md +10 -0
- package/docs/ListDestinationEntries200Response.md +11 -0
- package/docs/ListKyaScreenings200Response.md +10 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/MerchantBalance.md +4 -4
- package/docs/Order.md +8 -8
- package/docs/OrderLinkBusinessInfo.md +11 -11
- package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +2 -2
- package/docs/OrderLinkBusinessInfoPayableAmountsInner.md +2 -2
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentAllocationAmount.md +1 -1
- package/docs/PaymentApi.md +1104 -161
- package/docs/PaymentOrderEventData.md +11 -9
- package/docs/PaymentPayout.md +3 -3
- package/docs/PaymentPayoutDetail.md +3 -3
- package/docs/PaymentPayoutEvent.md +6 -4
- package/docs/PaymentPayoutItem.md +6 -6
- package/docs/PaymentPayoutItemDetail.md +6 -6
- package/docs/PaymentPayoutParam.md +5 -5
- package/docs/PaymentRefundEventData.md +3 -1
- package/docs/PaymentSettlementEvent.md +3 -1
- package/docs/PaymentTransactionEventData.md +3 -1
- package/docs/PspBalance.md +4 -4
- package/docs/RefundLinkBusinessInfo.md +1 -1
- package/docs/Report.md +17 -0
- package/docs/ReportExportFormat.md +14 -0
- package/docs/ReportStatus.md +12 -0
- package/docs/ReportType.md +36 -0
- package/docs/StakingsApi.md +1 -1
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokensEventData.md +3 -1
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +3 -3
- package/docs/TransferParams.md +1 -1
- package/docs/UpdateCounterpartyRequest.md +13 -0
- package/docs/UpdateDestinationEntry200Response.md +9 -0
- package/docs/UpdateDestinationEntryRequest.md +11 -0
- package/docs/UpdateDestinationRequest.md +14 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/WalletAddress.md +3 -1
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WebhookEventData.md +18 -15
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +2 -0
- package/package.json +1 -1
package/docs/PaymentApi.md
CHANGED
|
@@ -8,10 +8,12 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**cancelRefundById**](PaymentApi.md#cancelRefundById) | **PUT** /payments/refunds/{refund_id}/cancel | Cancel refund order
|
|
9
9
|
[**createBatchAllocation**](PaymentApi.md#createBatchAllocation) | **POST** /payments/batch_allocations | Create batch allocation
|
|
10
10
|
[**createCounterparty**](PaymentApi.md#createCounterparty) | **POST** /payments/counterparty | Create counterparty
|
|
11
|
+
[**createCounterpartyEntry**](PaymentApi.md#createCounterpartyEntry) | **POST** /payments/counterparty_entry | Create counterparty entry
|
|
11
12
|
[**createCounterpartyWalletAddress**](PaymentApi.md#createCounterpartyWalletAddress) | **POST** /payments/counterparty/wallet_address | Create counterparty wallet address
|
|
12
13
|
[**createCryptoAddress**](PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
|
|
13
14
|
[**createDestination**](PaymentApi.md#createDestination) | **POST** /payments/destination | Create destination
|
|
14
15
|
[**createDestinationBankAccount**](PaymentApi.md#createDestinationBankAccount) | **POST** /payments/destination/bank_account | Create destination bank account
|
|
16
|
+
[**createDestinationEntry**](PaymentApi.md#createDestinationEntry) | **POST** /payments/destination_entry | Create destination entry
|
|
15
17
|
[**createDestinationWalletAddress**](PaymentApi.md#createDestinationWalletAddress) | **POST** /payments/destination/wallet_address | Create destination wallet address
|
|
16
18
|
[**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
|
|
17
19
|
[**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
@@ -20,35 +22,47 @@ Method | HTTP request | Description
|
|
|
20
22
|
[**createPayout**](PaymentApi.md#createPayout) | **POST** /payments/payouts | Create payout
|
|
21
23
|
[**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
|
|
22
24
|
[**createRefundLink**](PaymentApi.md#createRefundLink) | **POST** /payments/links/refunds | Create refund link
|
|
25
|
+
[**createReport**](PaymentApi.md#createReport) | **POST** /payments/reports | Generate reports
|
|
23
26
|
[**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
|
|
24
|
-
[**deleteCounterparty**](PaymentApi.md#deleteCounterparty) | **PUT** /payments/counterparty/{counterparty_id}/delete | Delete counterparty
|
|
27
|
+
[**deleteCounterparty**](PaymentApi.md#deleteCounterparty) | **PUT** /payments/counterparty/{counterparty_id}/delete | Delete counterparty (Deprecated)
|
|
28
|
+
[**deleteCounterpartyById**](PaymentApi.md#deleteCounterpartyById) | **DELETE** /payments/counterparty/{counterparty_id} | Delete counterparty
|
|
29
|
+
[**deleteCounterpartyEntry**](PaymentApi.md#deleteCounterpartyEntry) | **DELETE** /payments/counterparty_entry/{counterparty_entry_id} | Delete counterparty entry
|
|
25
30
|
[**deleteCounterpartyWalletAddress**](PaymentApi.md#deleteCounterpartyWalletAddress) | **PUT** /payments/counterparty/wallet_address/{wallet_address_id}/delete | Delete counterparty wallet address
|
|
26
31
|
[**deleteCryptoAddress**](PaymentApi.md#deleteCryptoAddress) | **POST** /payments/crypto_addresses/{crypto_address_id}/delete | Delete crypto address
|
|
27
|
-
[**deleteDestination**](PaymentApi.md#deleteDestination) | **PUT** /payments/destination/{destination_id}/delete | Delete destination
|
|
32
|
+
[**deleteDestination**](PaymentApi.md#deleteDestination) | **PUT** /payments/destination/{destination_id}/delete | Delete destination (Deprecated)
|
|
28
33
|
[**deleteDestinationBankAccount**](PaymentApi.md#deleteDestinationBankAccount) | **PUT** /payments/destination/bank_account/{bank_account_id}/delete | Delete destination bank account
|
|
34
|
+
[**deleteDestinationById**](PaymentApi.md#deleteDestinationById) | **DELETE** /payments/destination/{destination_id} | Delete destination
|
|
35
|
+
[**deleteDestinationEntry**](PaymentApi.md#deleteDestinationEntry) | **DELETE** /payments/destination_entry/{destination_entry_id} | Delete destination entry
|
|
29
36
|
[**deleteDestinationWalletAddress**](PaymentApi.md#deleteDestinationWalletAddress) | **PUT** /payments/destination/wallet_address/{wallet_address_id}/delete | Delete destination wallet address
|
|
30
37
|
[**enableDestinationWhitelist**](PaymentApi.md#enableDestinationWhitelist) | **POST** /payments/destination/enable_whitelist | Enable or disable destination whitelist
|
|
31
38
|
[**getAvailableAllocationAmount**](PaymentApi.md#getAvailableAllocationAmount) | **GET** /payments/allocation_amount | Get available allocation amount
|
|
32
|
-
[**getBatchAllocationById**](PaymentApi.md#getBatchAllocationById) | **GET** /payments/batch_allocations/{batch_allocation_id} | Get batch allocation
|
|
33
|
-
[**
|
|
39
|
+
[**getBatchAllocationById**](PaymentApi.md#getBatchAllocationById) | **GET** /payments/batch_allocations/{batch_allocation_id} | Get batch allocation information
|
|
40
|
+
[**getCounterparty**](PaymentApi.md#getCounterparty) | **GET** /payments/counterparty/{counterparty_id} | Get counterparty information
|
|
41
|
+
[**getCounterpartyDetailById**](PaymentApi.md#getCounterpartyDetailById) | **GET** /payments/counterparty/{counterparty_id}/detail | Get counterparty information (Deprecated)
|
|
42
|
+
[**getCounterpartyEntry**](PaymentApi.md#getCounterpartyEntry) | **GET** /payments/counterparty_entry/{counterparty_entry_id} | Get counterparty entry information
|
|
43
|
+
[**getDestination**](PaymentApi.md#getDestination) | **GET** /payments/destination/{destination_id} | Get destination information
|
|
34
44
|
[**getDestinationBankAccountDetailById**](PaymentApi.md#getDestinationBankAccountDetailById) | **GET** /payments/destination/bank_account/{bank_account_id}/detail | Get destination bank account information
|
|
35
|
-
[**getDestinationDetailById**](PaymentApi.md#getDestinationDetailById) | **GET** /payments/destination/{destination_id}/detail | Get destination information
|
|
45
|
+
[**getDestinationDetailById**](PaymentApi.md#getDestinationDetailById) | **GET** /payments/destination/{destination_id}/detail | Get destination information (Deprecated)
|
|
46
|
+
[**getDestinationEntry**](PaymentApi.md#getDestinationEntry) | **GET** /payments/destination_entry/{destination_entry_id} | Get destination entry information
|
|
36
47
|
[**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
|
|
37
48
|
[**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
|
|
38
49
|
[**getPayoutById**](PaymentApi.md#getPayoutById) | **GET** /payments/payouts/{payout_id} | Get payout information
|
|
39
50
|
[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get developer balance
|
|
40
51
|
[**getRefundDetailById**](PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
|
|
41
52
|
[**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
|
|
53
|
+
[**getReports**](PaymentApi.md#getReports) | **GET** /payments/reports | List all reports
|
|
42
54
|
[**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
|
|
43
55
|
[**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
|
|
44
56
|
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Create/Get top-up address
|
|
45
|
-
[**listAllocations**](PaymentApi.md#listAllocations) | **GET** /payments/allocation_records | List all
|
|
57
|
+
[**listAllocations**](PaymentApi.md#listAllocations) | **GET** /payments/allocation_records | List all allocation records
|
|
46
58
|
[**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
|
|
47
59
|
[**listBatchAllocations**](PaymentApi.md#listBatchAllocations) | **GET** /payments/batch_allocations | List all batch allocations
|
|
48
60
|
[**listCounterparties**](PaymentApi.md#listCounterparties) | **GET** /payments/counterparty | List all counterparties
|
|
61
|
+
[**listCounterpartyEntries**](PaymentApi.md#listCounterpartyEntries) | **GET** /payments/counterparty_entry | List counterparty entries
|
|
49
62
|
[**listCounterpartyWalletAddress**](PaymentApi.md#listCounterpartyWalletAddress) | **GET** /payments/counterparty/wallet_address | List counterparty wallet addresses
|
|
50
63
|
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
51
64
|
[**listDestinationBankAccounts**](PaymentApi.md#listDestinationBankAccounts) | **GET** /payments/destination/bank_account | List destination bank accounts
|
|
65
|
+
[**listDestinationEntries**](PaymentApi.md#listDestinationEntries) | **GET** /payments/destination_entry | List destination entries
|
|
52
66
|
[**listDestinationWalletAddresses**](PaymentApi.md#listDestinationWalletAddresses) | **GET** /payments/destination/wallet_address | List destination wallet addresses
|
|
53
67
|
[**listDestinations**](PaymentApi.md#listDestinations) | **GET** /payments/destination | List all destinations
|
|
54
68
|
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List forced sweeps
|
|
@@ -66,9 +80,12 @@ Method | HTTP request | Description
|
|
|
66
80
|
[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
|
|
67
81
|
[**queryDestinationWhitelistEnabled**](PaymentApi.md#queryDestinationWhitelistEnabled) | **GET** /payments/destination/enable_whitelist | Query destination whitelist enabled status
|
|
68
82
|
[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
69
|
-
[**
|
|
83
|
+
[**updateCounterparty**](PaymentApi.md#updateCounterparty) | **PUT** /payments/counterparty/{counterparty_id} | Update counterparty
|
|
84
|
+
[**updateCounterpartyById**](PaymentApi.md#updateCounterpartyById) | **PUT** /payments/counterparty/{counterparty_id}/update | Update counterparty (Deprecated)
|
|
85
|
+
[**updateDestination**](PaymentApi.md#updateDestination) | **PUT** /payments/destination/{destination_id} | Update destination
|
|
70
86
|
[**updateDestinationBankAccountById**](PaymentApi.md#updateDestinationBankAccountById) | **PUT** /payments/destination/bank_account/{bank_account_id}/update | Update destination bank account
|
|
71
|
-
[**updateDestinationById**](PaymentApi.md#updateDestinationById) | **PUT** /payments/destination/{destination_id}/update | Update destination
|
|
87
|
+
[**updateDestinationById**](PaymentApi.md#updateDestinationById) | **PUT** /payments/destination/{destination_id}/update | Update destination (Deprecated)
|
|
88
|
+
[**updateDestinationEntry**](PaymentApi.md#updateDestinationEntry) | **PUT** /payments/destination_entry/{destination_entry_id} | Update destination entry
|
|
72
89
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
73
90
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
74
91
|
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
|
|
@@ -184,7 +201,7 @@ Name | Type | Description | Notes
|
|
|
184
201
|
|
|
185
202
|
Create batch allocation
|
|
186
203
|
|
|
187
|
-
This operation
|
|
204
|
+
This operation allocates funds between multiple accounts in one batch request.
|
|
188
205
|
|
|
189
206
|
### Example
|
|
190
207
|
|
|
@@ -214,7 +231,7 @@ apiInstance.createBatchAllocation(opts).then((data) => {
|
|
|
214
231
|
|
|
215
232
|
Name | Type | Description | Notes
|
|
216
233
|
------------- | ------------- | ------------- | -------------
|
|
217
|
-
**CreateBatchAllocationRequest** | [**CreateBatchAllocationRequest**](CreateBatchAllocationRequest.md)| The request body to create a
|
|
234
|
+
**CreateBatchAllocationRequest** | [**CreateBatchAllocationRequest**](CreateBatchAllocationRequest.md)| The request body to create a batch allocation request. | [optional]
|
|
218
235
|
|
|
219
236
|
### Return type
|
|
220
237
|
|
|
@@ -236,7 +253,7 @@ Name | Type | Description | Notes
|
|
|
236
253
|
|
|
237
254
|
Create counterparty
|
|
238
255
|
|
|
239
|
-
This operation creates a counterparty.
|
|
256
|
+
This operation creates a [counterparty](https://www.cobo.com/payments/en/guides/counterparties).
|
|
240
257
|
|
|
241
258
|
### Example
|
|
242
259
|
|
|
@@ -282,6 +299,58 @@ Name | Type | Description | Notes
|
|
|
282
299
|
- **Accept**: application/json
|
|
283
300
|
|
|
284
301
|
|
|
302
|
+
## createCounterpartyEntry
|
|
303
|
+
|
|
304
|
+
> CreateCounterpartyEntry201Response createCounterpartyEntry(opts)
|
|
305
|
+
|
|
306
|
+
Create counterparty entry
|
|
307
|
+
|
|
308
|
+
This operation creates one or more entries for a counterparty. A counterparty entry is a record of a counterparty's wallet address.
|
|
309
|
+
|
|
310
|
+
### Example
|
|
311
|
+
|
|
312
|
+
```javascript
|
|
313
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
314
|
+
// Initialize the API client
|
|
315
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
316
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
317
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
318
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
319
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
320
|
+
// Call the API
|
|
321
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
322
|
+
const opts = {
|
|
323
|
+
'CreateCounterpartyEntryRequest': new CoboWaas2.CreateCounterpartyEntryRequest()
|
|
324
|
+
};
|
|
325
|
+
apiInstance.createCounterpartyEntry(opts).then((data) => {
|
|
326
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
327
|
+
}, (error) => {
|
|
328
|
+
console.error(error);
|
|
329
|
+
});
|
|
330
|
+
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
### Parameters
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
Name | Type | Description | Notes
|
|
337
|
+
------------- | ------------- | ------------- | -------------
|
|
338
|
+
**CreateCounterpartyEntryRequest** | [**CreateCounterpartyEntryRequest**](CreateCounterpartyEntryRequest.md)| The request body to create counterparty entries. | [optional]
|
|
339
|
+
|
|
340
|
+
### Return type
|
|
341
|
+
|
|
342
|
+
[**CreateCounterpartyEntry201Response**](CreateCounterpartyEntry201Response.md)
|
|
343
|
+
|
|
344
|
+
### Authorization
|
|
345
|
+
|
|
346
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
347
|
+
|
|
348
|
+
### HTTP request headers
|
|
349
|
+
|
|
350
|
+
- **Content-Type**: application/json
|
|
351
|
+
- **Accept**: application/json
|
|
352
|
+
|
|
353
|
+
|
|
285
354
|
## createCounterpartyWalletAddress
|
|
286
355
|
|
|
287
356
|
> WalletAddress createCounterpartyWalletAddress(opts)
|
|
@@ -392,7 +461,7 @@ Name | Type | Description | Notes
|
|
|
392
461
|
|
|
393
462
|
Create destination
|
|
394
463
|
|
|
395
|
-
This operation creates a destination.
|
|
464
|
+
This operation creates a [destination](https://www.cobo.com/payments/en/guides/destinations).
|
|
396
465
|
|
|
397
466
|
### Example
|
|
398
467
|
|
|
@@ -490,6 +559,58 @@ Name | Type | Description | Notes
|
|
|
490
559
|
- **Accept**: application/json
|
|
491
560
|
|
|
492
561
|
|
|
562
|
+
## createDestinationEntry
|
|
563
|
+
|
|
564
|
+
> CreateDestinationEntry201Response createDestinationEntry(opts)
|
|
565
|
+
|
|
566
|
+
Create destination entry
|
|
567
|
+
|
|
568
|
+
This operation creates one or more entries for a destination. A destination entry is a record of a destination's wallet addresses or bank accounts.
|
|
569
|
+
|
|
570
|
+
### Example
|
|
571
|
+
|
|
572
|
+
```javascript
|
|
573
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
574
|
+
// Initialize the API client
|
|
575
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
576
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
577
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
578
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
579
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
580
|
+
// Call the API
|
|
581
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
582
|
+
const opts = {
|
|
583
|
+
'CreateDestinationEntryRequest': new CoboWaas2.CreateDestinationEntryRequest()
|
|
584
|
+
};
|
|
585
|
+
apiInstance.createDestinationEntry(opts).then((data) => {
|
|
586
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
587
|
+
}, (error) => {
|
|
588
|
+
console.error(error);
|
|
589
|
+
});
|
|
590
|
+
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
### Parameters
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
Name | Type | Description | Notes
|
|
597
|
+
------------- | ------------- | ------------- | -------------
|
|
598
|
+
**CreateDestinationEntryRequest** | [**CreateDestinationEntryRequest**](CreateDestinationEntryRequest.md)| The request body to create destination entries. | [optional]
|
|
599
|
+
|
|
600
|
+
### Return type
|
|
601
|
+
|
|
602
|
+
[**CreateDestinationEntry201Response**](CreateDestinationEntry201Response.md)
|
|
603
|
+
|
|
604
|
+
### Authorization
|
|
605
|
+
|
|
606
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
607
|
+
|
|
608
|
+
### HTTP request headers
|
|
609
|
+
|
|
610
|
+
- **Content-Type**: application/json
|
|
611
|
+
- **Accept**: application/json
|
|
612
|
+
|
|
613
|
+
|
|
493
614
|
## createDestinationWalletAddress
|
|
494
615
|
|
|
495
616
|
> WalletAddress createDestinationWalletAddress(opts)
|
|
@@ -756,7 +877,7 @@ Name | Type | Description | Notes
|
|
|
756
877
|
|
|
757
878
|
Create payout
|
|
758
879
|
|
|
759
|
-
This operation
|
|
880
|
+
This operation initiates a payout, distributing funds either to cryptocurrency addresses or to bank accounts as fiat currency.
|
|
760
881
|
|
|
761
882
|
### Example
|
|
762
883
|
|
|
@@ -906,13 +1027,13 @@ Name | Type | Description | Notes
|
|
|
906
1027
|
- **Accept**: application/json
|
|
907
1028
|
|
|
908
1029
|
|
|
909
|
-
##
|
|
1030
|
+
## createReport
|
|
910
1031
|
|
|
911
|
-
>
|
|
1032
|
+
> Report createReport(opts)
|
|
912
1033
|
|
|
913
|
-
|
|
1034
|
+
Generate reports
|
|
914
1035
|
|
|
915
|
-
This operation
|
|
1036
|
+
This operation generates reports for a variety of payment activities, including pay-ins, payouts, and commission fees.
|
|
916
1037
|
|
|
917
1038
|
### Example
|
|
918
1039
|
|
|
@@ -927,9 +1048,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
927
1048
|
// Call the API
|
|
928
1049
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
929
1050
|
const opts = {
|
|
930
|
-
'
|
|
1051
|
+
'CreateReportRequest': new CoboWaas2.CreateReportRequest()
|
|
931
1052
|
};
|
|
932
|
-
apiInstance.
|
|
1053
|
+
apiInstance.createReport(opts).then((data) => {
|
|
933
1054
|
console.log('API called successfully. Returned data: ' + data);
|
|
934
1055
|
}, (error) => {
|
|
935
1056
|
console.error(error);
|
|
@@ -942,11 +1063,11 @@ apiInstance.createSettlementRequest(opts).then((data) => {
|
|
|
942
1063
|
|
|
943
1064
|
Name | Type | Description | Notes
|
|
944
1065
|
------------- | ------------- | ------------- | -------------
|
|
945
|
-
**
|
|
1066
|
+
**CreateReportRequest** | [**CreateReportRequest**](CreateReportRequest.md)| The request body to create payment reports. | [optional]
|
|
946
1067
|
|
|
947
1068
|
### Return type
|
|
948
1069
|
|
|
949
|
-
[**
|
|
1070
|
+
[**Report**](Report.md)
|
|
950
1071
|
|
|
951
1072
|
### Authorization
|
|
952
1073
|
|
|
@@ -958,13 +1079,13 @@ Name | Type | Description | Notes
|
|
|
958
1079
|
- **Accept**: application/json
|
|
959
1080
|
|
|
960
1081
|
|
|
961
|
-
##
|
|
1082
|
+
## createSettlementRequest
|
|
962
1083
|
|
|
963
|
-
>
|
|
1084
|
+
> Settlement createSettlementRequest(opts)
|
|
964
1085
|
|
|
965
|
-
|
|
1086
|
+
Create settlement request
|
|
966
1087
|
|
|
967
|
-
This operation
|
|
1088
|
+
This operation creates a settlement request to withdraw available balances.
|
|
968
1089
|
|
|
969
1090
|
### Example
|
|
970
1091
|
|
|
@@ -978,8 +1099,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
978
1099
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
979
1100
|
// Call the API
|
|
980
1101
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
981
|
-
const
|
|
982
|
-
|
|
1102
|
+
const opts = {
|
|
1103
|
+
'CreateSettlementRequestRequest': new CoboWaas2.CreateSettlementRequestRequest()
|
|
1104
|
+
};
|
|
1105
|
+
apiInstance.createSettlementRequest(opts).then((data) => {
|
|
983
1106
|
console.log('API called successfully. Returned data: ' + data);
|
|
984
1107
|
}, (error) => {
|
|
985
1108
|
console.error(error);
|
|
@@ -992,11 +1115,11 @@ apiInstance.deleteCounterparty(counterparty_id).then((data) => {
|
|
|
992
1115
|
|
|
993
1116
|
Name | Type | Description | Notes
|
|
994
1117
|
------------- | ------------- | ------------- | -------------
|
|
995
|
-
**
|
|
1118
|
+
**CreateSettlementRequestRequest** | [**CreateSettlementRequestRequest**](CreateSettlementRequestRequest.md)| The request body to create a settlement request. | [optional]
|
|
996
1119
|
|
|
997
1120
|
### Return type
|
|
998
1121
|
|
|
999
|
-
[**
|
|
1122
|
+
[**Settlement**](Settlement.md)
|
|
1000
1123
|
|
|
1001
1124
|
### Authorization
|
|
1002
1125
|
|
|
@@ -1004,17 +1127,17 @@ Name | Type | Description | Notes
|
|
|
1004
1127
|
|
|
1005
1128
|
### HTTP request headers
|
|
1006
1129
|
|
|
1007
|
-
- **Content-Type**:
|
|
1130
|
+
- **Content-Type**: application/json
|
|
1008
1131
|
- **Accept**: application/json
|
|
1009
1132
|
|
|
1010
1133
|
|
|
1011
|
-
##
|
|
1134
|
+
## deleteCounterparty
|
|
1012
1135
|
|
|
1013
|
-
>
|
|
1136
|
+
> DeleteCounterparty200Response deleteCounterparty(counterparty_id)
|
|
1014
1137
|
|
|
1015
|
-
Delete counterparty
|
|
1138
|
+
Delete counterparty (Deprecated)
|
|
1016
1139
|
|
|
1017
|
-
This operation deletes a counterparty
|
|
1140
|
+
This operation deletes a counterparty.
|
|
1018
1141
|
|
|
1019
1142
|
### Example
|
|
1020
1143
|
|
|
@@ -1028,8 +1151,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1028
1151
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1029
1152
|
// Call the API
|
|
1030
1153
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1031
|
-
const
|
|
1032
|
-
apiInstance.
|
|
1154
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1155
|
+
apiInstance.deleteCounterparty(counterparty_id).then((data) => {
|
|
1033
1156
|
console.log('API called successfully. Returned data: ' + data);
|
|
1034
1157
|
}, (error) => {
|
|
1035
1158
|
console.error(error);
|
|
@@ -1042,11 +1165,11 @@ apiInstance.deleteCounterpartyWalletAddress(wallet_address_id).then((data) => {
|
|
|
1042
1165
|
|
|
1043
1166
|
Name | Type | Description | Notes
|
|
1044
1167
|
------------- | ------------- | ------------- | -------------
|
|
1045
|
-
**
|
|
1168
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1046
1169
|
|
|
1047
1170
|
### Return type
|
|
1048
1171
|
|
|
1049
|
-
[**
|
|
1172
|
+
[**DeleteCounterparty200Response**](DeleteCounterparty200Response.md)
|
|
1050
1173
|
|
|
1051
1174
|
### Authorization
|
|
1052
1175
|
|
|
@@ -1058,13 +1181,13 @@ Name | Type | Description | Notes
|
|
|
1058
1181
|
- **Accept**: application/json
|
|
1059
1182
|
|
|
1060
1183
|
|
|
1061
|
-
##
|
|
1184
|
+
## deleteCounterpartyById
|
|
1062
1185
|
|
|
1063
|
-
>
|
|
1186
|
+
> DeleteCounterpartyById200Response deleteCounterpartyById(counterparty_id)
|
|
1064
1187
|
|
|
1065
|
-
Delete
|
|
1188
|
+
Delete counterparty
|
|
1066
1189
|
|
|
1067
|
-
This operation
|
|
1190
|
+
This operation deletes a counterparty. Note that this operation will delete all entries under the counterparty.
|
|
1068
1191
|
|
|
1069
1192
|
### Example
|
|
1070
1193
|
|
|
@@ -1078,8 +1201,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1078
1201
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1079
1202
|
// Call the API
|
|
1080
1203
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1081
|
-
const
|
|
1082
|
-
apiInstance.
|
|
1204
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1205
|
+
apiInstance.deleteCounterpartyById(counterparty_id).then((data) => {
|
|
1083
1206
|
console.log('API called successfully. Returned data: ' + data);
|
|
1084
1207
|
}, (error) => {
|
|
1085
1208
|
console.error(error);
|
|
@@ -1092,11 +1215,11 @@ apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
|
1092
1215
|
|
|
1093
1216
|
Name | Type | Description | Notes
|
|
1094
1217
|
------------- | ------------- | ------------- | -------------
|
|
1095
|
-
**
|
|
1218
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1096
1219
|
|
|
1097
1220
|
### Return type
|
|
1098
1221
|
|
|
1099
|
-
[**
|
|
1222
|
+
[**DeleteCounterpartyById200Response**](DeleteCounterpartyById200Response.md)
|
|
1100
1223
|
|
|
1101
1224
|
### Authorization
|
|
1102
1225
|
|
|
@@ -1108,13 +1231,13 @@ Name | Type | Description | Notes
|
|
|
1108
1231
|
- **Accept**: application/json
|
|
1109
1232
|
|
|
1110
1233
|
|
|
1111
|
-
##
|
|
1234
|
+
## deleteCounterpartyEntry
|
|
1112
1235
|
|
|
1113
|
-
>
|
|
1236
|
+
> DeleteCounterpartyEntry200Response deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts)
|
|
1114
1237
|
|
|
1115
|
-
Delete
|
|
1238
|
+
Delete counterparty entry
|
|
1116
1239
|
|
|
1117
|
-
This operation deletes a
|
|
1240
|
+
This operation deletes a counterparty entry.
|
|
1118
1241
|
|
|
1119
1242
|
### Example
|
|
1120
1243
|
|
|
@@ -1128,8 +1251,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1128
1251
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1129
1252
|
// Call the API
|
|
1130
1253
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1131
|
-
const
|
|
1132
|
-
|
|
1254
|
+
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1255
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1256
|
+
const opts = {
|
|
1257
|
+
'entry_type': new CoboWaas2.EntryType()
|
|
1258
|
+
};
|
|
1259
|
+
apiInstance.deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts).then((data) => {
|
|
1133
1260
|
console.log('API called successfully. Returned data: ' + data);
|
|
1134
1261
|
}, (error) => {
|
|
1135
1262
|
console.error(error);
|
|
@@ -1142,11 +1269,13 @@ apiInstance.deleteDestination(destination_id).then((data) => {
|
|
|
1142
1269
|
|
|
1143
1270
|
Name | Type | Description | Notes
|
|
1144
1271
|
------------- | ------------- | ------------- | -------------
|
|
1145
|
-
**
|
|
1272
|
+
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
1273
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1274
|
+
**entry_type** | [**EntryType**](.md)| The type of the counterparty entry. - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. | [optional]
|
|
1146
1275
|
|
|
1147
1276
|
### Return type
|
|
1148
1277
|
|
|
1149
|
-
[**
|
|
1278
|
+
[**DeleteCounterpartyEntry200Response**](DeleteCounterpartyEntry200Response.md)
|
|
1150
1279
|
|
|
1151
1280
|
### Authorization
|
|
1152
1281
|
|
|
@@ -1158,13 +1287,13 @@ Name | Type | Description | Notes
|
|
|
1158
1287
|
- **Accept**: application/json
|
|
1159
1288
|
|
|
1160
1289
|
|
|
1161
|
-
##
|
|
1290
|
+
## deleteCounterpartyWalletAddress
|
|
1162
1291
|
|
|
1163
|
-
>
|
|
1292
|
+
> DeleteCounterpartyWalletAddress200Response deleteCounterpartyWalletAddress(wallet_address_id)
|
|
1164
1293
|
|
|
1165
|
-
Delete
|
|
1294
|
+
Delete counterparty wallet address
|
|
1166
1295
|
|
|
1167
|
-
This operation deletes a
|
|
1296
|
+
This operation deletes a counterparty wallet address.
|
|
1168
1297
|
|
|
1169
1298
|
### Example
|
|
1170
1299
|
|
|
@@ -1178,8 +1307,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1178
1307
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1179
1308
|
// Call the API
|
|
1180
1309
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1181
|
-
const
|
|
1182
|
-
apiInstance.
|
|
1310
|
+
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1311
|
+
apiInstance.deleteCounterpartyWalletAddress(wallet_address_id).then((data) => {
|
|
1183
1312
|
console.log('API called successfully. Returned data: ' + data);
|
|
1184
1313
|
}, (error) => {
|
|
1185
1314
|
console.error(error);
|
|
@@ -1192,11 +1321,11 @@ apiInstance.deleteDestinationBankAccount(bank_account_id).then((data) => {
|
|
|
1192
1321
|
|
|
1193
1322
|
Name | Type | Description | Notes
|
|
1194
1323
|
------------- | ------------- | ------------- | -------------
|
|
1195
|
-
**
|
|
1324
|
+
**wallet_address_id** | **String**| The wallet address ID. |
|
|
1196
1325
|
|
|
1197
1326
|
### Return type
|
|
1198
1327
|
|
|
1199
|
-
[**
|
|
1328
|
+
[**DeleteCounterpartyWalletAddress200Response**](DeleteCounterpartyWalletAddress200Response.md)
|
|
1200
1329
|
|
|
1201
1330
|
### Authorization
|
|
1202
1331
|
|
|
@@ -1208,13 +1337,13 @@ Name | Type | Description | Notes
|
|
|
1208
1337
|
- **Accept**: application/json
|
|
1209
1338
|
|
|
1210
1339
|
|
|
1211
|
-
##
|
|
1340
|
+
## deleteCryptoAddress
|
|
1212
1341
|
|
|
1213
|
-
>
|
|
1342
|
+
> DeleteCryptoAddress201Response deleteCryptoAddress(crypto_address_id)
|
|
1214
1343
|
|
|
1215
|
-
Delete
|
|
1344
|
+
Delete crypto address
|
|
1216
1345
|
|
|
1217
|
-
This operation
|
|
1346
|
+
This operation unregisters a crypto address from being used for crypto payouts.
|
|
1218
1347
|
|
|
1219
1348
|
### Example
|
|
1220
1349
|
|
|
@@ -1228,8 +1357,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1228
1357
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1229
1358
|
// Call the API
|
|
1230
1359
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1231
|
-
const
|
|
1232
|
-
apiInstance.
|
|
1360
|
+
const crypto_address_id = "addr_ethusdt_20250506T123456_ab12cd";
|
|
1361
|
+
apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
1233
1362
|
console.log('API called successfully. Returned data: ' + data);
|
|
1234
1363
|
}, (error) => {
|
|
1235
1364
|
console.error(error);
|
|
@@ -1242,11 +1371,11 @@ apiInstance.deleteDestinationWalletAddress(wallet_address_id).then((data) => {
|
|
|
1242
1371
|
|
|
1243
1372
|
Name | Type | Description | Notes
|
|
1244
1373
|
------------- | ------------- | ------------- | -------------
|
|
1245
|
-
**
|
|
1374
|
+
**crypto_address_id** | **String**| The crypto address ID. |
|
|
1246
1375
|
|
|
1247
1376
|
### Return type
|
|
1248
1377
|
|
|
1249
|
-
[**
|
|
1378
|
+
[**DeleteCryptoAddress201Response**](DeleteCryptoAddress201Response.md)
|
|
1250
1379
|
|
|
1251
1380
|
### Authorization
|
|
1252
1381
|
|
|
@@ -1258,13 +1387,13 @@ Name | Type | Description | Notes
|
|
|
1258
1387
|
- **Accept**: application/json
|
|
1259
1388
|
|
|
1260
1389
|
|
|
1261
|
-
##
|
|
1390
|
+
## deleteDestination
|
|
1262
1391
|
|
|
1263
|
-
>
|
|
1392
|
+
> DeleteDestination200Response deleteDestination(destination_id)
|
|
1264
1393
|
|
|
1265
|
-
|
|
1394
|
+
Delete destination (Deprecated)
|
|
1266
1395
|
|
|
1267
|
-
This operation
|
|
1396
|
+
This operation deletes a destination.
|
|
1268
1397
|
|
|
1269
1398
|
### Example
|
|
1270
1399
|
|
|
@@ -1278,10 +1407,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1278
1407
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1279
1408
|
// Call the API
|
|
1280
1409
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1281
|
-
const
|
|
1282
|
-
|
|
1283
|
-
};
|
|
1284
|
-
apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
1410
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1411
|
+
apiInstance.deleteDestination(destination_id).then((data) => {
|
|
1285
1412
|
console.log('API called successfully. Returned data: ' + data);
|
|
1286
1413
|
}, (error) => {
|
|
1287
1414
|
console.error(error);
|
|
@@ -1294,11 +1421,11 @@ apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
|
1294
1421
|
|
|
1295
1422
|
Name | Type | Description | Notes
|
|
1296
1423
|
------------- | ------------- | ------------- | -------------
|
|
1297
|
-
**
|
|
1424
|
+
**destination_id** | **String**| The destination ID. |
|
|
1298
1425
|
|
|
1299
1426
|
### Return type
|
|
1300
1427
|
|
|
1301
|
-
[**
|
|
1428
|
+
[**DeleteDestination200Response**](DeleteDestination200Response.md)
|
|
1302
1429
|
|
|
1303
1430
|
### Authorization
|
|
1304
1431
|
|
|
@@ -1306,17 +1433,17 @@ Name | Type | Description | Notes
|
|
|
1306
1433
|
|
|
1307
1434
|
### HTTP request headers
|
|
1308
1435
|
|
|
1309
|
-
- **Content-Type**:
|
|
1436
|
+
- **Content-Type**: Not defined
|
|
1310
1437
|
- **Accept**: application/json
|
|
1311
1438
|
|
|
1312
1439
|
|
|
1313
|
-
##
|
|
1440
|
+
## deleteDestinationBankAccount
|
|
1314
1441
|
|
|
1315
|
-
>
|
|
1442
|
+
> DeleteDestinationBankAccount200Response deleteDestinationBankAccount(bank_account_id)
|
|
1316
1443
|
|
|
1317
|
-
|
|
1444
|
+
Delete destination bank account
|
|
1318
1445
|
|
|
1319
|
-
This operation
|
|
1446
|
+
This operation deletes a destination bank account.
|
|
1320
1447
|
|
|
1321
1448
|
### Example
|
|
1322
1449
|
|
|
@@ -1330,10 +1457,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1330
1457
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1331
1458
|
// Call the API
|
|
1332
1459
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1333
|
-
const
|
|
1334
|
-
|
|
1335
|
-
const destination_account = "destination_account_example";
|
|
1336
|
-
apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_account).then((data) => {
|
|
1460
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
1461
|
+
apiInstance.deleteDestinationBankAccount(bank_account_id).then((data) => {
|
|
1337
1462
|
console.log('API called successfully. Returned data: ' + data);
|
|
1338
1463
|
}, (error) => {
|
|
1339
1464
|
console.error(error);
|
|
@@ -1346,13 +1471,11 @@ apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_a
|
|
|
1346
1471
|
|
|
1347
1472
|
Name | Type | Description | Notes
|
|
1348
1473
|
------------- | ------------- | ------------- | -------------
|
|
1349
|
-
**
|
|
1350
|
-
**source_account** | **String**| |
|
|
1351
|
-
**destination_account** | **String**| |
|
|
1474
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
1352
1475
|
|
|
1353
1476
|
### Return type
|
|
1354
1477
|
|
|
1355
|
-
[**
|
|
1478
|
+
[**DeleteDestinationBankAccount200Response**](DeleteDestinationBankAccount200Response.md)
|
|
1356
1479
|
|
|
1357
1480
|
### Authorization
|
|
1358
1481
|
|
|
@@ -1364,13 +1487,13 @@ Name | Type | Description | Notes
|
|
|
1364
1487
|
- **Accept**: application/json
|
|
1365
1488
|
|
|
1366
1489
|
|
|
1367
|
-
##
|
|
1490
|
+
## deleteDestinationById
|
|
1368
1491
|
|
|
1369
|
-
>
|
|
1492
|
+
> DeleteDestinationById200Response deleteDestinationById(destination_id)
|
|
1370
1493
|
|
|
1371
|
-
|
|
1494
|
+
Delete destination
|
|
1372
1495
|
|
|
1373
|
-
This operation
|
|
1496
|
+
This operation deletes a destination. Note that this operation will delete all entries under the destination, including bank accounts and addresses.
|
|
1374
1497
|
|
|
1375
1498
|
### Example
|
|
1376
1499
|
|
|
@@ -1384,8 +1507,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1384
1507
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1385
1508
|
// Call the API
|
|
1386
1509
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1387
|
-
const
|
|
1388
|
-
apiInstance.
|
|
1510
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1511
|
+
apiInstance.deleteDestinationById(destination_id).then((data) => {
|
|
1389
1512
|
console.log('API called successfully. Returned data: ' + data);
|
|
1390
1513
|
}, (error) => {
|
|
1391
1514
|
console.error(error);
|
|
@@ -1398,11 +1521,11 @@ apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
|
1398
1521
|
|
|
1399
1522
|
Name | Type | Description | Notes
|
|
1400
1523
|
------------- | ------------- | ------------- | -------------
|
|
1401
|
-
**
|
|
1524
|
+
**destination_id** | **String**| The destination ID. |
|
|
1402
1525
|
|
|
1403
1526
|
### Return type
|
|
1404
1527
|
|
|
1405
|
-
[**
|
|
1528
|
+
[**DeleteDestinationById200Response**](DeleteDestinationById200Response.md)
|
|
1406
1529
|
|
|
1407
1530
|
### Authorization
|
|
1408
1531
|
|
|
@@ -1414,13 +1537,13 @@ Name | Type | Description | Notes
|
|
|
1414
1537
|
- **Accept**: application/json
|
|
1415
1538
|
|
|
1416
1539
|
|
|
1417
|
-
##
|
|
1540
|
+
## deleteDestinationEntry
|
|
1418
1541
|
|
|
1419
|
-
>
|
|
1542
|
+
> DeleteDestinationEntry200Response deleteDestinationEntry(destination_entry_id, destination_id, entry_type)
|
|
1420
1543
|
|
|
1421
|
-
|
|
1544
|
+
Delete destination entry
|
|
1422
1545
|
|
|
1423
|
-
This operation
|
|
1546
|
+
This operation deletes a destination entry.
|
|
1424
1547
|
|
|
1425
1548
|
### Example
|
|
1426
1549
|
|
|
@@ -1434,8 +1557,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1434
1557
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1435
1558
|
// Call the API
|
|
1436
1559
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1437
|
-
const
|
|
1438
|
-
|
|
1560
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1561
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1562
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
1563
|
+
apiInstance.deleteDestinationEntry(destination_entry_id, destination_id, entry_type).then((data) => {
|
|
1439
1564
|
console.log('API called successfully. Returned data: ' + data);
|
|
1440
1565
|
}, (error) => {
|
|
1441
1566
|
console.error(error);
|
|
@@ -1448,11 +1573,13 @@ apiInstance.getCounterpartyDetailById(counterparty_id).then((data) => {
|
|
|
1448
1573
|
|
|
1449
1574
|
Name | Type | Description | Notes
|
|
1450
1575
|
------------- | ------------- | ------------- | -------------
|
|
1451
|
-
**
|
|
1576
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
1577
|
+
**destination_id** | **String**| The destination ID. |
|
|
1578
|
+
**entry_type** | [**EntryType**](.md)| EntryType defines the type of the counterparty entry: - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. |
|
|
1452
1579
|
|
|
1453
1580
|
### Return type
|
|
1454
1581
|
|
|
1455
|
-
[**
|
|
1582
|
+
[**DeleteDestinationEntry200Response**](DeleteDestinationEntry200Response.md)
|
|
1456
1583
|
|
|
1457
1584
|
### Authorization
|
|
1458
1585
|
|
|
@@ -1464,13 +1591,13 @@ Name | Type | Description | Notes
|
|
|
1464
1591
|
- **Accept**: application/json
|
|
1465
1592
|
|
|
1466
1593
|
|
|
1467
|
-
##
|
|
1594
|
+
## deleteDestinationWalletAddress
|
|
1468
1595
|
|
|
1469
|
-
>
|
|
1596
|
+
> DeleteDestinationWalletAddress200Response deleteDestinationWalletAddress(wallet_address_id)
|
|
1470
1597
|
|
|
1471
|
-
|
|
1598
|
+
Delete destination wallet address
|
|
1472
1599
|
|
|
1473
|
-
This operation
|
|
1600
|
+
This operation deletes a destination wallet address.
|
|
1474
1601
|
|
|
1475
1602
|
### Example
|
|
1476
1603
|
|
|
@@ -1484,8 +1611,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1484
1611
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1485
1612
|
// Call the API
|
|
1486
1613
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1487
|
-
const
|
|
1488
|
-
apiInstance.
|
|
1614
|
+
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1615
|
+
apiInstance.deleteDestinationWalletAddress(wallet_address_id).then((data) => {
|
|
1489
1616
|
console.log('API called successfully. Returned data: ' + data);
|
|
1490
1617
|
}, (error) => {
|
|
1491
1618
|
console.error(error);
|
|
@@ -1498,7 +1625,417 @@ apiInstance.getDestinationBankAccountDetailById(bank_account_id).then((data) =>
|
|
|
1498
1625
|
|
|
1499
1626
|
Name | Type | Description | Notes
|
|
1500
1627
|
------------- | ------------- | ------------- | -------------
|
|
1501
|
-
**
|
|
1628
|
+
**wallet_address_id** | **String**| The wallet address ID. |
|
|
1629
|
+
|
|
1630
|
+
### Return type
|
|
1631
|
+
|
|
1632
|
+
[**DeleteDestinationWalletAddress200Response**](DeleteDestinationWalletAddress200Response.md)
|
|
1633
|
+
|
|
1634
|
+
### Authorization
|
|
1635
|
+
|
|
1636
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1637
|
+
|
|
1638
|
+
### HTTP request headers
|
|
1639
|
+
|
|
1640
|
+
- **Content-Type**: Not defined
|
|
1641
|
+
- **Accept**: application/json
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
## enableDestinationWhitelist
|
|
1645
|
+
|
|
1646
|
+
> QueryDestinationWhitelistEnabled200Response enableDestinationWhitelist(opts)
|
|
1647
|
+
|
|
1648
|
+
Enable or disable destination whitelist
|
|
1649
|
+
|
|
1650
|
+
This operation enables or disables the whitelist for a destination.
|
|
1651
|
+
|
|
1652
|
+
### Example
|
|
1653
|
+
|
|
1654
|
+
```javascript
|
|
1655
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1656
|
+
// Initialize the API client
|
|
1657
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1658
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1659
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1660
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1661
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1662
|
+
// Call the API
|
|
1663
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1664
|
+
const opts = {
|
|
1665
|
+
'EnableDestinationWhitelistRequest': new CoboWaas2.EnableDestinationWhitelistRequest()
|
|
1666
|
+
};
|
|
1667
|
+
apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
1668
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1669
|
+
}, (error) => {
|
|
1670
|
+
console.error(error);
|
|
1671
|
+
});
|
|
1672
|
+
|
|
1673
|
+
```
|
|
1674
|
+
|
|
1675
|
+
### Parameters
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
Name | Type | Description | Notes
|
|
1679
|
+
------------- | ------------- | ------------- | -------------
|
|
1680
|
+
**EnableDestinationWhitelistRequest** | [**EnableDestinationWhitelistRequest**](EnableDestinationWhitelistRequest.md)| The request body to enable or disable the destination whitelist. | [optional]
|
|
1681
|
+
|
|
1682
|
+
### Return type
|
|
1683
|
+
|
|
1684
|
+
[**QueryDestinationWhitelistEnabled200Response**](QueryDestinationWhitelistEnabled200Response.md)
|
|
1685
|
+
|
|
1686
|
+
### Authorization
|
|
1687
|
+
|
|
1688
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1689
|
+
|
|
1690
|
+
### HTTP request headers
|
|
1691
|
+
|
|
1692
|
+
- **Content-Type**: application/json
|
|
1693
|
+
- **Accept**: application/json
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
## getAvailableAllocationAmount
|
|
1697
|
+
|
|
1698
|
+
> PaymentAllocationAmount getAvailableAllocationAmount(token_id, source_account, destination_account)
|
|
1699
|
+
|
|
1700
|
+
Get available allocation amount
|
|
1701
|
+
|
|
1702
|
+
This operation retrieves the available amount that can be allocated from a source account to a destination account.
|
|
1703
|
+
|
|
1704
|
+
### Example
|
|
1705
|
+
|
|
1706
|
+
```javascript
|
|
1707
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1708
|
+
// Initialize the API client
|
|
1709
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1710
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1711
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1712
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1713
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1714
|
+
// Call the API
|
|
1715
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1716
|
+
const token_id = "ETH_USDT";
|
|
1717
|
+
const source_account = "source_account_example";
|
|
1718
|
+
const destination_account = "destination_account_example";
|
|
1719
|
+
apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_account).then((data) => {
|
|
1720
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1721
|
+
}, (error) => {
|
|
1722
|
+
console.error(error);
|
|
1723
|
+
});
|
|
1724
|
+
|
|
1725
|
+
```
|
|
1726
|
+
|
|
1727
|
+
### Parameters
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
Name | Type | Description | Notes
|
|
1731
|
+
------------- | ------------- | ------------- | -------------
|
|
1732
|
+
**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}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
1733
|
+
**source_account** | **String**| The source account. - 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\"`. |
|
|
1734
|
+
**destination_account** | **String**| The destination account. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. |
|
|
1735
|
+
|
|
1736
|
+
### Return type
|
|
1737
|
+
|
|
1738
|
+
[**PaymentAllocationAmount**](PaymentAllocationAmount.md)
|
|
1739
|
+
|
|
1740
|
+
### Authorization
|
|
1741
|
+
|
|
1742
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1743
|
+
|
|
1744
|
+
### HTTP request headers
|
|
1745
|
+
|
|
1746
|
+
- **Content-Type**: Not defined
|
|
1747
|
+
- **Accept**: application/json
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
## getBatchAllocationById
|
|
1751
|
+
|
|
1752
|
+
> BatchAllocationDetail getBatchAllocationById(batch_allocation_id)
|
|
1753
|
+
|
|
1754
|
+
Get batch allocation information
|
|
1755
|
+
|
|
1756
|
+
This operation retrieves the information of a batch allocation.
|
|
1757
|
+
|
|
1758
|
+
### Example
|
|
1759
|
+
|
|
1760
|
+
```javascript
|
|
1761
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1762
|
+
// Initialize the API client
|
|
1763
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1764
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1765
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1766
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1767
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1768
|
+
// Call the API
|
|
1769
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1770
|
+
const batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1771
|
+
apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
1772
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1773
|
+
}, (error) => {
|
|
1774
|
+
console.error(error);
|
|
1775
|
+
});
|
|
1776
|
+
|
|
1777
|
+
```
|
|
1778
|
+
|
|
1779
|
+
### Parameters
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
Name | Type | Description | Notes
|
|
1783
|
+
------------- | ------------- | ------------- | -------------
|
|
1784
|
+
**batch_allocation_id** | **String**| The batch allocation ID. |
|
|
1785
|
+
|
|
1786
|
+
### Return type
|
|
1787
|
+
|
|
1788
|
+
[**BatchAllocationDetail**](BatchAllocationDetail.md)
|
|
1789
|
+
|
|
1790
|
+
### Authorization
|
|
1791
|
+
|
|
1792
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1793
|
+
|
|
1794
|
+
### HTTP request headers
|
|
1795
|
+
|
|
1796
|
+
- **Content-Type**: Not defined
|
|
1797
|
+
- **Accept**: application/json
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
## getCounterparty
|
|
1801
|
+
|
|
1802
|
+
> CounterpartyDetail getCounterparty(counterparty_id)
|
|
1803
|
+
|
|
1804
|
+
Get counterparty information
|
|
1805
|
+
|
|
1806
|
+
This operation retrieves the detailed information about a specified counterparty.
|
|
1807
|
+
|
|
1808
|
+
### Example
|
|
1809
|
+
|
|
1810
|
+
```javascript
|
|
1811
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1812
|
+
// Initialize the API client
|
|
1813
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1814
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1815
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1816
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1817
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1818
|
+
// Call the API
|
|
1819
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1820
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1821
|
+
apiInstance.getCounterparty(counterparty_id).then((data) => {
|
|
1822
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1823
|
+
}, (error) => {
|
|
1824
|
+
console.error(error);
|
|
1825
|
+
});
|
|
1826
|
+
|
|
1827
|
+
```
|
|
1828
|
+
|
|
1829
|
+
### Parameters
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
Name | Type | Description | Notes
|
|
1833
|
+
------------- | ------------- | ------------- | -------------
|
|
1834
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1835
|
+
|
|
1836
|
+
### Return type
|
|
1837
|
+
|
|
1838
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
1839
|
+
|
|
1840
|
+
### Authorization
|
|
1841
|
+
|
|
1842
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1843
|
+
|
|
1844
|
+
### HTTP request headers
|
|
1845
|
+
|
|
1846
|
+
- **Content-Type**: Not defined
|
|
1847
|
+
- **Accept**: application/json
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
## getCounterpartyDetailById
|
|
1851
|
+
|
|
1852
|
+
> CounterpartyDetail getCounterpartyDetailById(counterparty_id)
|
|
1853
|
+
|
|
1854
|
+
Get counterparty information (Deprecated)
|
|
1855
|
+
|
|
1856
|
+
This operation retrieves the detailed information about a specified counterparty.
|
|
1857
|
+
|
|
1858
|
+
### Example
|
|
1859
|
+
|
|
1860
|
+
```javascript
|
|
1861
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1862
|
+
// Initialize the API client
|
|
1863
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1864
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1865
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1866
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1867
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1868
|
+
// Call the API
|
|
1869
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1870
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1871
|
+
apiInstance.getCounterpartyDetailById(counterparty_id).then((data) => {
|
|
1872
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1873
|
+
}, (error) => {
|
|
1874
|
+
console.error(error);
|
|
1875
|
+
});
|
|
1876
|
+
|
|
1877
|
+
```
|
|
1878
|
+
|
|
1879
|
+
### Parameters
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
Name | Type | Description | Notes
|
|
1883
|
+
------------- | ------------- | ------------- | -------------
|
|
1884
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1885
|
+
|
|
1886
|
+
### Return type
|
|
1887
|
+
|
|
1888
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
1889
|
+
|
|
1890
|
+
### Authorization
|
|
1891
|
+
|
|
1892
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1893
|
+
|
|
1894
|
+
### HTTP request headers
|
|
1895
|
+
|
|
1896
|
+
- **Content-Type**: Not defined
|
|
1897
|
+
- **Accept**: application/json
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
## getCounterpartyEntry
|
|
1901
|
+
|
|
1902
|
+
> GetCounterpartyEntry200Response getCounterpartyEntry(counterparty_entry_id, opts)
|
|
1903
|
+
|
|
1904
|
+
Get counterparty entry information
|
|
1905
|
+
|
|
1906
|
+
This operation retrieves the detailed information about a specified counterparty entry.
|
|
1907
|
+
|
|
1908
|
+
### Example
|
|
1909
|
+
|
|
1910
|
+
```javascript
|
|
1911
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1912
|
+
// Initialize the API client
|
|
1913
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1914
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1915
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1916
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1917
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1918
|
+
// Call the API
|
|
1919
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1920
|
+
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1921
|
+
const opts = {
|
|
1922
|
+
'entry_type': new CoboWaas2.EntryType()
|
|
1923
|
+
};
|
|
1924
|
+
apiInstance.getCounterpartyEntry(counterparty_entry_id, opts).then((data) => {
|
|
1925
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1926
|
+
}, (error) => {
|
|
1927
|
+
console.error(error);
|
|
1928
|
+
});
|
|
1929
|
+
|
|
1930
|
+
```
|
|
1931
|
+
|
|
1932
|
+
### Parameters
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
Name | Type | Description | Notes
|
|
1936
|
+
------------- | ------------- | ------------- | -------------
|
|
1937
|
+
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
1938
|
+
**entry_type** | [**EntryType**](.md)| The type of the counterparty entry. - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. | [optional]
|
|
1939
|
+
|
|
1940
|
+
### Return type
|
|
1941
|
+
|
|
1942
|
+
[**GetCounterpartyEntry200Response**](GetCounterpartyEntry200Response.md)
|
|
1943
|
+
|
|
1944
|
+
### Authorization
|
|
1945
|
+
|
|
1946
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1947
|
+
|
|
1948
|
+
### HTTP request headers
|
|
1949
|
+
|
|
1950
|
+
- **Content-Type**: Not defined
|
|
1951
|
+
- **Accept**: application/json
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
## getDestination
|
|
1955
|
+
|
|
1956
|
+
> DestinationDetail getDestination(destination_id)
|
|
1957
|
+
|
|
1958
|
+
Get destination information
|
|
1959
|
+
|
|
1960
|
+
This operation retrieves the detailed information about a specified destination.
|
|
1961
|
+
|
|
1962
|
+
### Example
|
|
1963
|
+
|
|
1964
|
+
```javascript
|
|
1965
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1966
|
+
// Initialize the API client
|
|
1967
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1968
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1969
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1970
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1971
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1972
|
+
// Call the API
|
|
1973
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1974
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1975
|
+
apiInstance.getDestination(destination_id).then((data) => {
|
|
1976
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1977
|
+
}, (error) => {
|
|
1978
|
+
console.error(error);
|
|
1979
|
+
});
|
|
1980
|
+
|
|
1981
|
+
```
|
|
1982
|
+
|
|
1983
|
+
### Parameters
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
Name | Type | Description | Notes
|
|
1987
|
+
------------- | ------------- | ------------- | -------------
|
|
1988
|
+
**destination_id** | **String**| The destination ID. |
|
|
1989
|
+
|
|
1990
|
+
### Return type
|
|
1991
|
+
|
|
1992
|
+
[**DestinationDetail**](DestinationDetail.md)
|
|
1993
|
+
|
|
1994
|
+
### Authorization
|
|
1995
|
+
|
|
1996
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1997
|
+
|
|
1998
|
+
### HTTP request headers
|
|
1999
|
+
|
|
2000
|
+
- **Content-Type**: Not defined
|
|
2001
|
+
- **Accept**: application/json
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
## getDestinationBankAccountDetailById
|
|
2005
|
+
|
|
2006
|
+
> DestinationBankAccountDetail getDestinationBankAccountDetailById(bank_account_id)
|
|
2007
|
+
|
|
2008
|
+
Get destination bank account information
|
|
2009
|
+
|
|
2010
|
+
This operation retrieves the detailed information about a specified destination bank account.
|
|
2011
|
+
|
|
2012
|
+
### Example
|
|
2013
|
+
|
|
2014
|
+
```javascript
|
|
2015
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2016
|
+
// Initialize the API client
|
|
2017
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2018
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2019
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2020
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2021
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2022
|
+
// Call the API
|
|
2023
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2024
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
2025
|
+
apiInstance.getDestinationBankAccountDetailById(bank_account_id).then((data) => {
|
|
2026
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2027
|
+
}, (error) => {
|
|
2028
|
+
console.error(error);
|
|
2029
|
+
});
|
|
2030
|
+
|
|
2031
|
+
```
|
|
2032
|
+
|
|
2033
|
+
### Parameters
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
Name | Type | Description | Notes
|
|
2037
|
+
------------- | ------------- | ------------- | -------------
|
|
2038
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
1502
2039
|
|
|
1503
2040
|
### Return type
|
|
1504
2041
|
|
|
@@ -1518,7 +2055,7 @@ Name | Type | Description | Notes
|
|
|
1518
2055
|
|
|
1519
2056
|
> DestinationDetail getDestinationDetailById(destination_id)
|
|
1520
2057
|
|
|
1521
|
-
Get destination information
|
|
2058
|
+
Get destination information (Deprecated)
|
|
1522
2059
|
|
|
1523
2060
|
This operation retrieves the detailed information about a specified destination.
|
|
1524
2061
|
|
|
@@ -1564,6 +2101,58 @@ Name | Type | Description | Notes
|
|
|
1564
2101
|
- **Accept**: application/json
|
|
1565
2102
|
|
|
1566
2103
|
|
|
2104
|
+
## getDestinationEntry
|
|
2105
|
+
|
|
2106
|
+
> GetDestinationEntry200Response getDestinationEntry(destination_entry_id, entry_type)
|
|
2107
|
+
|
|
2108
|
+
Get destination entry information
|
|
2109
|
+
|
|
2110
|
+
This operation retrieves the detailed information about a specified destination entry.
|
|
2111
|
+
|
|
2112
|
+
### Example
|
|
2113
|
+
|
|
2114
|
+
```javascript
|
|
2115
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2116
|
+
// Initialize the API client
|
|
2117
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2118
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2119
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2120
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2121
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2122
|
+
// Call the API
|
|
2123
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2124
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
2125
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
2126
|
+
apiInstance.getDestinationEntry(destination_entry_id, entry_type).then((data) => {
|
|
2127
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2128
|
+
}, (error) => {
|
|
2129
|
+
console.error(error);
|
|
2130
|
+
});
|
|
2131
|
+
|
|
2132
|
+
```
|
|
2133
|
+
|
|
2134
|
+
### Parameters
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
Name | Type | Description | Notes
|
|
2138
|
+
------------- | ------------- | ------------- | -------------
|
|
2139
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
2140
|
+
**entry_type** | [**EntryType**](.md)| EntryType defines the type of the counterparty entry: - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. |
|
|
2141
|
+
|
|
2142
|
+
### Return type
|
|
2143
|
+
|
|
2144
|
+
[**GetDestinationEntry200Response**](GetDestinationEntry200Response.md)
|
|
2145
|
+
|
|
2146
|
+
### Authorization
|
|
2147
|
+
|
|
2148
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2149
|
+
|
|
2150
|
+
### HTTP request headers
|
|
2151
|
+
|
|
2152
|
+
- **Content-Type**: Not defined
|
|
2153
|
+
- **Accept**: application/json
|
|
2154
|
+
|
|
2155
|
+
|
|
1567
2156
|
## getExchangeRate
|
|
1568
2157
|
|
|
1569
2158
|
> GetExchangeRate200Response getExchangeRate(token_id, currency)
|
|
@@ -1722,7 +2311,7 @@ Name | Type | Description | Notes
|
|
|
1722
2311
|
|
|
1723
2312
|
Get developer balance
|
|
1724
2313
|
|
|
1725
|
-
This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [
|
|
2314
|
+
This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances).
|
|
1726
2315
|
|
|
1727
2316
|
### Example
|
|
1728
2317
|
|
|
@@ -1862,7 +2451,7 @@ Name | Type | Description | Notes
|
|
|
1862
2451
|
**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]
|
|
1863
2452
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1864
2453
|
**request_id** | **String**| The request ID. | [optional]
|
|
1865
|
-
**statuses** | **String**| A list of order, refund or
|
|
2454
|
+
**statuses** | **String**| A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) | [optional]
|
|
1866
2455
|
|
|
1867
2456
|
### Return type
|
|
1868
2457
|
|
|
@@ -1878,6 +2467,66 @@ Name | Type | Description | Notes
|
|
|
1878
2467
|
- **Accept**: application/json
|
|
1879
2468
|
|
|
1880
2469
|
|
|
2470
|
+
## getReports
|
|
2471
|
+
|
|
2472
|
+
> GetReports200Response getReports(opts)
|
|
2473
|
+
|
|
2474
|
+
List all reports
|
|
2475
|
+
|
|
2476
|
+
This operation retrieves the information of all reports.
|
|
2477
|
+
|
|
2478
|
+
### Example
|
|
2479
|
+
|
|
2480
|
+
```javascript
|
|
2481
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2482
|
+
// Initialize the API client
|
|
2483
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2484
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2485
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2486
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2487
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2488
|
+
// Call the API
|
|
2489
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2490
|
+
const opts = {
|
|
2491
|
+
'limit': 10,
|
|
2492
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2493
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2494
|
+
'report_type': new CoboWaas2.ReportType(),
|
|
2495
|
+
'report_status': new CoboWaas2.ReportStatus()
|
|
2496
|
+
};
|
|
2497
|
+
apiInstance.getReports(opts).then((data) => {
|
|
2498
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2499
|
+
}, (error) => {
|
|
2500
|
+
console.error(error);
|
|
2501
|
+
});
|
|
2502
|
+
|
|
2503
|
+
```
|
|
2504
|
+
|
|
2505
|
+
### Parameters
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
Name | Type | Description | Notes
|
|
2509
|
+
------------- | ------------- | ------------- | -------------
|
|
2510
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2511
|
+
**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]
|
|
2512
|
+
**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]
|
|
2513
|
+
**report_type** | [**ReportType**](.md)| The type of the report. - `Order`: Summary of all pay-in orders. - `OrderTransaction`: Summary of all pay-in order transactions. - `TopUpTransaction`: Summary of all top-up transactions. - `PayinWeeklyStatement`: Weekly report of all pay-ins (including order mode and top-up mode). - `PayinDailyStatement`: Daily report of all pay-ins (including order mode and top-up mode). - `CryptoPayout`: Summary of all crypto payout transactions. - `OffRamp`: Summary of all fiat off-ramp transactions. - `Refund`: Summary of all refund transactions. - `PayoutWeeklyStatement`: Weekly report of all payouts (including crypto payouts, fiat off-ramps, and refunds). - `PayoutDailyStatement`: Daily report of all payouts (including crypto payouts, fiat off-ramps, and refunds). - `PayinCommissionFee`: Summary of all commission fees for pay-ins. - `PayoutCommissionFee`: Summary of all commission fees for payouts. - `BalanceChange`: Summary of balance changes for all accounts. - `Summary`: Summary of all pay-ins, payouts, and commission fees. | [optional]
|
|
2514
|
+
**report_status** | [**ReportStatus**](.md)| The status of the report. - `Completed`: The report has been generated successfully. - `Failed`: The report could not be generated. | [optional]
|
|
2515
|
+
|
|
2516
|
+
### Return type
|
|
2517
|
+
|
|
2518
|
+
[**GetReports200Response**](GetReports200Response.md)
|
|
2519
|
+
|
|
2520
|
+
### Authorization
|
|
2521
|
+
|
|
2522
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2523
|
+
|
|
2524
|
+
### HTTP request headers
|
|
2525
|
+
|
|
2526
|
+
- **Content-Type**: Not defined
|
|
2527
|
+
- **Accept**: application/json
|
|
2528
|
+
|
|
2529
|
+
|
|
1881
2530
|
## getSettlementById
|
|
1882
2531
|
|
|
1883
2532
|
> Settlement getSettlementById(settlement_request_id)
|
|
@@ -2044,9 +2693,9 @@ Name | Type | Description | Notes
|
|
|
2044
2693
|
|
|
2045
2694
|
> ListAllocations200Response listAllocations(opts)
|
|
2046
2695
|
|
|
2047
|
-
List all
|
|
2696
|
+
List all allocation records
|
|
2048
2697
|
|
|
2049
|
-
This operation retrieves the information of all
|
|
2698
|
+
This operation retrieves the information of all allocation records. One allocation record corresponds to one allocation request in a batch allocation.
|
|
2050
2699
|
|
|
2051
2700
|
### Example
|
|
2052
2701
|
|
|
@@ -2085,8 +2734,8 @@ Name | Type | Description | Notes
|
|
|
2085
2734
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2086
2735
|
**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]
|
|
2087
2736
|
**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]
|
|
2088
|
-
**source_account** | **String**| | [optional]
|
|
2089
|
-
**destination_account** | **String**| | [optional]
|
|
2737
|
+
**source_account** | **String**| The source account. - 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]
|
|
2738
|
+
**destination_account** | **String**| The destination account. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. | [optional]
|
|
2090
2739
|
**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}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
2091
2740
|
**batch_allocation_id** | **String**| The batch allocation ID. | [optional]
|
|
2092
2741
|
|
|
@@ -2108,9 +2757,55 @@ Name | Type | Description | Notes
|
|
|
2108
2757
|
|
|
2109
2758
|
> [BankAccount] listBankAccounts()
|
|
2110
2759
|
|
|
2111
|
-
List all bank accounts
|
|
2760
|
+
List all bank accounts
|
|
2761
|
+
|
|
2762
|
+
<Note>This operation has been deprecated.</Note> 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.
|
|
2763
|
+
|
|
2764
|
+
### Example
|
|
2765
|
+
|
|
2766
|
+
```javascript
|
|
2767
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2768
|
+
// Initialize the API client
|
|
2769
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2770
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2771
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2772
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2773
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2774
|
+
// Call the API
|
|
2775
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2776
|
+
apiInstance.listBankAccounts().then((data) => {
|
|
2777
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2778
|
+
}, (error) => {
|
|
2779
|
+
console.error(error);
|
|
2780
|
+
});
|
|
2781
|
+
|
|
2782
|
+
```
|
|
2783
|
+
|
|
2784
|
+
### Parameters
|
|
2785
|
+
|
|
2786
|
+
This endpoint does not need any parameter.
|
|
2787
|
+
|
|
2788
|
+
### Return type
|
|
2789
|
+
|
|
2790
|
+
[**[BankAccount]**](BankAccount.md)
|
|
2791
|
+
|
|
2792
|
+
### Authorization
|
|
2793
|
+
|
|
2794
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2795
|
+
|
|
2796
|
+
### HTTP request headers
|
|
2797
|
+
|
|
2798
|
+
- **Content-Type**: Not defined
|
|
2799
|
+
- **Accept**: application/json
|
|
2800
|
+
|
|
2801
|
+
|
|
2802
|
+
## listBatchAllocations
|
|
2803
|
+
|
|
2804
|
+
> ListBatchAllocations200Response listBatchAllocations(opts)
|
|
2805
|
+
|
|
2806
|
+
List all batch allocations
|
|
2112
2807
|
|
|
2113
|
-
This operation retrieves the information of all
|
|
2808
|
+
This operation retrieves the information of all batch allocations.
|
|
2114
2809
|
|
|
2115
2810
|
### Example
|
|
2116
2811
|
|
|
@@ -2124,7 +2819,13 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2124
2819
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2125
2820
|
// Call the API
|
|
2126
2821
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2127
|
-
|
|
2822
|
+
const opts = {
|
|
2823
|
+
'limit': 10,
|
|
2824
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2825
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2826
|
+
'request_id': "random_request_id"
|
|
2827
|
+
};
|
|
2828
|
+
apiInstance.listBatchAllocations(opts).then((data) => {
|
|
2128
2829
|
console.log('API called successfully. Returned data: ' + data);
|
|
2129
2830
|
}, (error) => {
|
|
2130
2831
|
console.error(error);
|
|
@@ -2134,11 +2835,17 @@ apiInstance.listBankAccounts().then((data) => {
|
|
|
2134
2835
|
|
|
2135
2836
|
### Parameters
|
|
2136
2837
|
|
|
2137
|
-
|
|
2838
|
+
|
|
2839
|
+
Name | Type | Description | Notes
|
|
2840
|
+
------------- | ------------- | ------------- | -------------
|
|
2841
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2842
|
+
**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]
|
|
2843
|
+
**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]
|
|
2844
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
2138
2845
|
|
|
2139
2846
|
### Return type
|
|
2140
2847
|
|
|
2141
|
-
[**
|
|
2848
|
+
[**ListBatchAllocations200Response**](ListBatchAllocations200Response.md)
|
|
2142
2849
|
|
|
2143
2850
|
### Authorization
|
|
2144
2851
|
|
|
@@ -2150,13 +2857,13 @@ This endpoint does not need any parameter.
|
|
|
2150
2857
|
- **Accept**: application/json
|
|
2151
2858
|
|
|
2152
2859
|
|
|
2153
|
-
##
|
|
2860
|
+
## listCounterparties
|
|
2154
2861
|
|
|
2155
|
-
>
|
|
2862
|
+
> ListCounterparties200Response listCounterparties(opts)
|
|
2156
2863
|
|
|
2157
|
-
List all
|
|
2864
|
+
List all counterparties
|
|
2158
2865
|
|
|
2159
|
-
This operation retrieves the information of all
|
|
2866
|
+
This operation retrieves the information of all counterparties. You can filter the results by using a keyword for fuzzy search on counterparty names.
|
|
2160
2867
|
|
|
2161
2868
|
### Example
|
|
2162
2869
|
|
|
@@ -2174,9 +2881,11 @@ const opts = {
|
|
|
2174
2881
|
'limit': 10,
|
|
2175
2882
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2176
2883
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2177
|
-
'
|
|
2884
|
+
'keyword': "keyword",
|
|
2885
|
+
'counterparty_type': new CoboWaas2.CounterpartyType(),
|
|
2886
|
+
'country': "USA"
|
|
2178
2887
|
};
|
|
2179
|
-
apiInstance.
|
|
2888
|
+
apiInstance.listCounterparties(opts).then((data) => {
|
|
2180
2889
|
console.log('API called successfully. Returned data: ' + data);
|
|
2181
2890
|
}, (error) => {
|
|
2182
2891
|
console.error(error);
|
|
@@ -2192,11 +2901,13 @@ Name | Type | Description | Notes
|
|
|
2192
2901
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2193
2902
|
**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]
|
|
2194
2903
|
**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]
|
|
2195
|
-
**
|
|
2904
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2905
|
+
**counterparty_type** | [**CounterpartyType**](.md)| The type of the counterparty. - `Individual`: The counterparty is an individual. - `Organization`: The counterparty is an organization. | [optional]
|
|
2906
|
+
**country** | **String**| Country code, in ISO 3166-1 alpha-3 format. | [optional]
|
|
2196
2907
|
|
|
2197
2908
|
### Return type
|
|
2198
2909
|
|
|
2199
|
-
[**
|
|
2910
|
+
[**ListCounterparties200Response**](ListCounterparties200Response.md)
|
|
2200
2911
|
|
|
2201
2912
|
### Authorization
|
|
2202
2913
|
|
|
@@ -2208,13 +2919,13 @@ Name | Type | Description | Notes
|
|
|
2208
2919
|
- **Accept**: application/json
|
|
2209
2920
|
|
|
2210
2921
|
|
|
2211
|
-
##
|
|
2922
|
+
## listCounterpartyEntries
|
|
2212
2923
|
|
|
2213
|
-
>
|
|
2924
|
+
> ListCounterpartyEntries200Response listCounterpartyEntries(opts)
|
|
2214
2925
|
|
|
2215
|
-
List
|
|
2926
|
+
List counterparty entries
|
|
2216
2927
|
|
|
2217
|
-
This operation retrieves the information of
|
|
2928
|
+
This operation retrieves the information of counterparty entries.
|
|
2218
2929
|
|
|
2219
2930
|
### Example
|
|
2220
2931
|
|
|
@@ -2232,11 +2943,12 @@ const opts = {
|
|
|
2232
2943
|
'limit': 10,
|
|
2233
2944
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2234
2945
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2235
|
-
'
|
|
2236
|
-
'
|
|
2237
|
-
'
|
|
2946
|
+
'entry_type': new CoboWaas2.EntryType(),
|
|
2947
|
+
'counterparty_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384",
|
|
2948
|
+
'chain_ids': "ETH",
|
|
2949
|
+
'wallet_address': "0x1234567890abcdef..."
|
|
2238
2950
|
};
|
|
2239
|
-
apiInstance.
|
|
2951
|
+
apiInstance.listCounterpartyEntries(opts).then((data) => {
|
|
2240
2952
|
console.log('API called successfully. Returned data: ' + data);
|
|
2241
2953
|
}, (error) => {
|
|
2242
2954
|
console.error(error);
|
|
@@ -2252,13 +2964,14 @@ Name | Type | Description | Notes
|
|
|
2252
2964
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2253
2965
|
**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]
|
|
2254
2966
|
**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]
|
|
2255
|
-
**
|
|
2256
|
-
**
|
|
2257
|
-
**
|
|
2967
|
+
**entry_type** | [**EntryType**](.md)| The type of the counterparty entry. - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. | [optional]
|
|
2968
|
+
**counterparty_id** | **String**| The counterparty ID. | [optional]
|
|
2969
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
2970
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
2258
2971
|
|
|
2259
2972
|
### Return type
|
|
2260
2973
|
|
|
2261
|
-
[**
|
|
2974
|
+
[**ListCounterpartyEntries200Response**](ListCounterpartyEntries200Response.md)
|
|
2262
2975
|
|
|
2263
2976
|
### Authorization
|
|
2264
2977
|
|
|
@@ -2428,7 +3141,7 @@ Name | Type | Description | Notes
|
|
|
2428
3141
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2429
3142
|
**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]
|
|
2430
3143
|
**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]
|
|
2431
|
-
**keyword** | **String**| A search term
|
|
3144
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2432
3145
|
**destination_id** | **String**| The destination ID. | [optional]
|
|
2433
3146
|
**bank_account_status** | [**BankAccountStatus**](.md)| BankAccountStatus defines the status of the bank account: - `Pending`: The bank account is pending verification by Cobo. - `Approved`: The bank account has been approved by Cobo. - `Rejected`: The bank account has been rejected by Cobo. | [optional]
|
|
2434
3147
|
|
|
@@ -2446,6 +3159,74 @@ Name | Type | Description | Notes
|
|
|
2446
3159
|
- **Accept**: application/json
|
|
2447
3160
|
|
|
2448
3161
|
|
|
3162
|
+
## listDestinationEntries
|
|
3163
|
+
|
|
3164
|
+
> ListDestinationEntries200Response listDestinationEntries(entry_type, opts)
|
|
3165
|
+
|
|
3166
|
+
List destination entries
|
|
3167
|
+
|
|
3168
|
+
This operation retrieves the information of destination entries.
|
|
3169
|
+
|
|
3170
|
+
### Example
|
|
3171
|
+
|
|
3172
|
+
```javascript
|
|
3173
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3174
|
+
// Initialize the API client
|
|
3175
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3176
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3177
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3178
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3179
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3180
|
+
// Call the API
|
|
3181
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3182
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
3183
|
+
const opts = {
|
|
3184
|
+
'limit': 10,
|
|
3185
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3186
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3187
|
+
'destination_id': "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
|
|
3188
|
+
'chain_ids': "ETH",
|
|
3189
|
+
'wallet_address': "0x1234567890abcdef...",
|
|
3190
|
+
'keyword': "keyword",
|
|
3191
|
+
'bank_account_status': new CoboWaas2.BankAccountStatus()
|
|
3192
|
+
};
|
|
3193
|
+
apiInstance.listDestinationEntries(entry_type, opts).then((data) => {
|
|
3194
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3195
|
+
}, (error) => {
|
|
3196
|
+
console.error(error);
|
|
3197
|
+
});
|
|
3198
|
+
|
|
3199
|
+
```
|
|
3200
|
+
|
|
3201
|
+
### Parameters
|
|
3202
|
+
|
|
3203
|
+
|
|
3204
|
+
Name | Type | Description | Notes
|
|
3205
|
+
------------- | ------------- | ------------- | -------------
|
|
3206
|
+
**entry_type** | [**EntryType**](.md)| EntryType defines the type of the counterparty entry: - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. |
|
|
3207
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3208
|
+
**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]
|
|
3209
|
+
**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]
|
|
3210
|
+
**destination_id** | **String**| The destination ID. | [optional]
|
|
3211
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3212
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
3213
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
3214
|
+
**bank_account_status** | [**BankAccountStatus**](.md)| BankAccountStatus defines the status of the bank account: - `Pending`: The bank account is pending verification by Cobo. - `Approved`: The bank account has been approved by Cobo. - `Rejected`: The bank account has been rejected by Cobo. | [optional]
|
|
3215
|
+
|
|
3216
|
+
### Return type
|
|
3217
|
+
|
|
3218
|
+
[**ListDestinationEntries200Response**](ListDestinationEntries200Response.md)
|
|
3219
|
+
|
|
3220
|
+
### Authorization
|
|
3221
|
+
|
|
3222
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3223
|
+
|
|
3224
|
+
### HTTP request headers
|
|
3225
|
+
|
|
3226
|
+
- **Content-Type**: Not defined
|
|
3227
|
+
- **Accept**: application/json
|
|
3228
|
+
|
|
3229
|
+
|
|
2449
3230
|
## listDestinationWalletAddresses
|
|
2450
3231
|
|
|
2451
3232
|
> ListDestinationWalletAddresses200Response listDestinationWalletAddresses(opts)
|
|
@@ -2553,9 +3334,9 @@ Name | Type | Description | Notes
|
|
|
2553
3334
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2554
3335
|
**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]
|
|
2555
3336
|
**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]
|
|
2556
|
-
**keyword** | **String**| A search term
|
|
3337
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2557
3338
|
**destination_type** | [**DestinationType**](.md)| DestinationType defines the type of the destination: - `Individual`: The destination is an individual. - `Organization`: The destination is an organization. | [optional]
|
|
2558
|
-
**country** | **String**|
|
|
3339
|
+
**country** | **String**| Country code, in ISO 3166-1 alpha-3 format. | [optional]
|
|
2559
3340
|
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
2560
3341
|
|
|
2561
3342
|
### Return type
|
|
@@ -2636,7 +3417,7 @@ Name | Type | Description | Notes
|
|
|
2636
3417
|
|
|
2637
3418
|
List merchant balances
|
|
2638
3419
|
|
|
2639
|
-
This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned. For more information, please refer to [
|
|
3420
|
+
This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned. For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances).
|
|
2640
3421
|
|
|
2641
3422
|
### Example
|
|
2642
3423
|
|
|
@@ -2730,7 +3511,7 @@ Name | Type | Description | Notes
|
|
|
2730
3511
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2731
3512
|
**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]
|
|
2732
3513
|
**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]
|
|
2733
|
-
**keyword** | **String**| A search term
|
|
3514
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2734
3515
|
**wallet_id** | **String**| This parameter has been deprecated. | [optional]
|
|
2735
3516
|
**wallet_setup** | [**WalletSetup**](.md)| The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses. - `Shared`: Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously. - `Separate`: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant. - `Default`: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization). | [optional]
|
|
2736
3517
|
|
|
@@ -2794,7 +3575,7 @@ Name | Type | Description | Notes
|
|
|
2794
3575
|
**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]
|
|
2795
3576
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
2796
3577
|
**psp_order_id** | **String**| A unique reference code assigned by the developer to identify this order in their system. | [optional]
|
|
2797
|
-
**statuses** | **String**| A list of order, refund or
|
|
3578
|
+
**statuses** | **String**| A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) | [optional]
|
|
2798
3579
|
|
|
2799
3580
|
### Return type
|
|
2800
3581
|
|
|
@@ -2916,7 +3697,7 @@ Name | Type | Description | Notes
|
|
|
2916
3697
|
|
|
2917
3698
|
List all payout items
|
|
2918
3699
|
|
|
2919
|
-
This operation retrieves the information of all payout items. You can filter the result by
|
|
3700
|
+
This operation retrieves the information of all payout items. You can filter the result by source account or status.
|
|
2920
3701
|
|
|
2921
3702
|
### Example
|
|
2922
3703
|
|
|
@@ -2953,8 +3734,8 @@ Name | Type | Description | Notes
|
|
|
2953
3734
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2954
3735
|
**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]
|
|
2955
3736
|
**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]
|
|
2956
|
-
**source_account** | **String**| | [optional]
|
|
2957
|
-
**statuses** | **String**| A list of order, refund or
|
|
3737
|
+
**source_account** | **String**| The source account. - 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]
|
|
3738
|
+
**statuses** | **String**| A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) | [optional]
|
|
2958
3739
|
|
|
2959
3740
|
### Return type
|
|
2960
3741
|
|
|
@@ -3072,7 +3853,7 @@ Name | Type | Description | Notes
|
|
|
3072
3853
|
**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]
|
|
3073
3854
|
**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]
|
|
3074
3855
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
3075
|
-
**statuses** | **String**| A list of order, refund or
|
|
3856
|
+
**statuses** | **String**| A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) | [optional]
|
|
3076
3857
|
|
|
3077
3858
|
### Return type
|
|
3078
3859
|
|
|
@@ -3418,11 +4199,65 @@ Name | Type | Description | Notes
|
|
|
3418
4199
|
- **Accept**: application/json
|
|
3419
4200
|
|
|
3420
4201
|
|
|
4202
|
+
## updateCounterparty
|
|
4203
|
+
|
|
4204
|
+
> Counterparty updateCounterparty(counterparty_id, opts)
|
|
4205
|
+
|
|
4206
|
+
Update counterparty
|
|
4207
|
+
|
|
4208
|
+
This operation updates the information of a specified counterparty.
|
|
4209
|
+
|
|
4210
|
+
### Example
|
|
4211
|
+
|
|
4212
|
+
```javascript
|
|
4213
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4214
|
+
// Initialize the API client
|
|
4215
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
4216
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4217
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4218
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4219
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4220
|
+
// Call the API
|
|
4221
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4222
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
4223
|
+
const opts = {
|
|
4224
|
+
'UpdateCounterpartyRequest': new CoboWaas2.UpdateCounterpartyRequest()
|
|
4225
|
+
};
|
|
4226
|
+
apiInstance.updateCounterparty(counterparty_id, opts).then((data) => {
|
|
4227
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
4228
|
+
}, (error) => {
|
|
4229
|
+
console.error(error);
|
|
4230
|
+
});
|
|
4231
|
+
|
|
4232
|
+
```
|
|
4233
|
+
|
|
4234
|
+
### Parameters
|
|
4235
|
+
|
|
4236
|
+
|
|
4237
|
+
Name | Type | Description | Notes
|
|
4238
|
+
------------- | ------------- | ------------- | -------------
|
|
4239
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
4240
|
+
**UpdateCounterpartyRequest** | [**UpdateCounterpartyRequest**](UpdateCounterpartyRequest.md)| The request body to update a counterparty. | [optional]
|
|
4241
|
+
|
|
4242
|
+
### Return type
|
|
4243
|
+
|
|
4244
|
+
[**Counterparty**](Counterparty.md)
|
|
4245
|
+
|
|
4246
|
+
### Authorization
|
|
4247
|
+
|
|
4248
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4249
|
+
|
|
4250
|
+
### HTTP request headers
|
|
4251
|
+
|
|
4252
|
+
- **Content-Type**: application/json
|
|
4253
|
+
- **Accept**: application/json
|
|
4254
|
+
|
|
4255
|
+
|
|
3421
4256
|
## updateCounterpartyById
|
|
3422
4257
|
|
|
3423
4258
|
> Counterparty updateCounterpartyById(counterparty_id, opts)
|
|
3424
4259
|
|
|
3425
|
-
Update counterparty
|
|
4260
|
+
Update counterparty (Deprecated)
|
|
3426
4261
|
|
|
3427
4262
|
This operation updates the information of a specified counterparty.
|
|
3428
4263
|
|
|
@@ -3472,6 +4307,60 @@ Name | Type | Description | Notes
|
|
|
3472
4307
|
- **Accept**: application/json
|
|
3473
4308
|
|
|
3474
4309
|
|
|
4310
|
+
## updateDestination
|
|
4311
|
+
|
|
4312
|
+
> Destination updateDestination(destination_id, opts)
|
|
4313
|
+
|
|
4314
|
+
Update destination
|
|
4315
|
+
|
|
4316
|
+
This operation updates the information of a specified destination.
|
|
4317
|
+
|
|
4318
|
+
### Example
|
|
4319
|
+
|
|
4320
|
+
```javascript
|
|
4321
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4322
|
+
// Initialize the API client
|
|
4323
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
4324
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4325
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4326
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4327
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4328
|
+
// Call the API
|
|
4329
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4330
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
4331
|
+
const opts = {
|
|
4332
|
+
'UpdateDestinationRequest': new CoboWaas2.UpdateDestinationRequest()
|
|
4333
|
+
};
|
|
4334
|
+
apiInstance.updateDestination(destination_id, opts).then((data) => {
|
|
4335
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
4336
|
+
}, (error) => {
|
|
4337
|
+
console.error(error);
|
|
4338
|
+
});
|
|
4339
|
+
|
|
4340
|
+
```
|
|
4341
|
+
|
|
4342
|
+
### Parameters
|
|
4343
|
+
|
|
4344
|
+
|
|
4345
|
+
Name | Type | Description | Notes
|
|
4346
|
+
------------- | ------------- | ------------- | -------------
|
|
4347
|
+
**destination_id** | **String**| The destination ID. |
|
|
4348
|
+
**UpdateDestinationRequest** | [**UpdateDestinationRequest**](UpdateDestinationRequest.md)| The request body to update a destination. | [optional]
|
|
4349
|
+
|
|
4350
|
+
### Return type
|
|
4351
|
+
|
|
4352
|
+
[**Destination**](Destination.md)
|
|
4353
|
+
|
|
4354
|
+
### Authorization
|
|
4355
|
+
|
|
4356
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4357
|
+
|
|
4358
|
+
### HTTP request headers
|
|
4359
|
+
|
|
4360
|
+
- **Content-Type**: application/json
|
|
4361
|
+
- **Accept**: application/json
|
|
4362
|
+
|
|
4363
|
+
|
|
3475
4364
|
## updateDestinationBankAccountById
|
|
3476
4365
|
|
|
3477
4366
|
> DestinationBankAccount updateDestinationBankAccountById(bank_account_id, opts)
|
|
@@ -3530,7 +4419,7 @@ Name | Type | Description | Notes
|
|
|
3530
4419
|
|
|
3531
4420
|
> Destination updateDestinationById(destination_id, opts)
|
|
3532
4421
|
|
|
3533
|
-
Update destination
|
|
4422
|
+
Update destination (Deprecated)
|
|
3534
4423
|
|
|
3535
4424
|
This operation updates the information of a specified destination.
|
|
3536
4425
|
|
|
@@ -3564,7 +4453,7 @@ apiInstance.updateDestinationById(destination_id, opts).then((data) => {
|
|
|
3564
4453
|
Name | Type | Description | Notes
|
|
3565
4454
|
------------- | ------------- | ------------- | -------------
|
|
3566
4455
|
**destination_id** | **String**| The destination ID. |
|
|
3567
|
-
**UpdateDestinationByIdRequest** | [**UpdateDestinationByIdRequest**](UpdateDestinationByIdRequest.md)| The request body to
|
|
4456
|
+
**UpdateDestinationByIdRequest** | [**UpdateDestinationByIdRequest**](UpdateDestinationByIdRequest.md)| The request body to update a destination. | [optional]
|
|
3568
4457
|
|
|
3569
4458
|
### Return type
|
|
3570
4459
|
|
|
@@ -3580,6 +4469,60 @@ Name | Type | Description | Notes
|
|
|
3580
4469
|
- **Accept**: application/json
|
|
3581
4470
|
|
|
3582
4471
|
|
|
4472
|
+
## updateDestinationEntry
|
|
4473
|
+
|
|
4474
|
+
> UpdateDestinationEntry200Response updateDestinationEntry(destination_entry_id, opts)
|
|
4475
|
+
|
|
4476
|
+
Update destination entry
|
|
4477
|
+
|
|
4478
|
+
This operation updates the information of a specified destination entry.
|
|
4479
|
+
|
|
4480
|
+
### Example
|
|
4481
|
+
|
|
4482
|
+
```javascript
|
|
4483
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4484
|
+
// Initialize the API client
|
|
4485
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
4486
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4487
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4488
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4489
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4490
|
+
// Call the API
|
|
4491
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4492
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
4493
|
+
const opts = {
|
|
4494
|
+
'UpdateDestinationEntryRequest': new CoboWaas2.UpdateDestinationEntryRequest()
|
|
4495
|
+
};
|
|
4496
|
+
apiInstance.updateDestinationEntry(destination_entry_id, opts).then((data) => {
|
|
4497
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
4498
|
+
}, (error) => {
|
|
4499
|
+
console.error(error);
|
|
4500
|
+
});
|
|
4501
|
+
|
|
4502
|
+
```
|
|
4503
|
+
|
|
4504
|
+
### Parameters
|
|
4505
|
+
|
|
4506
|
+
|
|
4507
|
+
Name | Type | Description | Notes
|
|
4508
|
+
------------- | ------------- | ------------- | -------------
|
|
4509
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
4510
|
+
**UpdateDestinationEntryRequest** | [**UpdateDestinationEntryRequest**](UpdateDestinationEntryRequest.md)| The request body to update a destination entry. | [optional]
|
|
4511
|
+
|
|
4512
|
+
### Return type
|
|
4513
|
+
|
|
4514
|
+
[**UpdateDestinationEntry200Response**](UpdateDestinationEntry200Response.md)
|
|
4515
|
+
|
|
4516
|
+
### Authorization
|
|
4517
|
+
|
|
4518
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4519
|
+
|
|
4520
|
+
### HTTP request headers
|
|
4521
|
+
|
|
4522
|
+
- **Content-Type**: application/json
|
|
4523
|
+
- **Accept**: application/json
|
|
4524
|
+
|
|
4525
|
+
|
|
3583
4526
|
## updateMerchantById
|
|
3584
4527
|
|
|
3585
4528
|
> Merchant updateMerchantById(merchant_id, opts)
|