@cobo/cobo-waas2 1.28.0 → 1.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +88 -16
- 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/GraphQLApi.js +85 -0
- package/dist/api/PaymentApi.js +1161 -154
- package/dist/api/StakingsApi.js +2 -2
- package/dist/api/SwapsApi.js +3 -0
- package/dist/api/TransactionsApi.js +6 -6
- package/dist/api/WalletsApi.js +18 -18
- package/dist/index.js +357 -28
- package/dist/model/AddressRiskLevel.js +71 -0
- package/dist/model/AddressesEventData.js +13 -3
- package/dist/model/{AllocationRecord.js → AllocationItem.js} +38 -35
- package/dist/model/{AllocationRequest.js → AllocationParam.js} +29 -26
- package/dist/model/BalanceUpdateInfoEventData.js +13 -3
- package/dist/model/BatchAllocation.js +12 -12
- package/dist/model/BatchAllocationDetail.js +15 -17
- package/dist/model/BridgingFee.js +3 -3
- package/dist/model/ChainsEventData.js +13 -3
- package/dist/model/CommissionFee.js +2 -2
- package/dist/model/ComplianceDispositionUpdateEventData.js +13 -3
- package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +346 -0
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +13 -3
- package/dist/model/ContractCallParams.js +3 -3
- package/dist/model/CounterpartyWalletAddressDetail.js +2 -2
- package/dist/model/CreateBatchAllocationRequest.js +19 -19
- package/dist/model/CreateBulkSendRequest.js +167 -0
- package/dist/model/CreateBulkSendRequestPayoutParamsInner.js +153 -0
- 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 +17 -15
- package/dist/model/CreatePayoutRequest.js +35 -28
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateReportRequest.js +156 -0
- package/dist/model/CreateTopUpAddresses.js +139 -0
- package/dist/model/CreateTopUpAddresses201Response.js +107 -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/{ListPayoutItems200Response.js → GetReports200Response.js} +22 -22
- 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/{ListAllocations200Response.js → ListAllocationItems200Response.js} +22 -22
- package/dist/model/ListBulkSendItems200Response.js +123 -0
- 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 +13 -3
- package/dist/model/MerchantBalance.js +4 -4
- package/dist/model/Order.js +10 -10
- package/dist/model/OrderLinkBusinessInfo.js +22 -16
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +2 -4
- package/dist/model/OrderLinkBusinessInfoPayableAmountsInner.js +4 -4
- package/dist/model/PaymentAddressUpdateEventData.js +13 -3
- package/dist/model/PaymentAllocationAmount.js +2 -2
- package/dist/model/PaymentBulkSend.js +182 -0
- package/dist/model/PaymentBulkSendEvent.js +359 -0
- package/dist/model/PaymentBulkSendExecutionMode.js +61 -0
- package/dist/model/PaymentBulkSendItem.js +190 -0
- package/dist/model/{PaymentPayoutItemStatus.js → PaymentBulkSendItemStatus.js} +11 -11
- package/dist/model/PaymentBulkSendItemValidationStatus.js +66 -0
- package/dist/model/PaymentBulkSendStatus.js +81 -0
- package/dist/model/PaymentEstimateFeeRequest.js +13 -0
- package/dist/model/PaymentFeeType.js +15 -0
- package/dist/model/PaymentOrderEventData.js +31 -21
- package/dist/model/PaymentPayout.js +64 -46
- package/dist/model/PaymentPayoutDetail.js +166 -52
- package/dist/model/PaymentPayoutEvent.js +152 -80
- package/dist/model/PaymentPayoutItem.js +9 -166
- package/dist/model/PaymentPayoutParam.js +6 -46
- package/dist/model/PaymentPayoutRecipientInfo.js +126 -0
- package/dist/model/PaymentPayoutStatus.js +9 -4
- package/dist/model/PaymentRefundEventData.js +13 -3
- package/dist/model/PaymentSettlementEvent.js +13 -3
- package/dist/model/PaymentTransactionEventData.js +13 -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 +13 -3
- package/dist/model/TSSRequestWebhookEventData.js +13 -3
- package/dist/model/TokenListingEventData.js +13 -3
- package/dist/model/TokensEventData.js +13 -3
- package/dist/model/TransactionCoboCategory.js +5 -0
- package/dist/model/TransactionExtraType.js +5 -0
- package/dist/model/TransactionWalletConnectInfo.js +146 -0
- package/dist/model/TransactionWebhookEventData.js +13 -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 +13 -3
- package/dist/model/WebhookEventData.js +121 -28
- package/dist/model/WebhookEventDataType.js +12 -2
- package/dist/model/WebhookEventType.js +15 -0
- package/docs/AddressRiskLevel.md +16 -0
- package/docs/AddressesEventData.md +5 -1
- package/docs/AllocationItem.md +15 -0
- package/docs/AllocationParam.md +13 -0
- package/docs/AutoSweepApi.md +1 -1
- package/docs/BalanceUpdateInfoEventData.md +5 -1
- package/docs/BatchAllocation.md +2 -2
- package/docs/BatchAllocationDetail.md +1 -1
- package/docs/BridgingFee.md +2 -2
- package/docs/ChainsEventData.md +5 -1
- package/docs/CommissionFee.md +1 -1
- package/docs/ComplianceApi.md +163 -0
- package/docs/ComplianceDispositionUpdateEventData.md +5 -1
- package/docs/ComplianceKyaScreeningsUpdateEventData.md +64 -0
- package/docs/ComplianceKytScreeningsUpdateEventData.md +5 -1
- package/docs/ContractCallParams.md +2 -2
- package/docs/CounterpartyWalletAddressDetail.md +1 -1
- package/docs/CreateBatchAllocationRequest.md +2 -2
- package/docs/CreateBulkSendRequest.md +12 -0
- package/docs/CreateBulkSendRequestPayoutParamsInner.md +12 -0
- 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 +11 -11
- package/docs/CreatePayoutRequest.md +4 -4
- package/docs/CreateRefundRequest.md +2 -2
- package/docs/CreateReportRequest.md +13 -0
- package/docs/CreateTopUpAddresses.md +11 -0
- package/docs/CreateTopUpAddresses201Response.md +9 -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/{ListAllocations200Response.md → GetReports200Response.md} +2 -2
- package/docs/GraphQLApi.md +61 -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/{ListPayoutItems200Response.md → ListAllocationItems200Response.md} +2 -2
- package/docs/ListBulkSendItems200Response.md +10 -0
- package/docs/ListCounterpartyEntries200Response.md +10 -0
- package/docs/ListDestinationEntries200Response.md +11 -0
- package/docs/ListKyaScreenings200Response.md +10 -0
- package/docs/MPCVaultEventData.md +5 -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 +5 -1
- package/docs/PaymentAllocationAmount.md +1 -1
- package/docs/PaymentApi.md +1296 -198
- package/docs/PaymentBulkSend.md +15 -0
- package/docs/PaymentBulkSendEvent.md +65 -0
- package/docs/PaymentBulkSendExecutionMode.md +12 -0
- package/docs/PaymentBulkSendItem.md +15 -0
- package/docs/{PaymentPayoutItemStatus.md → PaymentBulkSendItemStatus.md} +3 -3
- package/docs/PaymentBulkSendItemValidationStatus.md +14 -0
- package/docs/PaymentBulkSendStatus.md +20 -0
- package/docs/PaymentEstimateFeeRequest.md +1 -0
- package/docs/PaymentFeeType.md +6 -0
- package/docs/PaymentOrderEventData.md +13 -9
- package/docs/PaymentPayout.md +8 -7
- package/docs/PaymentPayoutDetail.md +10 -8
- package/docs/PaymentPayoutEvent.md +15 -9
- package/docs/PaymentPayoutItem.md +2 -13
- package/docs/PaymentPayoutParam.md +1 -4
- package/docs/PaymentPayoutRecipientInfo.md +12 -0
- package/docs/PaymentPayoutStatus.md +4 -2
- package/docs/PaymentRefundEventData.md +5 -1
- package/docs/PaymentSettlementEvent.md +5 -1
- package/docs/PaymentTransactionEventData.md +5 -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 +5 -1
- package/docs/SwapsApi.md +2 -0
- package/docs/TSSRequestWebhookEventData.md +5 -1
- package/docs/TokenListingEventData.md +5 -1
- package/docs/TokensEventData.md +5 -1
- package/docs/TransactionCoboCategory.md +2 -0
- package/docs/TransactionExtraType.md +2 -0
- package/docs/TransactionWalletConnectInfo.md +12 -0
- package/docs/TransactionWebhookEventData.md +5 -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 +5 -1
- package/docs/WalletsApi.md +9 -9
- package/docs/WebhookEventData.md +28 -18
- package/docs/WebhookEventDataType.md +5 -1
- package/docs/WebhookEventType.md +6 -0
- package/package.json +1 -1
- package/dist/model/PaymentPayoutItemDetail.js +0 -298
- package/docs/AllocationRecord.md +0 -15
- package/docs/AllocationRequest.md +0 -13
- package/docs/PaymentPayoutItemDetail.md +0 -22
package/docs/PaymentApi.md
CHANGED
|
@@ -7,11 +7,14 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**batchGetExchangeRates**](PaymentApi.md#batchGetExchangeRates) | **GET** /payments/exchange_rates | Batch get exchange rates
|
|
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
|
+
[**createBulkSend**](PaymentApi.md#createBulkSend) | **POST** /payments/bulk_sends | Create bulk send
|
|
10
11
|
[**createCounterparty**](PaymentApi.md#createCounterparty) | **POST** /payments/counterparty | Create counterparty
|
|
12
|
+
[**createCounterpartyEntry**](PaymentApi.md#createCounterpartyEntry) | **POST** /payments/counterparty_entry | Create counterparty entry
|
|
11
13
|
[**createCounterpartyWalletAddress**](PaymentApi.md#createCounterpartyWalletAddress) | **POST** /payments/counterparty/wallet_address | Create counterparty wallet address
|
|
12
14
|
[**createCryptoAddress**](PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
|
|
13
15
|
[**createDestination**](PaymentApi.md#createDestination) | **POST** /payments/destination | Create destination
|
|
14
16
|
[**createDestinationBankAccount**](PaymentApi.md#createDestinationBankAccount) | **POST** /payments/destination/bank_account | Create destination bank account
|
|
17
|
+
[**createDestinationEntry**](PaymentApi.md#createDestinationEntry) | **POST** /payments/destination_entry | Create destination entry
|
|
15
18
|
[**createDestinationWalletAddress**](PaymentApi.md#createDestinationWalletAddress) | **POST** /payments/destination/wallet_address | Create destination wallet address
|
|
16
19
|
[**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
|
|
17
20
|
[**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
@@ -20,35 +23,50 @@ Method | HTTP request | Description
|
|
|
20
23
|
[**createPayout**](PaymentApi.md#createPayout) | **POST** /payments/payouts | Create payout
|
|
21
24
|
[**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
|
|
22
25
|
[**createRefundLink**](PaymentApi.md#createRefundLink) | **POST** /payments/links/refunds | Create refund link
|
|
26
|
+
[**createReport**](PaymentApi.md#createReport) | **POST** /payments/reports | Generate reports
|
|
23
27
|
[**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
|
|
24
|
-
[**
|
|
28
|
+
[**createTopUpAddresses**](PaymentApi.md#createTopUpAddresses) | **POST** /payments/topup/address | Batch create top-up addresses
|
|
29
|
+
[**deleteCounterparty**](PaymentApi.md#deleteCounterparty) | **PUT** /payments/counterparty/{counterparty_id}/delete | Delete counterparty (Deprecated)
|
|
30
|
+
[**deleteCounterpartyById**](PaymentApi.md#deleteCounterpartyById) | **DELETE** /payments/counterparty/{counterparty_id} | Delete counterparty
|
|
31
|
+
[**deleteCounterpartyEntry**](PaymentApi.md#deleteCounterpartyEntry) | **DELETE** /payments/counterparty_entry/{counterparty_entry_id} | Delete counterparty entry
|
|
25
32
|
[**deleteCounterpartyWalletAddress**](PaymentApi.md#deleteCounterpartyWalletAddress) | **PUT** /payments/counterparty/wallet_address/{wallet_address_id}/delete | Delete counterparty wallet address
|
|
26
33
|
[**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
|
|
34
|
+
[**deleteDestination**](PaymentApi.md#deleteDestination) | **PUT** /payments/destination/{destination_id}/delete | Delete destination (Deprecated)
|
|
28
35
|
[**deleteDestinationBankAccount**](PaymentApi.md#deleteDestinationBankAccount) | **PUT** /payments/destination/bank_account/{bank_account_id}/delete | Delete destination bank account
|
|
36
|
+
[**deleteDestinationById**](PaymentApi.md#deleteDestinationById) | **DELETE** /payments/destination/{destination_id} | Delete destination
|
|
37
|
+
[**deleteDestinationEntry**](PaymentApi.md#deleteDestinationEntry) | **DELETE** /payments/destination_entry/{destination_entry_id} | Delete destination entry
|
|
29
38
|
[**deleteDestinationWalletAddress**](PaymentApi.md#deleteDestinationWalletAddress) | **PUT** /payments/destination/wallet_address/{wallet_address_id}/delete | Delete destination wallet address
|
|
30
39
|
[**enableDestinationWhitelist**](PaymentApi.md#enableDestinationWhitelist) | **POST** /payments/destination/enable_whitelist | Enable or disable destination whitelist
|
|
31
40
|
[**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
|
-
[**
|
|
41
|
+
[**getBatchAllocationById**](PaymentApi.md#getBatchAllocationById) | **GET** /payments/batch_allocations/{batch_allocation_id} | Get batch allocation information
|
|
42
|
+
[**getBulkSendById**](PaymentApi.md#getBulkSendById) | **GET** /payments/bulk_sends/{bulk_send_id} | Get bulk send information
|
|
43
|
+
[**getCounterparty**](PaymentApi.md#getCounterparty) | **GET** /payments/counterparty/{counterparty_id} | Get counterparty information
|
|
44
|
+
[**getCounterpartyDetailById**](PaymentApi.md#getCounterpartyDetailById) | **GET** /payments/counterparty/{counterparty_id}/detail | Get counterparty information (Deprecated)
|
|
45
|
+
[**getCounterpartyEntry**](PaymentApi.md#getCounterpartyEntry) | **GET** /payments/counterparty_entry/{counterparty_entry_id} | Get counterparty entry information
|
|
46
|
+
[**getDestination**](PaymentApi.md#getDestination) | **GET** /payments/destination/{destination_id} | Get destination information
|
|
34
47
|
[**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
|
|
48
|
+
[**getDestinationDetailById**](PaymentApi.md#getDestinationDetailById) | **GET** /payments/destination/{destination_id}/detail | Get destination information (Deprecated)
|
|
49
|
+
[**getDestinationEntry**](PaymentApi.md#getDestinationEntry) | **GET** /payments/destination_entry/{destination_entry_id} | Get destination entry information
|
|
36
50
|
[**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
|
|
37
51
|
[**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
|
|
38
52
|
[**getPayoutById**](PaymentApi.md#getPayoutById) | **GET** /payments/payouts/{payout_id} | Get payout information
|
|
39
53
|
[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get developer balance
|
|
40
54
|
[**getRefundDetailById**](PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
|
|
41
55
|
[**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
|
|
56
|
+
[**getReports**](PaymentApi.md#getReports) | **GET** /payments/reports | List all reports
|
|
42
57
|
[**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
|
|
43
58
|
[**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
|
|
44
59
|
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Create/Get top-up address
|
|
45
|
-
[**
|
|
60
|
+
[**listAllocationItems**](PaymentApi.md#listAllocationItems) | **GET** /payments/allocation_items | List all allocation items
|
|
46
61
|
[**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
|
|
47
62
|
[**listBatchAllocations**](PaymentApi.md#listBatchAllocations) | **GET** /payments/batch_allocations | List all batch allocations
|
|
63
|
+
[**listBulkSendItems**](PaymentApi.md#listBulkSendItems) | **GET** /payments/bulk_sends/{bulk_send_id}/items | List bulk send items
|
|
48
64
|
[**listCounterparties**](PaymentApi.md#listCounterparties) | **GET** /payments/counterparty | List all counterparties
|
|
65
|
+
[**listCounterpartyEntries**](PaymentApi.md#listCounterpartyEntries) | **GET** /payments/counterparty_entry | List counterparty entries
|
|
49
66
|
[**listCounterpartyWalletAddress**](PaymentApi.md#listCounterpartyWalletAddress) | **GET** /payments/counterparty/wallet_address | List counterparty wallet addresses
|
|
50
67
|
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
51
68
|
[**listDestinationBankAccounts**](PaymentApi.md#listDestinationBankAccounts) | **GET** /payments/destination/bank_account | List destination bank accounts
|
|
69
|
+
[**listDestinationEntries**](PaymentApi.md#listDestinationEntries) | **GET** /payments/destination_entry | List destination entries
|
|
52
70
|
[**listDestinationWalletAddresses**](PaymentApi.md#listDestinationWalletAddresses) | **GET** /payments/destination/wallet_address | List destination wallet addresses
|
|
53
71
|
[**listDestinations**](PaymentApi.md#listDestinations) | **GET** /payments/destination | List all destinations
|
|
54
72
|
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List forced sweeps
|
|
@@ -57,7 +75,6 @@ Method | HTTP request | Description
|
|
|
57
75
|
[**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
|
|
58
76
|
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List all supported tokens
|
|
59
77
|
[**listPaymentWalletBalances**](PaymentApi.md#listPaymentWalletBalances) | **GET** /payments/balance/payment_wallets | List payment wallet balances
|
|
60
|
-
[**listPayoutItems**](PaymentApi.md#listPayoutItems) | **GET** /payments/payout_items | List all payout items
|
|
61
78
|
[**listPayouts**](PaymentApi.md#listPayouts) | **GET** /payments/payouts | List all payouts
|
|
62
79
|
[**listSettlementDetails**](PaymentApi.md#listSettlementDetails) | **GET** /payments/settlement_details | List all settlement details
|
|
63
80
|
[**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
|
|
@@ -66,9 +83,12 @@ Method | HTTP request | Description
|
|
|
66
83
|
[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
|
|
67
84
|
[**queryDestinationWhitelistEnabled**](PaymentApi.md#queryDestinationWhitelistEnabled) | **GET** /payments/destination/enable_whitelist | Query destination whitelist enabled status
|
|
68
85
|
[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
69
|
-
[**
|
|
86
|
+
[**updateCounterparty**](PaymentApi.md#updateCounterparty) | **PUT** /payments/counterparty/{counterparty_id} | Update counterparty
|
|
87
|
+
[**updateCounterpartyById**](PaymentApi.md#updateCounterpartyById) | **PUT** /payments/counterparty/{counterparty_id}/update | Update counterparty (Deprecated)
|
|
88
|
+
[**updateDestination**](PaymentApi.md#updateDestination) | **PUT** /payments/destination/{destination_id} | Update destination
|
|
70
89
|
[**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
|
|
90
|
+
[**updateDestinationById**](PaymentApi.md#updateDestinationById) | **PUT** /payments/destination/{destination_id}/update | Update destination (Deprecated)
|
|
91
|
+
[**updateDestinationEntry**](PaymentApi.md#updateDestinationEntry) | **PUT** /payments/destination_entry/{destination_entry_id} | Update destination entry
|
|
72
92
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
73
93
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
74
94
|
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
|
|
@@ -184,7 +204,7 @@ Name | Type | Description | Notes
|
|
|
184
204
|
|
|
185
205
|
Create batch allocation
|
|
186
206
|
|
|
187
|
-
This operation
|
|
207
|
+
This operation allocates funds between multiple accounts in one batch request.
|
|
188
208
|
|
|
189
209
|
### Example
|
|
190
210
|
|
|
@@ -214,7 +234,7 @@ apiInstance.createBatchAllocation(opts).then((data) => {
|
|
|
214
234
|
|
|
215
235
|
Name | Type | Description | Notes
|
|
216
236
|
------------- | ------------- | ------------- | -------------
|
|
217
|
-
**CreateBatchAllocationRequest** | [**CreateBatchAllocationRequest**](CreateBatchAllocationRequest.md)| The request body to create a
|
|
237
|
+
**CreateBatchAllocationRequest** | [**CreateBatchAllocationRequest**](CreateBatchAllocationRequest.md)| The request body to create a batch allocation request. | [optional]
|
|
218
238
|
|
|
219
239
|
### Return type
|
|
220
240
|
|
|
@@ -230,13 +250,65 @@ Name | Type | Description | Notes
|
|
|
230
250
|
- **Accept**: application/json
|
|
231
251
|
|
|
232
252
|
|
|
253
|
+
## createBulkSend
|
|
254
|
+
|
|
255
|
+
> PaymentBulkSend createBulkSend(opts)
|
|
256
|
+
|
|
257
|
+
Create bulk send
|
|
258
|
+
|
|
259
|
+
This operation creates a bulk send to transfer funds to multiple recipients in a single request.
|
|
260
|
+
|
|
261
|
+
### Example
|
|
262
|
+
|
|
263
|
+
```javascript
|
|
264
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
265
|
+
// Initialize the API client
|
|
266
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
267
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
268
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
269
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
270
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
271
|
+
// Call the API
|
|
272
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
273
|
+
const opts = {
|
|
274
|
+
'CreateBulkSendRequest': new CoboWaas2.CreateBulkSendRequest()
|
|
275
|
+
};
|
|
276
|
+
apiInstance.createBulkSend(opts).then((data) => {
|
|
277
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
278
|
+
}, (error) => {
|
|
279
|
+
console.error(error);
|
|
280
|
+
});
|
|
281
|
+
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
Name | Type | Description | Notes
|
|
288
|
+
------------- | ------------- | ------------- | -------------
|
|
289
|
+
**CreateBulkSendRequest** | [**CreateBulkSendRequest**](CreateBulkSendRequest.md)| The request body to create a bulk send. | [optional]
|
|
290
|
+
|
|
291
|
+
### Return type
|
|
292
|
+
|
|
293
|
+
[**PaymentBulkSend**](PaymentBulkSend.md)
|
|
294
|
+
|
|
295
|
+
### Authorization
|
|
296
|
+
|
|
297
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
298
|
+
|
|
299
|
+
### HTTP request headers
|
|
300
|
+
|
|
301
|
+
- **Content-Type**: application/json
|
|
302
|
+
- **Accept**: application/json
|
|
303
|
+
|
|
304
|
+
|
|
233
305
|
## createCounterparty
|
|
234
306
|
|
|
235
307
|
> CounterpartyDetail createCounterparty(opts)
|
|
236
308
|
|
|
237
309
|
Create counterparty
|
|
238
310
|
|
|
239
|
-
This operation creates a counterparty.
|
|
311
|
+
This operation creates a [counterparty](https://www.cobo.com/payments/en/guides/counterparties).
|
|
240
312
|
|
|
241
313
|
### Example
|
|
242
314
|
|
|
@@ -282,6 +354,58 @@ Name | Type | Description | Notes
|
|
|
282
354
|
- **Accept**: application/json
|
|
283
355
|
|
|
284
356
|
|
|
357
|
+
## createCounterpartyEntry
|
|
358
|
+
|
|
359
|
+
> CreateCounterpartyEntry201Response createCounterpartyEntry(opts)
|
|
360
|
+
|
|
361
|
+
Create counterparty entry
|
|
362
|
+
|
|
363
|
+
This operation creates one or more entries for a counterparty. A counterparty entry is a record of a counterparty's wallet address.
|
|
364
|
+
|
|
365
|
+
### Example
|
|
366
|
+
|
|
367
|
+
```javascript
|
|
368
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
369
|
+
// Initialize the API client
|
|
370
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
371
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
372
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
373
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
374
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
375
|
+
// Call the API
|
|
376
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
377
|
+
const opts = {
|
|
378
|
+
'CreateCounterpartyEntryRequest': new CoboWaas2.CreateCounterpartyEntryRequest()
|
|
379
|
+
};
|
|
380
|
+
apiInstance.createCounterpartyEntry(opts).then((data) => {
|
|
381
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
382
|
+
}, (error) => {
|
|
383
|
+
console.error(error);
|
|
384
|
+
});
|
|
385
|
+
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
### Parameters
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
Name | Type | Description | Notes
|
|
392
|
+
------------- | ------------- | ------------- | -------------
|
|
393
|
+
**CreateCounterpartyEntryRequest** | [**CreateCounterpartyEntryRequest**](CreateCounterpartyEntryRequest.md)| The request body to create counterparty entries. | [optional]
|
|
394
|
+
|
|
395
|
+
### Return type
|
|
396
|
+
|
|
397
|
+
[**CreateCounterpartyEntry201Response**](CreateCounterpartyEntry201Response.md)
|
|
398
|
+
|
|
399
|
+
### Authorization
|
|
400
|
+
|
|
401
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
402
|
+
|
|
403
|
+
### HTTP request headers
|
|
404
|
+
|
|
405
|
+
- **Content-Type**: application/json
|
|
406
|
+
- **Accept**: application/json
|
|
407
|
+
|
|
408
|
+
|
|
285
409
|
## createCounterpartyWalletAddress
|
|
286
410
|
|
|
287
411
|
> WalletAddress createCounterpartyWalletAddress(opts)
|
|
@@ -392,7 +516,7 @@ Name | Type | Description | Notes
|
|
|
392
516
|
|
|
393
517
|
Create destination
|
|
394
518
|
|
|
395
|
-
This operation creates a destination.
|
|
519
|
+
This operation creates a [destination](https://www.cobo.com/payments/en/guides/destinations).
|
|
396
520
|
|
|
397
521
|
### Example
|
|
398
522
|
|
|
@@ -490,6 +614,58 @@ Name | Type | Description | Notes
|
|
|
490
614
|
- **Accept**: application/json
|
|
491
615
|
|
|
492
616
|
|
|
617
|
+
## createDestinationEntry
|
|
618
|
+
|
|
619
|
+
> CreateDestinationEntry201Response createDestinationEntry(opts)
|
|
620
|
+
|
|
621
|
+
Create destination entry
|
|
622
|
+
|
|
623
|
+
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.
|
|
624
|
+
|
|
625
|
+
### Example
|
|
626
|
+
|
|
627
|
+
```javascript
|
|
628
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
629
|
+
// Initialize the API client
|
|
630
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
631
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
632
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
633
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
634
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
635
|
+
// Call the API
|
|
636
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
637
|
+
const opts = {
|
|
638
|
+
'CreateDestinationEntryRequest': new CoboWaas2.CreateDestinationEntryRequest()
|
|
639
|
+
};
|
|
640
|
+
apiInstance.createDestinationEntry(opts).then((data) => {
|
|
641
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
642
|
+
}, (error) => {
|
|
643
|
+
console.error(error);
|
|
644
|
+
});
|
|
645
|
+
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
### Parameters
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
Name | Type | Description | Notes
|
|
652
|
+
------------- | ------------- | ------------- | -------------
|
|
653
|
+
**CreateDestinationEntryRequest** | [**CreateDestinationEntryRequest**](CreateDestinationEntryRequest.md)| The request body to create destination entries. | [optional]
|
|
654
|
+
|
|
655
|
+
### Return type
|
|
656
|
+
|
|
657
|
+
[**CreateDestinationEntry201Response**](CreateDestinationEntry201Response.md)
|
|
658
|
+
|
|
659
|
+
### Authorization
|
|
660
|
+
|
|
661
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
662
|
+
|
|
663
|
+
### HTTP request headers
|
|
664
|
+
|
|
665
|
+
- **Content-Type**: application/json
|
|
666
|
+
- **Accept**: application/json
|
|
667
|
+
|
|
668
|
+
|
|
493
669
|
## createDestinationWalletAddress
|
|
494
670
|
|
|
495
671
|
> WalletAddress createDestinationWalletAddress(opts)
|
|
@@ -756,7 +932,7 @@ Name | Type | Description | Notes
|
|
|
756
932
|
|
|
757
933
|
Create payout
|
|
758
934
|
|
|
759
|
-
This operation creates a payout to withdraw available balances.
|
|
935
|
+
This operation creates a payout to withdraw available balances.
|
|
760
936
|
|
|
761
937
|
### Example
|
|
762
938
|
|
|
@@ -906,13 +1082,13 @@ Name | Type | Description | Notes
|
|
|
906
1082
|
- **Accept**: application/json
|
|
907
1083
|
|
|
908
1084
|
|
|
909
|
-
##
|
|
1085
|
+
## createReport
|
|
910
1086
|
|
|
911
|
-
>
|
|
1087
|
+
> Report createReport(opts)
|
|
912
1088
|
|
|
913
|
-
|
|
1089
|
+
Generate reports
|
|
914
1090
|
|
|
915
|
-
This operation
|
|
1091
|
+
This operation generates reports for a variety of payment activities, including pay-ins, payouts, and commission fees.
|
|
916
1092
|
|
|
917
1093
|
### Example
|
|
918
1094
|
|
|
@@ -927,9 +1103,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
927
1103
|
// Call the API
|
|
928
1104
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
929
1105
|
const opts = {
|
|
930
|
-
'
|
|
1106
|
+
'CreateReportRequest': new CoboWaas2.CreateReportRequest()
|
|
931
1107
|
};
|
|
932
|
-
apiInstance.
|
|
1108
|
+
apiInstance.createReport(opts).then((data) => {
|
|
933
1109
|
console.log('API called successfully. Returned data: ' + data);
|
|
934
1110
|
}, (error) => {
|
|
935
1111
|
console.error(error);
|
|
@@ -942,11 +1118,11 @@ apiInstance.createSettlementRequest(opts).then((data) => {
|
|
|
942
1118
|
|
|
943
1119
|
Name | Type | Description | Notes
|
|
944
1120
|
------------- | ------------- | ------------- | -------------
|
|
945
|
-
**
|
|
1121
|
+
**CreateReportRequest** | [**CreateReportRequest**](CreateReportRequest.md)| The request body to create payment reports. | [optional]
|
|
946
1122
|
|
|
947
1123
|
### Return type
|
|
948
1124
|
|
|
949
|
-
[**
|
|
1125
|
+
[**Report**](Report.md)
|
|
950
1126
|
|
|
951
1127
|
### Authorization
|
|
952
1128
|
|
|
@@ -958,13 +1134,13 @@ Name | Type | Description | Notes
|
|
|
958
1134
|
- **Accept**: application/json
|
|
959
1135
|
|
|
960
1136
|
|
|
961
|
-
##
|
|
1137
|
+
## createSettlementRequest
|
|
962
1138
|
|
|
963
|
-
>
|
|
1139
|
+
> Settlement createSettlementRequest(opts)
|
|
964
1140
|
|
|
965
|
-
|
|
1141
|
+
Create settlement request
|
|
966
1142
|
|
|
967
|
-
This operation
|
|
1143
|
+
<Note>This operation has been deprecated. Please use [Create payout](https://www.cobo.com/payments/en/api-references/payment/create-payout) instead.</Note> You can include multiple merchants and cryptocurrencies in a single settlement request.
|
|
968
1144
|
|
|
969
1145
|
### Example
|
|
970
1146
|
|
|
@@ -978,8 +1154,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
978
1154
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
979
1155
|
// Call the API
|
|
980
1156
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
981
|
-
const
|
|
982
|
-
|
|
1157
|
+
const opts = {
|
|
1158
|
+
'CreateSettlementRequestRequest': new CoboWaas2.CreateSettlementRequestRequest()
|
|
1159
|
+
};
|
|
1160
|
+
apiInstance.createSettlementRequest(opts).then((data) => {
|
|
983
1161
|
console.log('API called successfully. Returned data: ' + data);
|
|
984
1162
|
}, (error) => {
|
|
985
1163
|
console.error(error);
|
|
@@ -992,11 +1170,11 @@ apiInstance.deleteCounterparty(counterparty_id).then((data) => {
|
|
|
992
1170
|
|
|
993
1171
|
Name | Type | Description | Notes
|
|
994
1172
|
------------- | ------------- | ------------- | -------------
|
|
995
|
-
**
|
|
1173
|
+
**CreateSettlementRequestRequest** | [**CreateSettlementRequestRequest**](CreateSettlementRequestRequest.md)| The request body to create a settlement request. | [optional]
|
|
996
1174
|
|
|
997
1175
|
### Return type
|
|
998
1176
|
|
|
999
|
-
[**
|
|
1177
|
+
[**Settlement**](Settlement.md)
|
|
1000
1178
|
|
|
1001
1179
|
### Authorization
|
|
1002
1180
|
|
|
@@ -1004,17 +1182,17 @@ Name | Type | Description | Notes
|
|
|
1004
1182
|
|
|
1005
1183
|
### HTTP request headers
|
|
1006
1184
|
|
|
1007
|
-
- **Content-Type**:
|
|
1185
|
+
- **Content-Type**: application/json
|
|
1008
1186
|
- **Accept**: application/json
|
|
1009
1187
|
|
|
1010
1188
|
|
|
1011
|
-
##
|
|
1189
|
+
## createTopUpAddresses
|
|
1012
1190
|
|
|
1013
|
-
>
|
|
1191
|
+
> CreateTopUpAddresses201Response createTopUpAddresses(opts)
|
|
1014
1192
|
|
|
1015
|
-
|
|
1193
|
+
Batch create top-up addresses
|
|
1016
1194
|
|
|
1017
|
-
This operation
|
|
1195
|
+
This operation creates top-up addresses for multiple payers under a specific merchant and token in a single request. <Note>This operation supports batch processing of up to 50 payers per request.</Note>
|
|
1018
1196
|
|
|
1019
1197
|
### Example
|
|
1020
1198
|
|
|
@@ -1028,8 +1206,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1028
1206
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1029
1207
|
// Call the API
|
|
1030
1208
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1031
|
-
const
|
|
1032
|
-
|
|
1209
|
+
const opts = {
|
|
1210
|
+
'CreateTopUpAddresses': new CoboWaas2.CreateTopUpAddresses()
|
|
1211
|
+
};
|
|
1212
|
+
apiInstance.createTopUpAddresses(opts).then((data) => {
|
|
1033
1213
|
console.log('API called successfully. Returned data: ' + data);
|
|
1034
1214
|
}, (error) => {
|
|
1035
1215
|
console.error(error);
|
|
@@ -1042,11 +1222,11 @@ apiInstance.deleteCounterpartyWalletAddress(wallet_address_id).then((data) => {
|
|
|
1042
1222
|
|
|
1043
1223
|
Name | Type | Description | Notes
|
|
1044
1224
|
------------- | ------------- | ------------- | -------------
|
|
1045
|
-
**
|
|
1225
|
+
**CreateTopUpAddresses** | [**CreateTopUpAddresses**](CreateTopUpAddresses.md)| The request body of the create top-up addresses operation. | [optional]
|
|
1046
1226
|
|
|
1047
1227
|
### Return type
|
|
1048
1228
|
|
|
1049
|
-
[**
|
|
1229
|
+
[**CreateTopUpAddresses201Response**](CreateTopUpAddresses201Response.md)
|
|
1050
1230
|
|
|
1051
1231
|
### Authorization
|
|
1052
1232
|
|
|
@@ -1054,17 +1234,17 @@ Name | Type | Description | Notes
|
|
|
1054
1234
|
|
|
1055
1235
|
### HTTP request headers
|
|
1056
1236
|
|
|
1057
|
-
- **Content-Type**:
|
|
1237
|
+
- **Content-Type**: application/json
|
|
1058
1238
|
- **Accept**: application/json
|
|
1059
1239
|
|
|
1060
1240
|
|
|
1061
|
-
##
|
|
1241
|
+
## deleteCounterparty
|
|
1062
1242
|
|
|
1063
|
-
>
|
|
1243
|
+
> DeleteCounterparty200Response deleteCounterparty(counterparty_id)
|
|
1064
1244
|
|
|
1065
|
-
Delete
|
|
1245
|
+
Delete counterparty (Deprecated)
|
|
1066
1246
|
|
|
1067
|
-
This operation
|
|
1247
|
+
This operation deletes a counterparty.
|
|
1068
1248
|
|
|
1069
1249
|
### Example
|
|
1070
1250
|
|
|
@@ -1078,8 +1258,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1078
1258
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1079
1259
|
// Call the API
|
|
1080
1260
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1081
|
-
const
|
|
1082
|
-
apiInstance.
|
|
1261
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1262
|
+
apiInstance.deleteCounterparty(counterparty_id).then((data) => {
|
|
1083
1263
|
console.log('API called successfully. Returned data: ' + data);
|
|
1084
1264
|
}, (error) => {
|
|
1085
1265
|
console.error(error);
|
|
@@ -1092,11 +1272,11 @@ apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
|
1092
1272
|
|
|
1093
1273
|
Name | Type | Description | Notes
|
|
1094
1274
|
------------- | ------------- | ------------- | -------------
|
|
1095
|
-
**
|
|
1275
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1096
1276
|
|
|
1097
1277
|
### Return type
|
|
1098
1278
|
|
|
1099
|
-
[**
|
|
1279
|
+
[**DeleteCounterparty200Response**](DeleteCounterparty200Response.md)
|
|
1100
1280
|
|
|
1101
1281
|
### Authorization
|
|
1102
1282
|
|
|
@@ -1108,13 +1288,13 @@ Name | Type | Description | Notes
|
|
|
1108
1288
|
- **Accept**: application/json
|
|
1109
1289
|
|
|
1110
1290
|
|
|
1111
|
-
##
|
|
1291
|
+
## deleteCounterpartyById
|
|
1112
1292
|
|
|
1113
|
-
>
|
|
1293
|
+
> DeleteCounterpartyById200Response deleteCounterpartyById(counterparty_id)
|
|
1114
1294
|
|
|
1115
|
-
Delete
|
|
1295
|
+
Delete counterparty
|
|
1116
1296
|
|
|
1117
|
-
This operation deletes a
|
|
1297
|
+
This operation deletes a counterparty. Note that this operation will delete all entries under the counterparty.
|
|
1118
1298
|
|
|
1119
1299
|
### Example
|
|
1120
1300
|
|
|
@@ -1128,8 +1308,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1128
1308
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1129
1309
|
// Call the API
|
|
1130
1310
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1131
|
-
const
|
|
1132
|
-
apiInstance.
|
|
1311
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1312
|
+
apiInstance.deleteCounterpartyById(counterparty_id).then((data) => {
|
|
1133
1313
|
console.log('API called successfully. Returned data: ' + data);
|
|
1134
1314
|
}, (error) => {
|
|
1135
1315
|
console.error(error);
|
|
@@ -1142,11 +1322,11 @@ apiInstance.deleteDestination(destination_id).then((data) => {
|
|
|
1142
1322
|
|
|
1143
1323
|
Name | Type | Description | Notes
|
|
1144
1324
|
------------- | ------------- | ------------- | -------------
|
|
1145
|
-
**
|
|
1325
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1146
1326
|
|
|
1147
1327
|
### Return type
|
|
1148
1328
|
|
|
1149
|
-
[**
|
|
1329
|
+
[**DeleteCounterpartyById200Response**](DeleteCounterpartyById200Response.md)
|
|
1150
1330
|
|
|
1151
1331
|
### Authorization
|
|
1152
1332
|
|
|
@@ -1158,13 +1338,13 @@ Name | Type | Description | Notes
|
|
|
1158
1338
|
- **Accept**: application/json
|
|
1159
1339
|
|
|
1160
1340
|
|
|
1161
|
-
##
|
|
1341
|
+
## deleteCounterpartyEntry
|
|
1162
1342
|
|
|
1163
|
-
>
|
|
1343
|
+
> DeleteCounterpartyEntry200Response deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts)
|
|
1164
1344
|
|
|
1165
|
-
Delete
|
|
1345
|
+
Delete counterparty entry
|
|
1166
1346
|
|
|
1167
|
-
This operation deletes a
|
|
1347
|
+
This operation deletes a counterparty entry.
|
|
1168
1348
|
|
|
1169
1349
|
### Example
|
|
1170
1350
|
|
|
@@ -1178,8 +1358,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1178
1358
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1179
1359
|
// Call the API
|
|
1180
1360
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1181
|
-
const
|
|
1182
|
-
|
|
1361
|
+
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1362
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1363
|
+
const opts = {
|
|
1364
|
+
'entry_type': new CoboWaas2.EntryType()
|
|
1365
|
+
};
|
|
1366
|
+
apiInstance.deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts).then((data) => {
|
|
1183
1367
|
console.log('API called successfully. Returned data: ' + data);
|
|
1184
1368
|
}, (error) => {
|
|
1185
1369
|
console.error(error);
|
|
@@ -1192,11 +1376,13 @@ apiInstance.deleteDestinationBankAccount(bank_account_id).then((data) => {
|
|
|
1192
1376
|
|
|
1193
1377
|
Name | Type | Description | Notes
|
|
1194
1378
|
------------- | ------------- | ------------- | -------------
|
|
1195
|
-
**
|
|
1379
|
+
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
1380
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1381
|
+
**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]
|
|
1196
1382
|
|
|
1197
1383
|
### Return type
|
|
1198
1384
|
|
|
1199
|
-
[**
|
|
1385
|
+
[**DeleteCounterpartyEntry200Response**](DeleteCounterpartyEntry200Response.md)
|
|
1200
1386
|
|
|
1201
1387
|
### Authorization
|
|
1202
1388
|
|
|
@@ -1208,13 +1394,13 @@ Name | Type | Description | Notes
|
|
|
1208
1394
|
- **Accept**: application/json
|
|
1209
1395
|
|
|
1210
1396
|
|
|
1211
|
-
##
|
|
1397
|
+
## deleteCounterpartyWalletAddress
|
|
1212
1398
|
|
|
1213
|
-
>
|
|
1399
|
+
> DeleteCounterpartyWalletAddress200Response deleteCounterpartyWalletAddress(wallet_address_id)
|
|
1214
1400
|
|
|
1215
|
-
Delete
|
|
1401
|
+
Delete counterparty wallet address
|
|
1216
1402
|
|
|
1217
|
-
This operation deletes a
|
|
1403
|
+
This operation deletes a counterparty wallet address.
|
|
1218
1404
|
|
|
1219
1405
|
### Example
|
|
1220
1406
|
|
|
@@ -1229,7 +1415,7 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
1229
1415
|
// Call the API
|
|
1230
1416
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1231
1417
|
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1232
|
-
apiInstance.
|
|
1418
|
+
apiInstance.deleteCounterpartyWalletAddress(wallet_address_id).then((data) => {
|
|
1233
1419
|
console.log('API called successfully. Returned data: ' + data);
|
|
1234
1420
|
}, (error) => {
|
|
1235
1421
|
console.error(error);
|
|
@@ -1246,7 +1432,7 @@ Name | Type | Description | Notes
|
|
|
1246
1432
|
|
|
1247
1433
|
### Return type
|
|
1248
1434
|
|
|
1249
|
-
[**
|
|
1435
|
+
[**DeleteCounterpartyWalletAddress200Response**](DeleteCounterpartyWalletAddress200Response.md)
|
|
1250
1436
|
|
|
1251
1437
|
### Authorization
|
|
1252
1438
|
|
|
@@ -1258,13 +1444,13 @@ Name | Type | Description | Notes
|
|
|
1258
1444
|
- **Accept**: application/json
|
|
1259
1445
|
|
|
1260
1446
|
|
|
1261
|
-
##
|
|
1447
|
+
## deleteCryptoAddress
|
|
1262
1448
|
|
|
1263
|
-
>
|
|
1449
|
+
> DeleteCryptoAddress201Response deleteCryptoAddress(crypto_address_id)
|
|
1264
1450
|
|
|
1265
|
-
|
|
1451
|
+
Delete crypto address
|
|
1266
1452
|
|
|
1267
|
-
This operation
|
|
1453
|
+
This operation unregisters a crypto address from being used for crypto payouts.
|
|
1268
1454
|
|
|
1269
1455
|
### Example
|
|
1270
1456
|
|
|
@@ -1278,10 +1464,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1278
1464
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1279
1465
|
// Call the API
|
|
1280
1466
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1281
|
-
const
|
|
1282
|
-
|
|
1283
|
-
};
|
|
1284
|
-
apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
1467
|
+
const crypto_address_id = "addr_ethusdt_20250506T123456_ab12cd";
|
|
1468
|
+
apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
1285
1469
|
console.log('API called successfully. Returned data: ' + data);
|
|
1286
1470
|
}, (error) => {
|
|
1287
1471
|
console.error(error);
|
|
@@ -1294,11 +1478,11 @@ apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
|
1294
1478
|
|
|
1295
1479
|
Name | Type | Description | Notes
|
|
1296
1480
|
------------- | ------------- | ------------- | -------------
|
|
1297
|
-
**
|
|
1481
|
+
**crypto_address_id** | **String**| The crypto address ID. |
|
|
1298
1482
|
|
|
1299
1483
|
### Return type
|
|
1300
1484
|
|
|
1301
|
-
[**
|
|
1485
|
+
[**DeleteCryptoAddress201Response**](DeleteCryptoAddress201Response.md)
|
|
1302
1486
|
|
|
1303
1487
|
### Authorization
|
|
1304
1488
|
|
|
@@ -1306,17 +1490,17 @@ Name | Type | Description | Notes
|
|
|
1306
1490
|
|
|
1307
1491
|
### HTTP request headers
|
|
1308
1492
|
|
|
1309
|
-
- **Content-Type**:
|
|
1493
|
+
- **Content-Type**: Not defined
|
|
1310
1494
|
- **Accept**: application/json
|
|
1311
1495
|
|
|
1312
1496
|
|
|
1313
|
-
##
|
|
1497
|
+
## deleteDestination
|
|
1314
1498
|
|
|
1315
|
-
>
|
|
1499
|
+
> DeleteDestination200Response deleteDestination(destination_id)
|
|
1316
1500
|
|
|
1317
|
-
|
|
1501
|
+
Delete destination (Deprecated)
|
|
1318
1502
|
|
|
1319
|
-
This operation
|
|
1503
|
+
This operation deletes a destination.
|
|
1320
1504
|
|
|
1321
1505
|
### Example
|
|
1322
1506
|
|
|
@@ -1330,10 +1514,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1330
1514
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1331
1515
|
// Call the API
|
|
1332
1516
|
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) => {
|
|
1517
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1518
|
+
apiInstance.deleteDestination(destination_id).then((data) => {
|
|
1337
1519
|
console.log('API called successfully. Returned data: ' + data);
|
|
1338
1520
|
}, (error) => {
|
|
1339
1521
|
console.error(error);
|
|
@@ -1346,13 +1528,321 @@ apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_a
|
|
|
1346
1528
|
|
|
1347
1529
|
Name | Type | Description | Notes
|
|
1348
1530
|
------------- | ------------- | ------------- | -------------
|
|
1349
|
-
**
|
|
1350
|
-
**source_account** | **String**| |
|
|
1351
|
-
**destination_account** | **String**| |
|
|
1531
|
+
**destination_id** | **String**| The destination ID. |
|
|
1352
1532
|
|
|
1353
1533
|
### Return type
|
|
1354
1534
|
|
|
1355
|
-
[**
|
|
1535
|
+
[**DeleteDestination200Response**](DeleteDestination200Response.md)
|
|
1536
|
+
|
|
1537
|
+
### Authorization
|
|
1538
|
+
|
|
1539
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1540
|
+
|
|
1541
|
+
### HTTP request headers
|
|
1542
|
+
|
|
1543
|
+
- **Content-Type**: Not defined
|
|
1544
|
+
- **Accept**: application/json
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
## deleteDestinationBankAccount
|
|
1548
|
+
|
|
1549
|
+
> DeleteDestinationBankAccount200Response deleteDestinationBankAccount(bank_account_id)
|
|
1550
|
+
|
|
1551
|
+
Delete destination bank account
|
|
1552
|
+
|
|
1553
|
+
This operation deletes a destination bank account.
|
|
1554
|
+
|
|
1555
|
+
### Example
|
|
1556
|
+
|
|
1557
|
+
```javascript
|
|
1558
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1559
|
+
// Initialize the API client
|
|
1560
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1561
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1562
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1563
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1564
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1565
|
+
// Call the API
|
|
1566
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1567
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
1568
|
+
apiInstance.deleteDestinationBankAccount(bank_account_id).then((data) => {
|
|
1569
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1570
|
+
}, (error) => {
|
|
1571
|
+
console.error(error);
|
|
1572
|
+
});
|
|
1573
|
+
|
|
1574
|
+
```
|
|
1575
|
+
|
|
1576
|
+
### Parameters
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
Name | Type | Description | Notes
|
|
1580
|
+
------------- | ------------- | ------------- | -------------
|
|
1581
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
1582
|
+
|
|
1583
|
+
### Return type
|
|
1584
|
+
|
|
1585
|
+
[**DeleteDestinationBankAccount200Response**](DeleteDestinationBankAccount200Response.md)
|
|
1586
|
+
|
|
1587
|
+
### Authorization
|
|
1588
|
+
|
|
1589
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1590
|
+
|
|
1591
|
+
### HTTP request headers
|
|
1592
|
+
|
|
1593
|
+
- **Content-Type**: Not defined
|
|
1594
|
+
- **Accept**: application/json
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
## deleteDestinationById
|
|
1598
|
+
|
|
1599
|
+
> DeleteDestinationById200Response deleteDestinationById(destination_id)
|
|
1600
|
+
|
|
1601
|
+
Delete destination
|
|
1602
|
+
|
|
1603
|
+
This operation deletes a destination. Note that this operation will delete all entries under the destination, including bank accounts and addresses.
|
|
1604
|
+
|
|
1605
|
+
### Example
|
|
1606
|
+
|
|
1607
|
+
```javascript
|
|
1608
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1609
|
+
// Initialize the API client
|
|
1610
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1611
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1612
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1613
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1614
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1615
|
+
// Call the API
|
|
1616
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1617
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1618
|
+
apiInstance.deleteDestinationById(destination_id).then((data) => {
|
|
1619
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1620
|
+
}, (error) => {
|
|
1621
|
+
console.error(error);
|
|
1622
|
+
});
|
|
1623
|
+
|
|
1624
|
+
```
|
|
1625
|
+
|
|
1626
|
+
### Parameters
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
Name | Type | Description | Notes
|
|
1630
|
+
------------- | ------------- | ------------- | -------------
|
|
1631
|
+
**destination_id** | **String**| The destination ID. |
|
|
1632
|
+
|
|
1633
|
+
### Return type
|
|
1634
|
+
|
|
1635
|
+
[**DeleteDestinationById200Response**](DeleteDestinationById200Response.md)
|
|
1636
|
+
|
|
1637
|
+
### Authorization
|
|
1638
|
+
|
|
1639
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1640
|
+
|
|
1641
|
+
### HTTP request headers
|
|
1642
|
+
|
|
1643
|
+
- **Content-Type**: Not defined
|
|
1644
|
+
- **Accept**: application/json
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
## deleteDestinationEntry
|
|
1648
|
+
|
|
1649
|
+
> DeleteDestinationEntry200Response deleteDestinationEntry(destination_entry_id, destination_id, entry_type)
|
|
1650
|
+
|
|
1651
|
+
Delete destination entry
|
|
1652
|
+
|
|
1653
|
+
This operation deletes a destination entry.
|
|
1654
|
+
|
|
1655
|
+
### Example
|
|
1656
|
+
|
|
1657
|
+
```javascript
|
|
1658
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1659
|
+
// Initialize the API client
|
|
1660
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1661
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1662
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1663
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1664
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1665
|
+
// Call the API
|
|
1666
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1667
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1668
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1669
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
1670
|
+
apiInstance.deleteDestinationEntry(destination_entry_id, destination_id, entry_type).then((data) => {
|
|
1671
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1672
|
+
}, (error) => {
|
|
1673
|
+
console.error(error);
|
|
1674
|
+
});
|
|
1675
|
+
|
|
1676
|
+
```
|
|
1677
|
+
|
|
1678
|
+
### Parameters
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
Name | Type | Description | Notes
|
|
1682
|
+
------------- | ------------- | ------------- | -------------
|
|
1683
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
1684
|
+
**destination_id** | **String**| The destination ID. |
|
|
1685
|
+
**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. |
|
|
1686
|
+
|
|
1687
|
+
### Return type
|
|
1688
|
+
|
|
1689
|
+
[**DeleteDestinationEntry200Response**](DeleteDestinationEntry200Response.md)
|
|
1690
|
+
|
|
1691
|
+
### Authorization
|
|
1692
|
+
|
|
1693
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1694
|
+
|
|
1695
|
+
### HTTP request headers
|
|
1696
|
+
|
|
1697
|
+
- **Content-Type**: Not defined
|
|
1698
|
+
- **Accept**: application/json
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
## deleteDestinationWalletAddress
|
|
1702
|
+
|
|
1703
|
+
> DeleteDestinationWalletAddress200Response deleteDestinationWalletAddress(wallet_address_id)
|
|
1704
|
+
|
|
1705
|
+
Delete destination wallet address
|
|
1706
|
+
|
|
1707
|
+
This operation deletes a destination wallet address.
|
|
1708
|
+
|
|
1709
|
+
### Example
|
|
1710
|
+
|
|
1711
|
+
```javascript
|
|
1712
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1713
|
+
// Initialize the API client
|
|
1714
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1715
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1716
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1717
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1718
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1719
|
+
// Call the API
|
|
1720
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1721
|
+
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1722
|
+
apiInstance.deleteDestinationWalletAddress(wallet_address_id).then((data) => {
|
|
1723
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1724
|
+
}, (error) => {
|
|
1725
|
+
console.error(error);
|
|
1726
|
+
});
|
|
1727
|
+
|
|
1728
|
+
```
|
|
1729
|
+
|
|
1730
|
+
### Parameters
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
Name | Type | Description | Notes
|
|
1734
|
+
------------- | ------------- | ------------- | -------------
|
|
1735
|
+
**wallet_address_id** | **String**| The wallet address ID. |
|
|
1736
|
+
|
|
1737
|
+
### Return type
|
|
1738
|
+
|
|
1739
|
+
[**DeleteDestinationWalletAddress200Response**](DeleteDestinationWalletAddress200Response.md)
|
|
1740
|
+
|
|
1741
|
+
### Authorization
|
|
1742
|
+
|
|
1743
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1744
|
+
|
|
1745
|
+
### HTTP request headers
|
|
1746
|
+
|
|
1747
|
+
- **Content-Type**: Not defined
|
|
1748
|
+
- **Accept**: application/json
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
## enableDestinationWhitelist
|
|
1752
|
+
|
|
1753
|
+
> QueryDestinationWhitelistEnabled200Response enableDestinationWhitelist(opts)
|
|
1754
|
+
|
|
1755
|
+
Enable or disable destination whitelist
|
|
1756
|
+
|
|
1757
|
+
This operation enables or disables the whitelist for a destination.
|
|
1758
|
+
|
|
1759
|
+
### Example
|
|
1760
|
+
|
|
1761
|
+
```javascript
|
|
1762
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1763
|
+
// Initialize the API client
|
|
1764
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1765
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1766
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1767
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1768
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1769
|
+
// Call the API
|
|
1770
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1771
|
+
const opts = {
|
|
1772
|
+
'EnableDestinationWhitelistRequest': new CoboWaas2.EnableDestinationWhitelistRequest()
|
|
1773
|
+
};
|
|
1774
|
+
apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
1775
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1776
|
+
}, (error) => {
|
|
1777
|
+
console.error(error);
|
|
1778
|
+
});
|
|
1779
|
+
|
|
1780
|
+
```
|
|
1781
|
+
|
|
1782
|
+
### Parameters
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
Name | Type | Description | Notes
|
|
1786
|
+
------------- | ------------- | ------------- | -------------
|
|
1787
|
+
**EnableDestinationWhitelistRequest** | [**EnableDestinationWhitelistRequest**](EnableDestinationWhitelistRequest.md)| The request body to enable or disable the destination whitelist. | [optional]
|
|
1788
|
+
|
|
1789
|
+
### Return type
|
|
1790
|
+
|
|
1791
|
+
[**QueryDestinationWhitelistEnabled200Response**](QueryDestinationWhitelistEnabled200Response.md)
|
|
1792
|
+
|
|
1793
|
+
### Authorization
|
|
1794
|
+
|
|
1795
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1796
|
+
|
|
1797
|
+
### HTTP request headers
|
|
1798
|
+
|
|
1799
|
+
- **Content-Type**: application/json
|
|
1800
|
+
- **Accept**: application/json
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
## getAvailableAllocationAmount
|
|
1804
|
+
|
|
1805
|
+
> PaymentAllocationAmount getAvailableAllocationAmount(token_id, source_account, destination_account)
|
|
1806
|
+
|
|
1807
|
+
Get available allocation amount
|
|
1808
|
+
|
|
1809
|
+
This operation retrieves the available amount that can be allocated from a source account to a destination account.
|
|
1810
|
+
|
|
1811
|
+
### Example
|
|
1812
|
+
|
|
1813
|
+
```javascript
|
|
1814
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1815
|
+
// Initialize the API client
|
|
1816
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1817
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1818
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1819
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1820
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1821
|
+
// Call the API
|
|
1822
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1823
|
+
const token_id = "ETH_USDT";
|
|
1824
|
+
const source_account = "source_account_example";
|
|
1825
|
+
const destination_account = "destination_account_example";
|
|
1826
|
+
apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_account).then((data) => {
|
|
1827
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1828
|
+
}, (error) => {
|
|
1829
|
+
console.error(error);
|
|
1830
|
+
});
|
|
1831
|
+
|
|
1832
|
+
```
|
|
1833
|
+
|
|
1834
|
+
### Parameters
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
Name | Type | Description | Notes
|
|
1838
|
+
------------- | ------------- | ------------- | -------------
|
|
1839
|
+
**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` |
|
|
1840
|
+
**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\"`. |
|
|
1841
|
+
**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\"`. |
|
|
1842
|
+
|
|
1843
|
+
### Return type
|
|
1844
|
+
|
|
1845
|
+
[**PaymentAllocationAmount**](PaymentAllocationAmount.md)
|
|
1356
1846
|
|
|
1357
1847
|
### Authorization
|
|
1358
1848
|
|
|
@@ -1366,11 +1856,211 @@ Name | Type | Description | Notes
|
|
|
1366
1856
|
|
|
1367
1857
|
## getBatchAllocationById
|
|
1368
1858
|
|
|
1369
|
-
> BatchAllocationDetail getBatchAllocationById(batch_allocation_id)
|
|
1859
|
+
> BatchAllocationDetail getBatchAllocationById(batch_allocation_id)
|
|
1860
|
+
|
|
1861
|
+
Get batch allocation information
|
|
1862
|
+
|
|
1863
|
+
This operation retrieves the information of a batch allocation.
|
|
1864
|
+
|
|
1865
|
+
### Example
|
|
1866
|
+
|
|
1867
|
+
```javascript
|
|
1868
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1869
|
+
// Initialize the API client
|
|
1870
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1871
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1872
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1873
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1874
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1875
|
+
// Call the API
|
|
1876
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1877
|
+
const batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1878
|
+
apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
1879
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1880
|
+
}, (error) => {
|
|
1881
|
+
console.error(error);
|
|
1882
|
+
});
|
|
1883
|
+
|
|
1884
|
+
```
|
|
1885
|
+
|
|
1886
|
+
### Parameters
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
Name | Type | Description | Notes
|
|
1890
|
+
------------- | ------------- | ------------- | -------------
|
|
1891
|
+
**batch_allocation_id** | **String**| The batch allocation ID. |
|
|
1892
|
+
|
|
1893
|
+
### Return type
|
|
1894
|
+
|
|
1895
|
+
[**BatchAllocationDetail**](BatchAllocationDetail.md)
|
|
1896
|
+
|
|
1897
|
+
### Authorization
|
|
1898
|
+
|
|
1899
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1900
|
+
|
|
1901
|
+
### HTTP request headers
|
|
1902
|
+
|
|
1903
|
+
- **Content-Type**: Not defined
|
|
1904
|
+
- **Accept**: application/json
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
## getBulkSendById
|
|
1908
|
+
|
|
1909
|
+
> PaymentBulkSend getBulkSendById(bulk_send_id)
|
|
1910
|
+
|
|
1911
|
+
Get bulk send information
|
|
1912
|
+
|
|
1913
|
+
This operation retrieves the information of a specific bulk send.
|
|
1914
|
+
|
|
1915
|
+
### Example
|
|
1916
|
+
|
|
1917
|
+
```javascript
|
|
1918
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1919
|
+
// Initialize the API client
|
|
1920
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1921
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1922
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1923
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1924
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1925
|
+
// Call the API
|
|
1926
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1927
|
+
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1928
|
+
apiInstance.getBulkSendById(bulk_send_id).then((data) => {
|
|
1929
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1930
|
+
}, (error) => {
|
|
1931
|
+
console.error(error);
|
|
1932
|
+
});
|
|
1933
|
+
|
|
1934
|
+
```
|
|
1935
|
+
|
|
1936
|
+
### Parameters
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
Name | Type | Description | Notes
|
|
1940
|
+
------------- | ------------- | ------------- | -------------
|
|
1941
|
+
**bulk_send_id** | **String**| The bulk send ID. |
|
|
1942
|
+
|
|
1943
|
+
### Return type
|
|
1944
|
+
|
|
1945
|
+
[**PaymentBulkSend**](PaymentBulkSend.md)
|
|
1946
|
+
|
|
1947
|
+
### Authorization
|
|
1948
|
+
|
|
1949
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1950
|
+
|
|
1951
|
+
### HTTP request headers
|
|
1952
|
+
|
|
1953
|
+
- **Content-Type**: Not defined
|
|
1954
|
+
- **Accept**: application/json
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
## getCounterparty
|
|
1958
|
+
|
|
1959
|
+
> CounterpartyDetail getCounterparty(counterparty_id)
|
|
1960
|
+
|
|
1961
|
+
Get counterparty information
|
|
1962
|
+
|
|
1963
|
+
This operation retrieves the detailed information about a specified counterparty.
|
|
1964
|
+
|
|
1965
|
+
### Example
|
|
1966
|
+
|
|
1967
|
+
```javascript
|
|
1968
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1969
|
+
// Initialize the API client
|
|
1970
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1971
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1972
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1973
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1974
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1975
|
+
// Call the API
|
|
1976
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1977
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1978
|
+
apiInstance.getCounterparty(counterparty_id).then((data) => {
|
|
1979
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1980
|
+
}, (error) => {
|
|
1981
|
+
console.error(error);
|
|
1982
|
+
});
|
|
1983
|
+
|
|
1984
|
+
```
|
|
1985
|
+
|
|
1986
|
+
### Parameters
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
Name | Type | Description | Notes
|
|
1990
|
+
------------- | ------------- | ------------- | -------------
|
|
1991
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1992
|
+
|
|
1993
|
+
### Return type
|
|
1994
|
+
|
|
1995
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
1996
|
+
|
|
1997
|
+
### Authorization
|
|
1998
|
+
|
|
1999
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2000
|
+
|
|
2001
|
+
### HTTP request headers
|
|
2002
|
+
|
|
2003
|
+
- **Content-Type**: Not defined
|
|
2004
|
+
- **Accept**: application/json
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
## getCounterpartyDetailById
|
|
2008
|
+
|
|
2009
|
+
> CounterpartyDetail getCounterpartyDetailById(counterparty_id)
|
|
2010
|
+
|
|
2011
|
+
Get counterparty information (Deprecated)
|
|
2012
|
+
|
|
2013
|
+
This operation retrieves the detailed information about a specified counterparty.
|
|
2014
|
+
|
|
2015
|
+
### Example
|
|
2016
|
+
|
|
2017
|
+
```javascript
|
|
2018
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2019
|
+
// Initialize the API client
|
|
2020
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2021
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2022
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2023
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2024
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2025
|
+
// Call the API
|
|
2026
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2027
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
2028
|
+
apiInstance.getCounterpartyDetailById(counterparty_id).then((data) => {
|
|
2029
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2030
|
+
}, (error) => {
|
|
2031
|
+
console.error(error);
|
|
2032
|
+
});
|
|
2033
|
+
|
|
2034
|
+
```
|
|
2035
|
+
|
|
2036
|
+
### Parameters
|
|
1370
2037
|
|
|
1371
|
-
Get batch allocation by id
|
|
1372
2038
|
|
|
1373
|
-
|
|
2039
|
+
Name | Type | Description | Notes
|
|
2040
|
+
------------- | ------------- | ------------- | -------------
|
|
2041
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
2042
|
+
|
|
2043
|
+
### Return type
|
|
2044
|
+
|
|
2045
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
2046
|
+
|
|
2047
|
+
### Authorization
|
|
2048
|
+
|
|
2049
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2050
|
+
|
|
2051
|
+
### HTTP request headers
|
|
2052
|
+
|
|
2053
|
+
- **Content-Type**: Not defined
|
|
2054
|
+
- **Accept**: application/json
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
## getCounterpartyEntry
|
|
2058
|
+
|
|
2059
|
+
> GetCounterpartyEntry200Response getCounterpartyEntry(counterparty_entry_id, opts)
|
|
2060
|
+
|
|
2061
|
+
Get counterparty entry information
|
|
2062
|
+
|
|
2063
|
+
This operation retrieves the detailed information about a specified counterparty entry.
|
|
1374
2064
|
|
|
1375
2065
|
### Example
|
|
1376
2066
|
|
|
@@ -1384,8 +2074,11 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1384
2074
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1385
2075
|
// Call the API
|
|
1386
2076
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1387
|
-
const
|
|
1388
|
-
|
|
2077
|
+
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
2078
|
+
const opts = {
|
|
2079
|
+
'entry_type': new CoboWaas2.EntryType()
|
|
2080
|
+
};
|
|
2081
|
+
apiInstance.getCounterpartyEntry(counterparty_entry_id, opts).then((data) => {
|
|
1389
2082
|
console.log('API called successfully. Returned data: ' + data);
|
|
1390
2083
|
}, (error) => {
|
|
1391
2084
|
console.error(error);
|
|
@@ -1398,11 +2091,12 @@ apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
|
1398
2091
|
|
|
1399
2092
|
Name | Type | Description | Notes
|
|
1400
2093
|
------------- | ------------- | ------------- | -------------
|
|
1401
|
-
**
|
|
2094
|
+
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
2095
|
+
**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]
|
|
1402
2096
|
|
|
1403
2097
|
### Return type
|
|
1404
2098
|
|
|
1405
|
-
[**
|
|
2099
|
+
[**GetCounterpartyEntry200Response**](GetCounterpartyEntry200Response.md)
|
|
1406
2100
|
|
|
1407
2101
|
### Authorization
|
|
1408
2102
|
|
|
@@ -1414,13 +2108,13 @@ Name | Type | Description | Notes
|
|
|
1414
2108
|
- **Accept**: application/json
|
|
1415
2109
|
|
|
1416
2110
|
|
|
1417
|
-
##
|
|
2111
|
+
## getDestination
|
|
1418
2112
|
|
|
1419
|
-
>
|
|
2113
|
+
> DestinationDetail getDestination(destination_id)
|
|
1420
2114
|
|
|
1421
|
-
Get
|
|
2115
|
+
Get destination information
|
|
1422
2116
|
|
|
1423
|
-
This operation retrieves the detailed information about a specified
|
|
2117
|
+
This operation retrieves the detailed information about a specified destination.
|
|
1424
2118
|
|
|
1425
2119
|
### Example
|
|
1426
2120
|
|
|
@@ -1434,8 +2128,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1434
2128
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1435
2129
|
// Call the API
|
|
1436
2130
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1437
|
-
const
|
|
1438
|
-
apiInstance.
|
|
2131
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
2132
|
+
apiInstance.getDestination(destination_id).then((data) => {
|
|
1439
2133
|
console.log('API called successfully. Returned data: ' + data);
|
|
1440
2134
|
}, (error) => {
|
|
1441
2135
|
console.error(error);
|
|
@@ -1448,11 +2142,11 @@ apiInstance.getCounterpartyDetailById(counterparty_id).then((data) => {
|
|
|
1448
2142
|
|
|
1449
2143
|
Name | Type | Description | Notes
|
|
1450
2144
|
------------- | ------------- | ------------- | -------------
|
|
1451
|
-
**
|
|
2145
|
+
**destination_id** | **String**| The destination ID. |
|
|
1452
2146
|
|
|
1453
2147
|
### Return type
|
|
1454
2148
|
|
|
1455
|
-
[**
|
|
2149
|
+
[**DestinationDetail**](DestinationDetail.md)
|
|
1456
2150
|
|
|
1457
2151
|
### Authorization
|
|
1458
2152
|
|
|
@@ -1518,7 +2212,7 @@ Name | Type | Description | Notes
|
|
|
1518
2212
|
|
|
1519
2213
|
> DestinationDetail getDestinationDetailById(destination_id)
|
|
1520
2214
|
|
|
1521
|
-
Get destination information
|
|
2215
|
+
Get destination information (Deprecated)
|
|
1522
2216
|
|
|
1523
2217
|
This operation retrieves the detailed information about a specified destination.
|
|
1524
2218
|
|
|
@@ -1564,6 +2258,58 @@ Name | Type | Description | Notes
|
|
|
1564
2258
|
- **Accept**: application/json
|
|
1565
2259
|
|
|
1566
2260
|
|
|
2261
|
+
## getDestinationEntry
|
|
2262
|
+
|
|
2263
|
+
> GetDestinationEntry200Response getDestinationEntry(destination_entry_id, entry_type)
|
|
2264
|
+
|
|
2265
|
+
Get destination entry information
|
|
2266
|
+
|
|
2267
|
+
This operation retrieves the detailed information about a specified destination entry.
|
|
2268
|
+
|
|
2269
|
+
### Example
|
|
2270
|
+
|
|
2271
|
+
```javascript
|
|
2272
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2273
|
+
// Initialize the API client
|
|
2274
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2275
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2276
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2277
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2278
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2279
|
+
// Call the API
|
|
2280
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2281
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
2282
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
2283
|
+
apiInstance.getDestinationEntry(destination_entry_id, entry_type).then((data) => {
|
|
2284
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2285
|
+
}, (error) => {
|
|
2286
|
+
console.error(error);
|
|
2287
|
+
});
|
|
2288
|
+
|
|
2289
|
+
```
|
|
2290
|
+
|
|
2291
|
+
### Parameters
|
|
2292
|
+
|
|
2293
|
+
|
|
2294
|
+
Name | Type | Description | Notes
|
|
2295
|
+
------------- | ------------- | ------------- | -------------
|
|
2296
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
2297
|
+
**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. |
|
|
2298
|
+
|
|
2299
|
+
### Return type
|
|
2300
|
+
|
|
2301
|
+
[**GetDestinationEntry200Response**](GetDestinationEntry200Response.md)
|
|
2302
|
+
|
|
2303
|
+
### Authorization
|
|
2304
|
+
|
|
2305
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2306
|
+
|
|
2307
|
+
### HTTP request headers
|
|
2308
|
+
|
|
2309
|
+
- **Content-Type**: Not defined
|
|
2310
|
+
- **Accept**: application/json
|
|
2311
|
+
|
|
2312
|
+
|
|
1567
2313
|
## getExchangeRate
|
|
1568
2314
|
|
|
1569
2315
|
> GetExchangeRate200Response getExchangeRate(token_id, currency)
|
|
@@ -1722,7 +2468,7 @@ Name | Type | Description | Notes
|
|
|
1722
2468
|
|
|
1723
2469
|
Get developer balance
|
|
1724
2470
|
|
|
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 [
|
|
2471
|
+
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
2472
|
|
|
1727
2473
|
### Example
|
|
1728
2474
|
|
|
@@ -1862,7 +2608,7 @@ Name | Type | Description | Notes
|
|
|
1862
2608
|
**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
2609
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1864
2610
|
**request_id** | **String**| The request ID. | [optional]
|
|
1865
|
-
**statuses** | **String**| A list of order, refund or
|
|
2611
|
+
**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
2612
|
|
|
1867
2613
|
### Return type
|
|
1868
2614
|
|
|
@@ -1878,13 +2624,73 @@ Name | Type | Description | Notes
|
|
|
1878
2624
|
- **Accept**: application/json
|
|
1879
2625
|
|
|
1880
2626
|
|
|
2627
|
+
## getReports
|
|
2628
|
+
|
|
2629
|
+
> GetReports200Response getReports(opts)
|
|
2630
|
+
|
|
2631
|
+
List all reports
|
|
2632
|
+
|
|
2633
|
+
This operation retrieves the information of all reports.
|
|
2634
|
+
|
|
2635
|
+
### Example
|
|
2636
|
+
|
|
2637
|
+
```javascript
|
|
2638
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2639
|
+
// Initialize the API client
|
|
2640
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2641
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2642
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2643
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2644
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2645
|
+
// Call the API
|
|
2646
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2647
|
+
const opts = {
|
|
2648
|
+
'limit': 10,
|
|
2649
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2650
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2651
|
+
'report_type': new CoboWaas2.ReportType(),
|
|
2652
|
+
'report_status': new CoboWaas2.ReportStatus()
|
|
2653
|
+
};
|
|
2654
|
+
apiInstance.getReports(opts).then((data) => {
|
|
2655
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2656
|
+
}, (error) => {
|
|
2657
|
+
console.error(error);
|
|
2658
|
+
});
|
|
2659
|
+
|
|
2660
|
+
```
|
|
2661
|
+
|
|
2662
|
+
### Parameters
|
|
2663
|
+
|
|
2664
|
+
|
|
2665
|
+
Name | Type | Description | Notes
|
|
2666
|
+
------------- | ------------- | ------------- | -------------
|
|
2667
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2668
|
+
**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]
|
|
2669
|
+
**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]
|
|
2670
|
+
**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]
|
|
2671
|
+
**report_status** | [**ReportStatus**](.md)| The status of the report. - `Completed`: The report has been generated successfully. - `Failed`: The report could not be generated. | [optional]
|
|
2672
|
+
|
|
2673
|
+
### Return type
|
|
2674
|
+
|
|
2675
|
+
[**GetReports200Response**](GetReports200Response.md)
|
|
2676
|
+
|
|
2677
|
+
### Authorization
|
|
2678
|
+
|
|
2679
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2680
|
+
|
|
2681
|
+
### HTTP request headers
|
|
2682
|
+
|
|
2683
|
+
- **Content-Type**: Not defined
|
|
2684
|
+
- **Accept**: application/json
|
|
2685
|
+
|
|
2686
|
+
|
|
1881
2687
|
## getSettlementById
|
|
1882
2688
|
|
|
1883
2689
|
> Settlement getSettlementById(settlement_request_id)
|
|
1884
2690
|
|
|
1885
2691
|
Get settlement request information
|
|
1886
2692
|
|
|
1887
|
-
This operation retrieves the information of a specific settlement request.
|
|
2693
|
+
<Note>This operation has been deprecated. Please use [Get payout information](https://www.cobo.com/payments/en/api-references/payment/get-payout-information) instead.</Note> This operation retrieves the information of a specific settlement request.
|
|
1888
2694
|
|
|
1889
2695
|
### Example
|
|
1890
2696
|
|
|
@@ -1968,7 +2774,7 @@ Name | Type | Description | Notes
|
|
|
1968
2774
|
------------- | ------------- | ------------- | -------------
|
|
1969
2775
|
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
1970
2776
|
**currency** | **String**| The currency for the operation. Currently, only `USD` is supported. | [optional] [default to 'USD']
|
|
1971
|
-
**acquiring_type** | [**AcquiringType**](.md)|
|
|
2777
|
+
**acquiring_type** | [**AcquiringType**](.md)| This parameter has been deprecated | [optional]
|
|
1972
2778
|
|
|
1973
2779
|
### Return type
|
|
1974
2780
|
|
|
@@ -2040,11 +2846,11 @@ Name | Type | Description | Notes
|
|
|
2040
2846
|
- **Accept**: application/json
|
|
2041
2847
|
|
|
2042
2848
|
|
|
2043
|
-
##
|
|
2849
|
+
## listAllocationItems
|
|
2044
2850
|
|
|
2045
|
-
>
|
|
2851
|
+
> ListAllocationItems200Response listAllocationItems(opts)
|
|
2046
2852
|
|
|
2047
|
-
List all
|
|
2853
|
+
List all allocation items
|
|
2048
2854
|
|
|
2049
2855
|
This operation retrieves the information of all allocations.
|
|
2050
2856
|
|
|
@@ -2069,7 +2875,7 @@ const opts = {
|
|
|
2069
2875
|
'token_id': "ETH_USDT",
|
|
2070
2876
|
'batch_allocation_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384"
|
|
2071
2877
|
};
|
|
2072
|
-
apiInstance.
|
|
2878
|
+
apiInstance.listAllocationItems(opts).then((data) => {
|
|
2073
2879
|
console.log('API called successfully. Returned data: ' + data);
|
|
2074
2880
|
}, (error) => {
|
|
2075
2881
|
console.error(error);
|
|
@@ -2085,14 +2891,14 @@ Name | Type | Description | Notes
|
|
|
2085
2891
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2086
2892
|
**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
2893
|
**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]
|
|
2894
|
+
**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]
|
|
2895
|
+
**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
2896
|
**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
2897
|
**batch_allocation_id** | **String**| The batch allocation ID. | [optional]
|
|
2092
2898
|
|
|
2093
2899
|
### Return type
|
|
2094
2900
|
|
|
2095
|
-
[**
|
|
2901
|
+
[**ListAllocationItems200Response**](ListAllocationItems200Response.md)
|
|
2096
2902
|
|
|
2097
2903
|
### Authorization
|
|
2098
2904
|
|
|
@@ -2110,7 +2916,7 @@ Name | Type | Description | Notes
|
|
|
2110
2916
|
|
|
2111
2917
|
List all bank accounts
|
|
2112
2918
|
|
|
2113
|
-
This operation
|
|
2919
|
+
<Note>This operation has been deprecated. Please use [List counterparty entries](https://www.cobo.com/payments/en/api-references/payment/list-counterparty-entries) instead.</Note> This operation retrieves the information of all bank accounts registered.
|
|
2114
2920
|
|
|
2115
2921
|
### Example
|
|
2116
2922
|
|
|
@@ -2208,6 +3014,64 @@ Name | Type | Description | Notes
|
|
|
2208
3014
|
- **Accept**: application/json
|
|
2209
3015
|
|
|
2210
3016
|
|
|
3017
|
+
## listBulkSendItems
|
|
3018
|
+
|
|
3019
|
+
> ListBulkSendItems200Response listBulkSendItems(bulk_send_id, opts)
|
|
3020
|
+
|
|
3021
|
+
List bulk send items
|
|
3022
|
+
|
|
3023
|
+
This operation retrieves the list of items for a specific bulk send.
|
|
3024
|
+
|
|
3025
|
+
### Example
|
|
3026
|
+
|
|
3027
|
+
```javascript
|
|
3028
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3029
|
+
// Initialize the API client
|
|
3030
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3031
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3032
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3033
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3034
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3035
|
+
// Call the API
|
|
3036
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3037
|
+
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
3038
|
+
const opts = {
|
|
3039
|
+
'limit': 10,
|
|
3040
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3041
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
3042
|
+
};
|
|
3043
|
+
apiInstance.listBulkSendItems(bulk_send_id, opts).then((data) => {
|
|
3044
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3045
|
+
}, (error) => {
|
|
3046
|
+
console.error(error);
|
|
3047
|
+
});
|
|
3048
|
+
|
|
3049
|
+
```
|
|
3050
|
+
|
|
3051
|
+
### Parameters
|
|
3052
|
+
|
|
3053
|
+
|
|
3054
|
+
Name | Type | Description | Notes
|
|
3055
|
+
------------- | ------------- | ------------- | -------------
|
|
3056
|
+
**bulk_send_id** | **String**| The bulk send ID. |
|
|
3057
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3058
|
+
**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]
|
|
3059
|
+
**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]
|
|
3060
|
+
|
|
3061
|
+
### Return type
|
|
3062
|
+
|
|
3063
|
+
[**ListBulkSendItems200Response**](ListBulkSendItems200Response.md)
|
|
3064
|
+
|
|
3065
|
+
### Authorization
|
|
3066
|
+
|
|
3067
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3068
|
+
|
|
3069
|
+
### HTTP request headers
|
|
3070
|
+
|
|
3071
|
+
- **Content-Type**: Not defined
|
|
3072
|
+
- **Accept**: application/json
|
|
3073
|
+
|
|
3074
|
+
|
|
2211
3075
|
## listCounterparties
|
|
2212
3076
|
|
|
2213
3077
|
> ListCounterparties200Response listCounterparties(opts)
|
|
@@ -2252,13 +3116,77 @@ Name | Type | Description | Notes
|
|
|
2252
3116
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2253
3117
|
**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
3118
|
**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
|
-
**keyword** | **String**| A search term
|
|
2256
|
-
**counterparty_type** | [**CounterpartyType**](.md)|
|
|
2257
|
-
**country** | **String**|
|
|
3119
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
3120
|
+
**counterparty_type** | [**CounterpartyType**](.md)| The type of the counterparty. - `Individual`: The counterparty is an individual. - `Organization`: The counterparty is an organization. | [optional]
|
|
3121
|
+
**country** | **String**| Country code, in ISO 3166-1 alpha-3 format. | [optional]
|
|
3122
|
+
|
|
3123
|
+
### Return type
|
|
3124
|
+
|
|
3125
|
+
[**ListCounterparties200Response**](ListCounterparties200Response.md)
|
|
3126
|
+
|
|
3127
|
+
### Authorization
|
|
3128
|
+
|
|
3129
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3130
|
+
|
|
3131
|
+
### HTTP request headers
|
|
3132
|
+
|
|
3133
|
+
- **Content-Type**: Not defined
|
|
3134
|
+
- **Accept**: application/json
|
|
3135
|
+
|
|
3136
|
+
|
|
3137
|
+
## listCounterpartyEntries
|
|
3138
|
+
|
|
3139
|
+
> ListCounterpartyEntries200Response listCounterpartyEntries(opts)
|
|
3140
|
+
|
|
3141
|
+
List counterparty entries
|
|
3142
|
+
|
|
3143
|
+
This operation retrieves the information of counterparty entries.
|
|
3144
|
+
|
|
3145
|
+
### Example
|
|
3146
|
+
|
|
3147
|
+
```javascript
|
|
3148
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3149
|
+
// Initialize the API client
|
|
3150
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3151
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3152
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3153
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3154
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3155
|
+
// Call the API
|
|
3156
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3157
|
+
const opts = {
|
|
3158
|
+
'limit': 10,
|
|
3159
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3160
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3161
|
+
'entry_type': new CoboWaas2.EntryType(),
|
|
3162
|
+
'counterparty_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384",
|
|
3163
|
+
'chain_ids': "ETH",
|
|
3164
|
+
'wallet_address': "0x1234567890abcdef..."
|
|
3165
|
+
};
|
|
3166
|
+
apiInstance.listCounterpartyEntries(opts).then((data) => {
|
|
3167
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3168
|
+
}, (error) => {
|
|
3169
|
+
console.error(error);
|
|
3170
|
+
});
|
|
3171
|
+
|
|
3172
|
+
```
|
|
3173
|
+
|
|
3174
|
+
### Parameters
|
|
3175
|
+
|
|
3176
|
+
|
|
3177
|
+
Name | Type | Description | Notes
|
|
3178
|
+
------------- | ------------- | ------------- | -------------
|
|
3179
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3180
|
+
**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]
|
|
3181
|
+
**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]
|
|
3182
|
+
**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]
|
|
3183
|
+
**counterparty_id** | **String**| The counterparty ID. | [optional]
|
|
3184
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3185
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
2258
3186
|
|
|
2259
3187
|
### Return type
|
|
2260
3188
|
|
|
2261
|
-
[**
|
|
3189
|
+
[**ListCounterpartyEntries200Response**](ListCounterpartyEntries200Response.md)
|
|
2262
3190
|
|
|
2263
3191
|
### Authorization
|
|
2264
3192
|
|
|
@@ -2428,7 +3356,7 @@ Name | Type | Description | Notes
|
|
|
2428
3356
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2429
3357
|
**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
3358
|
**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
|
|
3359
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2432
3360
|
**destination_id** | **String**| The destination ID. | [optional]
|
|
2433
3361
|
**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
3362
|
|
|
@@ -2446,6 +3374,74 @@ Name | Type | Description | Notes
|
|
|
2446
3374
|
- **Accept**: application/json
|
|
2447
3375
|
|
|
2448
3376
|
|
|
3377
|
+
## listDestinationEntries
|
|
3378
|
+
|
|
3379
|
+
> ListDestinationEntries200Response listDestinationEntries(entry_type, opts)
|
|
3380
|
+
|
|
3381
|
+
List destination entries
|
|
3382
|
+
|
|
3383
|
+
This operation retrieves the information of destination entries.
|
|
3384
|
+
|
|
3385
|
+
### Example
|
|
3386
|
+
|
|
3387
|
+
```javascript
|
|
3388
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3389
|
+
// Initialize the API client
|
|
3390
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3391
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3392
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3393
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3394
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3395
|
+
// Call the API
|
|
3396
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3397
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
3398
|
+
const opts = {
|
|
3399
|
+
'limit': 10,
|
|
3400
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3401
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3402
|
+
'destination_id': "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
|
|
3403
|
+
'chain_ids': "ETH",
|
|
3404
|
+
'wallet_address': "0x1234567890abcdef...",
|
|
3405
|
+
'keyword': "keyword",
|
|
3406
|
+
'bank_account_status': new CoboWaas2.BankAccountStatus()
|
|
3407
|
+
};
|
|
3408
|
+
apiInstance.listDestinationEntries(entry_type, opts).then((data) => {
|
|
3409
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3410
|
+
}, (error) => {
|
|
3411
|
+
console.error(error);
|
|
3412
|
+
});
|
|
3413
|
+
|
|
3414
|
+
```
|
|
3415
|
+
|
|
3416
|
+
### Parameters
|
|
3417
|
+
|
|
3418
|
+
|
|
3419
|
+
Name | Type | Description | Notes
|
|
3420
|
+
------------- | ------------- | ------------- | -------------
|
|
3421
|
+
**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. |
|
|
3422
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3423
|
+
**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]
|
|
3424
|
+
**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]
|
|
3425
|
+
**destination_id** | **String**| The destination ID. | [optional]
|
|
3426
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3427
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
3428
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
3429
|
+
**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]
|
|
3430
|
+
|
|
3431
|
+
### Return type
|
|
3432
|
+
|
|
3433
|
+
[**ListDestinationEntries200Response**](ListDestinationEntries200Response.md)
|
|
3434
|
+
|
|
3435
|
+
### Authorization
|
|
3436
|
+
|
|
3437
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3438
|
+
|
|
3439
|
+
### HTTP request headers
|
|
3440
|
+
|
|
3441
|
+
- **Content-Type**: Not defined
|
|
3442
|
+
- **Accept**: application/json
|
|
3443
|
+
|
|
3444
|
+
|
|
2449
3445
|
## listDestinationWalletAddresses
|
|
2450
3446
|
|
|
2451
3447
|
> ListDestinationWalletAddresses200Response listDestinationWalletAddresses(opts)
|
|
@@ -2553,9 +3549,9 @@ Name | Type | Description | Notes
|
|
|
2553
3549
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2554
3550
|
**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
3551
|
**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
|
|
3552
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2557
3553
|
**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**|
|
|
3554
|
+
**country** | **String**| Country code, in ISO 3166-1 alpha-3 format. | [optional]
|
|
2559
3555
|
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
2560
3556
|
|
|
2561
3557
|
### Return type
|
|
@@ -2636,7 +3632,7 @@ Name | Type | Description | Notes
|
|
|
2636
3632
|
|
|
2637
3633
|
List merchant balances
|
|
2638
3634
|
|
|
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 [
|
|
3635
|
+
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
3636
|
|
|
2641
3637
|
### Example
|
|
2642
3638
|
|
|
@@ -2670,7 +3666,7 @@ Name | Type | Description | Notes
|
|
|
2670
3666
|
------------- | ------------- | ------------- | -------------
|
|
2671
3667
|
**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` |
|
|
2672
3668
|
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
2673
|
-
**acquiring_type** | [**AcquiringType**](.md)|
|
|
3669
|
+
**acquiring_type** | [**AcquiringType**](.md)| This parameter has been deprecated | [optional]
|
|
2674
3670
|
|
|
2675
3671
|
### Return type
|
|
2676
3672
|
|
|
@@ -2730,7 +3726,7 @@ Name | Type | Description | Notes
|
|
|
2730
3726
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2731
3727
|
**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
3728
|
**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
|
|
3729
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2734
3730
|
**wallet_id** | **String**| This parameter has been deprecated. | [optional]
|
|
2735
3731
|
**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
3732
|
|
|
@@ -2794,7 +3790,7 @@ Name | Type | Description | Notes
|
|
|
2794
3790
|
**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
3791
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
2796
3792
|
**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
|
|
3793
|
+
**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
3794
|
|
|
2799
3795
|
### Return type
|
|
2800
3796
|
|
|
@@ -2910,66 +3906,6 @@ Name | Type | Description | Notes
|
|
|
2910
3906
|
- **Accept**: application/json
|
|
2911
3907
|
|
|
2912
3908
|
|
|
2913
|
-
## listPayoutItems
|
|
2914
|
-
|
|
2915
|
-
> ListPayoutItems200Response listPayoutItems(opts)
|
|
2916
|
-
|
|
2917
|
-
List all payout items
|
|
2918
|
-
|
|
2919
|
-
This operation retrieves the information of all payout items. You can filter the result by merchant ID or status.
|
|
2920
|
-
|
|
2921
|
-
### Example
|
|
2922
|
-
|
|
2923
|
-
```javascript
|
|
2924
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2925
|
-
// Initialize the API client
|
|
2926
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
2927
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2928
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2929
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2930
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2931
|
-
// Call the API
|
|
2932
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2933
|
-
const opts = {
|
|
2934
|
-
'limit': 10,
|
|
2935
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2936
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2937
|
-
'source_account': "source_account_example",
|
|
2938
|
-
'statuses': "Pending,Processing"
|
|
2939
|
-
};
|
|
2940
|
-
apiInstance.listPayoutItems(opts).then((data) => {
|
|
2941
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
2942
|
-
}, (error) => {
|
|
2943
|
-
console.error(error);
|
|
2944
|
-
});
|
|
2945
|
-
|
|
2946
|
-
```
|
|
2947
|
-
|
|
2948
|
-
### Parameters
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
Name | Type | Description | Notes
|
|
2952
|
-
------------- | ------------- | ------------- | -------------
|
|
2953
|
-
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2954
|
-
**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
|
-
**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 settlement 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 settlement details](https://www.cobo.com/payments/en/api-references/payment/list-all-settlement-details) | [optional]
|
|
2958
|
-
|
|
2959
|
-
### Return type
|
|
2960
|
-
|
|
2961
|
-
[**ListPayoutItems200Response**](ListPayoutItems200Response.md)
|
|
2962
|
-
|
|
2963
|
-
### Authorization
|
|
2964
|
-
|
|
2965
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2966
|
-
|
|
2967
|
-
### HTTP request headers
|
|
2968
|
-
|
|
2969
|
-
- **Content-Type**: Not defined
|
|
2970
|
-
- **Accept**: application/json
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
3909
|
## listPayouts
|
|
2974
3910
|
|
|
2975
3911
|
> ListPayouts200Response listPayouts(opts)
|
|
@@ -3034,7 +3970,7 @@ Name | Type | Description | Notes
|
|
|
3034
3970
|
|
|
3035
3971
|
List all settlement details
|
|
3036
3972
|
|
|
3037
|
-
This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status.
|
|
3973
|
+
<Note>This operation has been deprecated.</Note> This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status.
|
|
3038
3974
|
|
|
3039
3975
|
### Example
|
|
3040
3976
|
|
|
@@ -3072,7 +4008,7 @@ Name | Type | Description | Notes
|
|
|
3072
4008
|
**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
4009
|
**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
4010
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
3075
|
-
**statuses** | **String**| A list of order, refund or
|
|
4011
|
+
**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
4012
|
|
|
3077
4013
|
### Return type
|
|
3078
4014
|
|
|
@@ -3094,7 +4030,7 @@ Name | Type | Description | Notes
|
|
|
3094
4030
|
|
|
3095
4031
|
List all settlement requests
|
|
3096
4032
|
|
|
3097
|
-
This operation retrieves the information of all settlement requests.
|
|
4033
|
+
<Note>This operation has been deprecated. Please use [List all payouts](https://www.cobo.com/payments/en/api-references/payment/list-all-payouts) instead.</Note> This operation retrieves the information of all settlement requests.
|
|
3098
4034
|
|
|
3099
4035
|
### Example
|
|
3100
4036
|
|
|
@@ -3418,11 +4354,65 @@ Name | Type | Description | Notes
|
|
|
3418
4354
|
- **Accept**: application/json
|
|
3419
4355
|
|
|
3420
4356
|
|
|
4357
|
+
## updateCounterparty
|
|
4358
|
+
|
|
4359
|
+
> Counterparty updateCounterparty(counterparty_id, opts)
|
|
4360
|
+
|
|
4361
|
+
Update counterparty
|
|
4362
|
+
|
|
4363
|
+
This operation updates the information of a specified counterparty.
|
|
4364
|
+
|
|
4365
|
+
### Example
|
|
4366
|
+
|
|
4367
|
+
```javascript
|
|
4368
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4369
|
+
// Initialize the API client
|
|
4370
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
4371
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4372
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4373
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4374
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4375
|
+
// Call the API
|
|
4376
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4377
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
4378
|
+
const opts = {
|
|
4379
|
+
'UpdateCounterpartyRequest': new CoboWaas2.UpdateCounterpartyRequest()
|
|
4380
|
+
};
|
|
4381
|
+
apiInstance.updateCounterparty(counterparty_id, opts).then((data) => {
|
|
4382
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
4383
|
+
}, (error) => {
|
|
4384
|
+
console.error(error);
|
|
4385
|
+
});
|
|
4386
|
+
|
|
4387
|
+
```
|
|
4388
|
+
|
|
4389
|
+
### Parameters
|
|
4390
|
+
|
|
4391
|
+
|
|
4392
|
+
Name | Type | Description | Notes
|
|
4393
|
+
------------- | ------------- | ------------- | -------------
|
|
4394
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
4395
|
+
**UpdateCounterpartyRequest** | [**UpdateCounterpartyRequest**](UpdateCounterpartyRequest.md)| The request body to update a counterparty. | [optional]
|
|
4396
|
+
|
|
4397
|
+
### Return type
|
|
4398
|
+
|
|
4399
|
+
[**Counterparty**](Counterparty.md)
|
|
4400
|
+
|
|
4401
|
+
### Authorization
|
|
4402
|
+
|
|
4403
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4404
|
+
|
|
4405
|
+
### HTTP request headers
|
|
4406
|
+
|
|
4407
|
+
- **Content-Type**: application/json
|
|
4408
|
+
- **Accept**: application/json
|
|
4409
|
+
|
|
4410
|
+
|
|
3421
4411
|
## updateCounterpartyById
|
|
3422
4412
|
|
|
3423
4413
|
> Counterparty updateCounterpartyById(counterparty_id, opts)
|
|
3424
4414
|
|
|
3425
|
-
Update counterparty
|
|
4415
|
+
Update counterparty (Deprecated)
|
|
3426
4416
|
|
|
3427
4417
|
This operation updates the information of a specified counterparty.
|
|
3428
4418
|
|
|
@@ -3472,6 +4462,60 @@ Name | Type | Description | Notes
|
|
|
3472
4462
|
- **Accept**: application/json
|
|
3473
4463
|
|
|
3474
4464
|
|
|
4465
|
+
## updateDestination
|
|
4466
|
+
|
|
4467
|
+
> Destination updateDestination(destination_id, opts)
|
|
4468
|
+
|
|
4469
|
+
Update destination
|
|
4470
|
+
|
|
4471
|
+
This operation updates the information of a specified destination.
|
|
4472
|
+
|
|
4473
|
+
### Example
|
|
4474
|
+
|
|
4475
|
+
```javascript
|
|
4476
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4477
|
+
// Initialize the API client
|
|
4478
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
4479
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4480
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4481
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4482
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4483
|
+
// Call the API
|
|
4484
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4485
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
4486
|
+
const opts = {
|
|
4487
|
+
'UpdateDestinationRequest': new CoboWaas2.UpdateDestinationRequest()
|
|
4488
|
+
};
|
|
4489
|
+
apiInstance.updateDestination(destination_id, opts).then((data) => {
|
|
4490
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
4491
|
+
}, (error) => {
|
|
4492
|
+
console.error(error);
|
|
4493
|
+
});
|
|
4494
|
+
|
|
4495
|
+
```
|
|
4496
|
+
|
|
4497
|
+
### Parameters
|
|
4498
|
+
|
|
4499
|
+
|
|
4500
|
+
Name | Type | Description | Notes
|
|
4501
|
+
------------- | ------------- | ------------- | -------------
|
|
4502
|
+
**destination_id** | **String**| The destination ID. |
|
|
4503
|
+
**UpdateDestinationRequest** | [**UpdateDestinationRequest**](UpdateDestinationRequest.md)| The request body to update a destination. | [optional]
|
|
4504
|
+
|
|
4505
|
+
### Return type
|
|
4506
|
+
|
|
4507
|
+
[**Destination**](Destination.md)
|
|
4508
|
+
|
|
4509
|
+
### Authorization
|
|
4510
|
+
|
|
4511
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4512
|
+
|
|
4513
|
+
### HTTP request headers
|
|
4514
|
+
|
|
4515
|
+
- **Content-Type**: application/json
|
|
4516
|
+
- **Accept**: application/json
|
|
4517
|
+
|
|
4518
|
+
|
|
3475
4519
|
## updateDestinationBankAccountById
|
|
3476
4520
|
|
|
3477
4521
|
> DestinationBankAccount updateDestinationBankAccountById(bank_account_id, opts)
|
|
@@ -3530,7 +4574,7 @@ Name | Type | Description | Notes
|
|
|
3530
4574
|
|
|
3531
4575
|
> Destination updateDestinationById(destination_id, opts)
|
|
3532
4576
|
|
|
3533
|
-
Update destination
|
|
4577
|
+
Update destination (Deprecated)
|
|
3534
4578
|
|
|
3535
4579
|
This operation updates the information of a specified destination.
|
|
3536
4580
|
|
|
@@ -3564,7 +4608,7 @@ apiInstance.updateDestinationById(destination_id, opts).then((data) => {
|
|
|
3564
4608
|
Name | Type | Description | Notes
|
|
3565
4609
|
------------- | ------------- | ------------- | -------------
|
|
3566
4610
|
**destination_id** | **String**| The destination ID. |
|
|
3567
|
-
**UpdateDestinationByIdRequest** | [**UpdateDestinationByIdRequest**](UpdateDestinationByIdRequest.md)| The request body to
|
|
4611
|
+
**UpdateDestinationByIdRequest** | [**UpdateDestinationByIdRequest**](UpdateDestinationByIdRequest.md)| The request body to update a destination. | [optional]
|
|
3568
4612
|
|
|
3569
4613
|
### Return type
|
|
3570
4614
|
|
|
@@ -3580,6 +4624,60 @@ Name | Type | Description | Notes
|
|
|
3580
4624
|
- **Accept**: application/json
|
|
3581
4625
|
|
|
3582
4626
|
|
|
4627
|
+
## updateDestinationEntry
|
|
4628
|
+
|
|
4629
|
+
> UpdateDestinationEntry200Response updateDestinationEntry(destination_entry_id, opts)
|
|
4630
|
+
|
|
4631
|
+
Update destination entry
|
|
4632
|
+
|
|
4633
|
+
This operation updates the information of a specified destination entry.
|
|
4634
|
+
|
|
4635
|
+
### Example
|
|
4636
|
+
|
|
4637
|
+
```javascript
|
|
4638
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4639
|
+
// Initialize the API client
|
|
4640
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
4641
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4642
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4643
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4644
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4645
|
+
// Call the API
|
|
4646
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4647
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
4648
|
+
const opts = {
|
|
4649
|
+
'UpdateDestinationEntryRequest': new CoboWaas2.UpdateDestinationEntryRequest()
|
|
4650
|
+
};
|
|
4651
|
+
apiInstance.updateDestinationEntry(destination_entry_id, opts).then((data) => {
|
|
4652
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
4653
|
+
}, (error) => {
|
|
4654
|
+
console.error(error);
|
|
4655
|
+
});
|
|
4656
|
+
|
|
4657
|
+
```
|
|
4658
|
+
|
|
4659
|
+
### Parameters
|
|
4660
|
+
|
|
4661
|
+
|
|
4662
|
+
Name | Type | Description | Notes
|
|
4663
|
+
------------- | ------------- | ------------- | -------------
|
|
4664
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
4665
|
+
**UpdateDestinationEntryRequest** | [**UpdateDestinationEntryRequest**](UpdateDestinationEntryRequest.md)| The request body to update a destination entry. | [optional]
|
|
4666
|
+
|
|
4667
|
+
### Return type
|
|
4668
|
+
|
|
4669
|
+
[**UpdateDestinationEntry200Response**](UpdateDestinationEntry200Response.md)
|
|
4670
|
+
|
|
4671
|
+
### Authorization
|
|
4672
|
+
|
|
4673
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4674
|
+
|
|
4675
|
+
### HTTP request headers
|
|
4676
|
+
|
|
4677
|
+
- **Content-Type**: application/json
|
|
4678
|
+
- **Accept**: application/json
|
|
4679
|
+
|
|
4680
|
+
|
|
3583
4681
|
## updateMerchantById
|
|
3584
4682
|
|
|
3585
4683
|
> Merchant updateMerchantById(merchant_id, opts)
|