@cobo/cobo-waas2 1.26.0 → 1.28.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 +96 -4
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +2 -2
- package/dist/api/AutoSweepApi.js +4 -4
- package/dist/api/DevelopersWebhooksApi.js +2 -2
- package/dist/api/OAuthApi.js +4 -4
- package/dist/api/PaymentApi.js +1847 -294
- package/dist/api/StakingsApi.js +44 -2
- package/dist/api/SwapsApi.js +2 -2
- package/dist/api/TransactionsApi.js +6 -6
- package/dist/api/WalletsApi.js +14 -14
- package/dist/index.js +420 -7
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/AllocationRecord.js +193 -0
- package/dist/model/AllocationRequest.js +167 -0
- package/dist/model/BabylonCreateStakingExpansion.js +157 -0
- package/dist/model/BabylonStakeExtra.js +26 -0
- package/dist/model/BabylonStakingRegistration.js +1 -1
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/BankAccountStatus.js +66 -0
- package/dist/model/BatchAllocation.js +190 -0
- package/dist/model/BatchAllocationDetail.js +188 -0
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +8 -3
- package/dist/model/ContractCallDestination.js +72 -10
- package/dist/model/ContractCallDestinationType.js +10 -0
- package/dist/model/CosmosContractCallDestination.js +0 -13
- package/dist/model/Counterparty.js +195 -0
- package/dist/model/CounterpartyDetail.js +228 -0
- package/dist/model/CounterpartyType.js +61 -0
- package/dist/model/CounterpartyWalletAddressDetail.js +192 -0
- package/dist/model/CreateBatchAllocationRequest.js +142 -0
- package/dist/model/CreateCounterpartyRequest.js +193 -0
- package/dist/model/CreateCounterpartyWalletAddressRequest.js +140 -0
- package/dist/model/CreateCustodialWalletParams.js +1 -1
- package/dist/model/CreateDestinationBankAccount.js +257 -0
- package/dist/model/CreateDestinationBankAccountRequest.js +272 -0
- package/dist/model/CreateDestinationRequest.js +235 -0
- package/dist/model/CreateDestinationWalletAddressRequest.js +140 -0
- package/dist/model/CreateExchangeWalletParams.js +2 -2
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreateMerchantRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreatePaymentOrderRequest.js +115 -68
- package/dist/model/CreatePayoutRequest.js +192 -0
- package/dist/model/CreateRefundRequest.js +3 -3
- package/dist/model/CreateSafeWalletParams.js +1 -1
- package/dist/model/CreateSettlement.js +14 -1
- package/dist/model/CreateSettlementRequestRequest.js +1 -1
- package/dist/model/CreateSmartContractWalletParams.js +1 -1
- package/dist/model/CreateStakeActivityExtra.js +12 -0
- package/dist/model/{ReceivedAmountPerAddress.js → CreateWalletAddress.js} +31 -32
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/DeleteCounterparty200Response.js +110 -0
- package/dist/model/DeleteCounterpartyWalletAddress200Response.js +110 -0
- package/dist/model/DeleteDestination200Response.js +110 -0
- package/dist/model/DeleteDestinationBankAccount200Response.js +110 -0
- package/dist/model/DeleteDestinationWalletAddress200Response.js +110 -0
- package/dist/model/Destination.js +208 -0
- package/dist/model/DestinationBankAccount.js +301 -0
- package/dist/model/DestinationBankAccountDetail.js +394 -0
- package/dist/model/DestinationDetail.js +272 -0
- package/dist/model/DestinationType.js +61 -0
- package/dist/model/DestinationWalletAddressDetail.js +205 -0
- package/dist/model/EnableDestinationWhitelistRequest.js +106 -0
- package/dist/model/EvmContractCallDestination.js +2 -2
- package/dist/model/ExchangeRate.js +140 -0
- package/dist/model/GetExchangeRate200Response.js +2 -2
- package/dist/model/IntermediaryBankInfo.js +140 -0
- package/dist/model/Link.js +4 -4
- package/dist/model/LinkDisplayInfo.js +15 -2
- package/dist/model/ListAllocations200Response.js +123 -0
- package/dist/model/ListBatchAllocations200Response.js +123 -0
- package/dist/model/ListCounterparties200Response.js +123 -0
- package/dist/model/ListCounterpartyWalletAddress200Response.js +123 -0
- package/dist/model/ListDestinationBankAccounts200Response.js +123 -0
- package/dist/model/ListDestinationWalletAddresses200Response.js +123 -0
- package/dist/model/ListDestinations200Response.js +123 -0
- package/dist/model/ListPayoutItems200Response.js +123 -0
- package/dist/model/ListPayouts200Response.js +123 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/MerchantBalance.js +28 -2
- package/dist/model/Order.js +135 -102
- package/dist/model/OrderLinkBusinessInfo.js +151 -87
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +4 -4
- package/dist/model/OrderLinkBusinessInfoPayableAmountsInner.js +125 -0
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentAllocationAmount.js +125 -0
- package/dist/model/PaymentOrderEventData.js +198 -145
- package/dist/model/PaymentPayout.js +250 -0
- package/dist/model/PaymentPayoutDetail.js +248 -0
- package/dist/model/PaymentPayoutEvent.js +433 -0
- package/dist/model/PaymentPayoutItem.js +298 -0
- package/dist/model/PaymentPayoutItemDetail.js +298 -0
- package/dist/model/PaymentPayoutItemStatus.js +76 -0
- package/dist/model/PaymentPayoutParam.js +165 -0
- package/dist/model/PaymentPayoutStatus.js +81 -0
- package/dist/model/PaymentRefundEventData.js +8 -3
- package/dist/model/PaymentSettlementEvent.js +8 -3
- package/dist/model/PaymentSourceType.js +61 -0
- package/dist/model/PaymentTransaction.js +32 -0
- package/dist/model/PaymentTransactionEventData.js +10 -5
- package/dist/model/PspBalance.js +28 -2
- package/dist/model/QueryDestinationWhitelistEnabled200Response.js +106 -0
- package/dist/model/RefundLinkBusinessInfo.js +6 -6
- package/dist/model/SettlementDetail.js +13 -0
- package/dist/model/Stakings.js +33 -6
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/SwapActivity.js +1 -1
- package/dist/model/SwapActivityDetail.js +2 -2
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/Transaction.js +1 -1
- package/dist/model/TransactionCosmosContractDestination.js +0 -13
- package/dist/model/TransactionDestination.js +38 -10
- package/dist/model/TransactionDestinationType.js +5 -0
- package/dist/model/TransactionDetail.js +2 -2
- package/dist/model/TransactionDetails.js +2 -2
- package/dist/model/TransactionTronContractDestination.js +150 -0
- package/dist/model/TransactionWebhookEventData.js +10 -5
- package/dist/model/TronContractCallDestination.js +150 -0
- package/dist/model/UpdateCounterpartyByIdRequest.js +160 -0
- package/dist/model/UpdateDestinationBankAccount.js +257 -0
- package/dist/model/UpdateDestinationByIdRequest.js +173 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/WalletAddress.js +151 -0
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEventData.js +107 -43
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +10 -0
- package/docs/AddressBooksApi.md +1 -1
- package/docs/AddressesEventData.md +3 -1
- package/docs/AllocationRecord.md +15 -0
- package/docs/AllocationRequest.md +13 -0
- package/docs/AutoSweepApi.md +2 -2
- package/docs/BabylonCreateStakingExpansion.md +12 -0
- package/docs/BabylonStakeExtra.md +2 -0
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/BankAccountStatus.md +14 -0
- package/docs/BatchAllocation.md +14 -0
- package/docs/BatchAllocationDetail.md +14 -0
- package/docs/ChainsEventData.md +3 -1
- package/docs/ComplianceDispositionUpdateEventData.md +3 -1
- package/docs/ComplianceKytScreeningsUpdateEventData.md +3 -1
- package/docs/ContractCallDestination.md +3 -2
- package/docs/ContractCallDestinationType.md +4 -0
- package/docs/CosmosContractCallDestination.md +0 -1
- package/docs/Counterparty.md +16 -0
- package/docs/CounterpartyDetail.md +17 -0
- package/docs/CounterpartyType.md +12 -0
- package/docs/CounterpartyWalletAddressDetail.md +15 -0
- package/docs/CreateBatchAllocationRequest.md +10 -0
- package/docs/CreateCounterpartyRequest.md +14 -0
- package/docs/CreateCounterpartyWalletAddressRequest.md +11 -0
- package/docs/CreateCustodialWalletParams.md +1 -1
- package/docs/CreateDestinationBankAccount.md +19 -0
- package/docs/CreateDestinationBankAccountRequest.md +20 -0
- package/docs/CreateDestinationRequest.md +16 -0
- package/docs/CreateDestinationWalletAddressRequest.md +11 -0
- package/docs/CreateExchangeWalletParams.md +1 -1
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMerchantRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +15 -11
- package/docs/CreatePayoutRequest.md +14 -0
- package/docs/CreateRefundRequest.md +3 -3
- package/docs/CreateSafeWalletParams.md +1 -1
- package/docs/CreateSettlement.md +2 -1
- package/docs/CreateSettlementRequestRequest.md +1 -1
- package/docs/CreateSmartContractWalletParams.md +1 -1
- package/docs/CreateStakeActivityExtra.md +2 -0
- package/docs/CreateWalletAddress.md +10 -0
- package/docs/CreateWalletParams.md +1 -1
- package/docs/DeleteCounterparty200Response.md +9 -0
- package/docs/DeleteCounterpartyWalletAddress200Response.md +9 -0
- package/docs/DeleteDestination200Response.md +9 -0
- package/docs/DeleteDestinationBankAccount200Response.md +9 -0
- package/docs/DeleteDestinationWalletAddress200Response.md +9 -0
- package/docs/Destination.md +17 -0
- package/docs/DestinationBankAccount.md +23 -0
- package/docs/DestinationBankAccountDetail.md +30 -0
- package/docs/DestinationDetail.md +19 -0
- package/docs/DestinationType.md +12 -0
- package/docs/DestinationWalletAddressDetail.md +16 -0
- package/docs/DevelopersWebhooksApi.md +1 -1
- package/docs/EnableDestinationWhitelistRequest.md +9 -0
- package/docs/EvmContractCallDestination.md +1 -1
- package/docs/ExchangeRate.md +11 -0
- package/docs/GetExchangeRate200Response.md +1 -1
- package/docs/IntermediaryBankInfo.md +11 -0
- package/docs/Link.md +2 -2
- package/docs/LinkDisplayInfo.md +3 -2
- package/docs/ListAllocations200Response.md +10 -0
- package/docs/ListBatchAllocations200Response.md +10 -0
- package/docs/ListCounterparties200Response.md +10 -0
- package/docs/ListCounterpartyWalletAddress200Response.md +10 -0
- package/docs/ListDestinationBankAccounts200Response.md +10 -0
- package/docs/ListDestinationWalletAddresses200Response.md +10 -0
- package/docs/ListDestinations200Response.md +10 -0
- package/docs/ListPayoutItems200Response.md +10 -0
- package/docs/ListPayouts200Response.md +10 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/MerchantBalance.md +4 -2
- package/docs/OAuthApi.md +2 -2
- package/docs/Order.md +16 -13
- package/docs/OrderLinkBusinessInfo.md +11 -7
- package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +2 -2
- package/docs/OrderLinkBusinessInfoPayableAmountsInner.md +10 -0
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentAllocationAmount.md +10 -0
- package/docs/PaymentApi.md +2153 -395
- package/docs/PaymentOrderEventData.md +19 -14
- package/docs/PaymentPayout.md +19 -0
- package/docs/PaymentPayoutDetail.md +19 -0
- package/docs/PaymentPayoutEvent.md +65 -0
- package/docs/PaymentPayoutItem.md +22 -0
- package/docs/PaymentPayoutItemDetail.md +22 -0
- package/docs/PaymentPayoutItemStatus.md +18 -0
- package/docs/PaymentPayoutParam.md +13 -0
- package/docs/PaymentPayoutStatus.md +20 -0
- package/docs/PaymentRefundEventData.md +3 -1
- package/docs/PaymentSettlementEvent.md +3 -1
- package/docs/PaymentSourceType.md +12 -0
- package/docs/PaymentTransaction.md +2 -0
- package/docs/PaymentTransactionEventData.md +4 -2
- package/docs/PspBalance.md +4 -2
- package/docs/QueryDestinationWhitelistEnabled200Response.md +9 -0
- package/docs/RefundLinkBusinessInfo.md +4 -4
- package/docs/SettlementDetail.md +1 -0
- package/docs/Stakings.md +2 -1
- package/docs/StakingsApi.md +54 -1
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/SwapActivity.md +1 -1
- package/docs/SwapActivityDetail.md +1 -1
- package/docs/SwapsApi.md +1 -1
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokensEventData.md +3 -1
- package/docs/Transaction.md +1 -1
- package/docs/TransactionCosmosContractDestination.md +0 -1
- package/docs/TransactionDestination.md +2 -2
- package/docs/TransactionDestinationType.md +2 -0
- package/docs/TransactionDetail.md +1 -1
- package/docs/TransactionDetails.md +1 -1
- package/docs/TransactionTronContractDestination.md +12 -0
- package/docs/TransactionWebhookEventData.md +4 -2
- package/docs/TransactionsApi.md +3 -3
- package/docs/TronContractCallDestination.md +12 -0
- package/docs/UpdateCounterpartyByIdRequest.md +13 -0
- package/docs/UpdateDestinationBankAccount.md +19 -0
- package/docs/UpdateDestinationByIdRequest.md +14 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/WalletAddress.md +12 -0
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletsApi.md +7 -7
- package/docs/WebhookEventData.md +22 -14
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +4 -0
- package/package.json +1 -1
- package/docs/ReceivedAmountPerAddress.md +0 -10
package/docs/PaymentApi.md
CHANGED
|
@@ -4,39 +4,71 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**batchGetExchangeRates**](PaymentApi.md#batchGetExchangeRates) | **GET** /payments/exchange_rates | Batch get exchange rates
|
|
7
8
|
[**cancelRefundById**](PaymentApi.md#cancelRefundById) | **PUT** /payments/refunds/{refund_id}/cancel | Cancel refund order
|
|
9
|
+
[**createBatchAllocation**](PaymentApi.md#createBatchAllocation) | **POST** /payments/batch_allocations | Create batch allocation
|
|
10
|
+
[**createCounterparty**](PaymentApi.md#createCounterparty) | **POST** /payments/counterparty | Create counterparty
|
|
11
|
+
[**createCounterpartyWalletAddress**](PaymentApi.md#createCounterpartyWalletAddress) | **POST** /payments/counterparty/wallet_address | Create counterparty wallet address
|
|
8
12
|
[**createCryptoAddress**](PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
|
|
13
|
+
[**createDestination**](PaymentApi.md#createDestination) | **POST** /payments/destination | Create destination
|
|
14
|
+
[**createDestinationBankAccount**](PaymentApi.md#createDestinationBankAccount) | **POST** /payments/destination/bank_account | Create destination bank account
|
|
15
|
+
[**createDestinationWalletAddress**](PaymentApi.md#createDestinationWalletAddress) | **POST** /payments/destination/wallet_address | Create destination wallet address
|
|
9
16
|
[**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
|
|
10
17
|
[**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
11
18
|
[**createOrderLink**](PaymentApi.md#createOrderLink) | **POST** /payments/links/orders | Create order link
|
|
12
19
|
[**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
|
|
20
|
+
[**createPayout**](PaymentApi.md#createPayout) | **POST** /payments/payouts | Create payout
|
|
13
21
|
[**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
|
|
14
22
|
[**createRefundLink**](PaymentApi.md#createRefundLink) | **POST** /payments/links/refunds | Create refund link
|
|
15
23
|
[**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
|
|
24
|
+
[**deleteCounterparty**](PaymentApi.md#deleteCounterparty) | **PUT** /payments/counterparty/{counterparty_id}/delete | Delete counterparty
|
|
25
|
+
[**deleteCounterpartyWalletAddress**](PaymentApi.md#deleteCounterpartyWalletAddress) | **PUT** /payments/counterparty/wallet_address/{wallet_address_id}/delete | Delete counterparty wallet address
|
|
16
26
|
[**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
|
|
28
|
+
[**deleteDestinationBankAccount**](PaymentApi.md#deleteDestinationBankAccount) | **PUT** /payments/destination/bank_account/{bank_account_id}/delete | Delete destination bank account
|
|
29
|
+
[**deleteDestinationWalletAddress**](PaymentApi.md#deleteDestinationWalletAddress) | **PUT** /payments/destination/wallet_address/{wallet_address_id}/delete | Delete destination wallet address
|
|
30
|
+
[**enableDestinationWhitelist**](PaymentApi.md#enableDestinationWhitelist) | **POST** /payments/destination/enable_whitelist | Enable or disable destination whitelist
|
|
31
|
+
[**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 by id
|
|
33
|
+
[**getCounterpartyDetailById**](PaymentApi.md#getCounterpartyDetailById) | **GET** /payments/counterparty/{counterparty_id}/detail | Get counterparty information
|
|
34
|
+
[**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
|
|
17
36
|
[**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
|
|
18
|
-
[**getPayerBalanceByAddress**](PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance
|
|
19
37
|
[**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
|
|
38
|
+
[**getPayoutById**](PaymentApi.md#getPayoutById) | **GET** /payments/payouts/{payout_id} | Get payout information
|
|
20
39
|
[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get developer balance
|
|
21
40
|
[**getRefundDetailById**](PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
|
|
22
41
|
[**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
|
|
23
42
|
[**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
|
|
24
43
|
[**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
|
|
25
|
-
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Get top-up address
|
|
44
|
+
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Create/Get top-up address
|
|
45
|
+
[**listAllocations**](PaymentApi.md#listAllocations) | **GET** /payments/allocation_records | List all allocations
|
|
26
46
|
[**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
|
|
47
|
+
[**listBatchAllocations**](PaymentApi.md#listBatchAllocations) | **GET** /payments/batch_allocations | List all batch allocations
|
|
48
|
+
[**listCounterparties**](PaymentApi.md#listCounterparties) | **GET** /payments/counterparty | List all counterparties
|
|
49
|
+
[**listCounterpartyWalletAddress**](PaymentApi.md#listCounterpartyWalletAddress) | **GET** /payments/counterparty/wallet_address | List counterparty wallet addresses
|
|
27
50
|
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
51
|
+
[**listDestinationBankAccounts**](PaymentApi.md#listDestinationBankAccounts) | **GET** /payments/destination/bank_account | List destination bank accounts
|
|
52
|
+
[**listDestinationWalletAddresses**](PaymentApi.md#listDestinationWalletAddresses) | **GET** /payments/destination/wallet_address | List destination wallet addresses
|
|
53
|
+
[**listDestinations**](PaymentApi.md#listDestinations) | **GET** /payments/destination | List all destinations
|
|
28
54
|
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List forced sweeps
|
|
29
55
|
[**listMerchantBalances**](PaymentApi.md#listMerchantBalances) | **GET** /payments/balance/merchants | List merchant balances
|
|
30
56
|
[**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
|
|
31
57
|
[**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
|
|
32
58
|
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List all supported tokens
|
|
33
59
|
[**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
|
+
[**listPayouts**](PaymentApi.md#listPayouts) | **GET** /payments/payouts | List all payouts
|
|
34
62
|
[**listSettlementDetails**](PaymentApi.md#listSettlementDetails) | **GET** /payments/settlement_details | List all settlement details
|
|
35
63
|
[**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
|
|
36
64
|
[**listTopUpPayerAccounts**](PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
|
|
37
65
|
[**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
|
|
38
66
|
[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
|
|
67
|
+
[**queryDestinationWhitelistEnabled**](PaymentApi.md#queryDestinationWhitelistEnabled) | **GET** /payments/destination/enable_whitelist | Query destination whitelist enabled status
|
|
39
68
|
[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
69
|
+
[**updateCounterpartyById**](PaymentApi.md#updateCounterpartyById) | **PUT** /payments/counterparty/{counterparty_id}/update | Update counterparty
|
|
70
|
+
[**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
|
|
40
72
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
41
73
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
42
74
|
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
|
|
@@ -44,13 +76,13 @@ Method | HTTP request | Description
|
|
|
44
76
|
|
|
45
77
|
|
|
46
78
|
|
|
47
|
-
##
|
|
79
|
+
## batchGetExchangeRates
|
|
48
80
|
|
|
49
|
-
>
|
|
81
|
+
> [ExchangeRate] batchGetExchangeRates(token_ids, currencies)
|
|
50
82
|
|
|
51
|
-
|
|
83
|
+
Batch get exchange rates
|
|
52
84
|
|
|
53
|
-
This operation
|
|
85
|
+
This operation retrieves the current exchange rates between multiple fiat currencies and cryptocurrencies.
|
|
54
86
|
|
|
55
87
|
### Example
|
|
56
88
|
|
|
@@ -64,8 +96,9 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
64
96
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
65
97
|
// Call the API
|
|
66
98
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
67
|
-
const
|
|
68
|
-
|
|
99
|
+
const token_ids = "ETH_USDT,ETH_USDC,BTC_USDT";
|
|
100
|
+
const currencies = "USD";
|
|
101
|
+
apiInstance.batchGetExchangeRates(token_ids, currencies).then((data) => {
|
|
69
102
|
console.log('API called successfully. Returned data: ' + data);
|
|
70
103
|
}, (error) => {
|
|
71
104
|
console.error(error);
|
|
@@ -78,15 +111,16 @@ apiInstance.cancelRefundById(refund_id).then((data) => {
|
|
|
78
111
|
|
|
79
112
|
Name | Type | Description | Notes
|
|
80
113
|
------------- | ------------- | ------------- | -------------
|
|
81
|
-
**
|
|
114
|
+
**token_ids** | **String**| A list of token IDs, separated by comma. 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` |
|
|
115
|
+
**currencies** | **String**| A list of fiat currencies, separated by comma. Currently, only `USD` is supported. |
|
|
82
116
|
|
|
83
117
|
### Return type
|
|
84
118
|
|
|
85
|
-
[**
|
|
119
|
+
[**[ExchangeRate]**](ExchangeRate.md)
|
|
86
120
|
|
|
87
121
|
### Authorization
|
|
88
122
|
|
|
89
|
-
[
|
|
123
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
90
124
|
|
|
91
125
|
### HTTP request headers
|
|
92
126
|
|
|
@@ -94,13 +128,13 @@ Name | Type | Description | Notes
|
|
|
94
128
|
- **Accept**: application/json
|
|
95
129
|
|
|
96
130
|
|
|
97
|
-
##
|
|
131
|
+
## cancelRefundById
|
|
98
132
|
|
|
99
|
-
>
|
|
133
|
+
> Refund cancelRefundById(refund_id)
|
|
100
134
|
|
|
101
|
-
|
|
135
|
+
Cancel refund order
|
|
102
136
|
|
|
103
|
-
This operation
|
|
137
|
+
This operation cancels a specified refund order. You can only cancel refund orders that have not been processed yet.
|
|
104
138
|
|
|
105
139
|
### Example
|
|
106
140
|
|
|
@@ -114,10 +148,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
114
148
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
115
149
|
// Call the API
|
|
116
150
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
117
|
-
const
|
|
118
|
-
|
|
119
|
-
};
|
|
120
|
-
apiInstance.createCryptoAddress(opts).then((data) => {
|
|
151
|
+
const refund_id = "R20250304-M1001-1001";
|
|
152
|
+
apiInstance.cancelRefundById(refund_id).then((data) => {
|
|
121
153
|
console.log('API called successfully. Returned data: ' + data);
|
|
122
154
|
}, (error) => {
|
|
123
155
|
console.error(error);
|
|
@@ -130,11 +162,11 @@ apiInstance.createCryptoAddress(opts).then((data) => {
|
|
|
130
162
|
|
|
131
163
|
Name | Type | Description | Notes
|
|
132
164
|
------------- | ------------- | ------------- | -------------
|
|
133
|
-
**
|
|
165
|
+
**refund_id** | **String**| The refund order ID. |
|
|
134
166
|
|
|
135
167
|
### Return type
|
|
136
168
|
|
|
137
|
-
[**
|
|
169
|
+
[**Refund**](Refund.md)
|
|
138
170
|
|
|
139
171
|
### Authorization
|
|
140
172
|
|
|
@@ -142,17 +174,17 @@ Name | Type | Description | Notes
|
|
|
142
174
|
|
|
143
175
|
### HTTP request headers
|
|
144
176
|
|
|
145
|
-
- **Content-Type**:
|
|
177
|
+
- **Content-Type**: Not defined
|
|
146
178
|
- **Accept**: application/json
|
|
147
179
|
|
|
148
180
|
|
|
149
|
-
##
|
|
181
|
+
## createBatchAllocation
|
|
150
182
|
|
|
151
|
-
>
|
|
183
|
+
> BatchAllocation createBatchAllocation(opts)
|
|
152
184
|
|
|
153
|
-
Create
|
|
185
|
+
Create batch allocation
|
|
154
186
|
|
|
155
|
-
|
|
187
|
+
This operation creates a batch allocation to withdraw available balances. You can include multiple merchants and cryptocurrencies in a single batch allocation.
|
|
156
188
|
|
|
157
189
|
### Example
|
|
158
190
|
|
|
@@ -167,9 +199,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
167
199
|
// Call the API
|
|
168
200
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
169
201
|
const opts = {
|
|
170
|
-
'
|
|
202
|
+
'CreateBatchAllocationRequest': new CoboWaas2.CreateBatchAllocationRequest()
|
|
171
203
|
};
|
|
172
|
-
apiInstance.
|
|
204
|
+
apiInstance.createBatchAllocation(opts).then((data) => {
|
|
173
205
|
console.log('API called successfully. Returned data: ' + data);
|
|
174
206
|
}, (error) => {
|
|
175
207
|
console.error(error);
|
|
@@ -182,11 +214,11 @@ apiInstance.createForcedSweepRequest(opts).then((data) => {
|
|
|
182
214
|
|
|
183
215
|
Name | Type | Description | Notes
|
|
184
216
|
------------- | ------------- | ------------- | -------------
|
|
185
|
-
**
|
|
217
|
+
**CreateBatchAllocationRequest** | [**CreateBatchAllocationRequest**](CreateBatchAllocationRequest.md)| The request body to create a settlement request. | [optional]
|
|
186
218
|
|
|
187
219
|
### Return type
|
|
188
220
|
|
|
189
|
-
[**
|
|
221
|
+
[**BatchAllocation**](BatchAllocation.md)
|
|
190
222
|
|
|
191
223
|
### Authorization
|
|
192
224
|
|
|
@@ -198,13 +230,13 @@ Name | Type | Description | Notes
|
|
|
198
230
|
- **Accept**: application/json
|
|
199
231
|
|
|
200
232
|
|
|
201
|
-
##
|
|
233
|
+
## createCounterparty
|
|
202
234
|
|
|
203
|
-
>
|
|
235
|
+
> CounterpartyDetail createCounterparty(opts)
|
|
204
236
|
|
|
205
|
-
Create
|
|
237
|
+
Create counterparty
|
|
206
238
|
|
|
207
|
-
This operation creates a
|
|
239
|
+
This operation creates a counterparty.
|
|
208
240
|
|
|
209
241
|
### Example
|
|
210
242
|
|
|
@@ -219,9 +251,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
219
251
|
// Call the API
|
|
220
252
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
221
253
|
const opts = {
|
|
222
|
-
'
|
|
254
|
+
'CreateCounterpartyRequest': new CoboWaas2.CreateCounterpartyRequest()
|
|
223
255
|
};
|
|
224
|
-
apiInstance.
|
|
256
|
+
apiInstance.createCounterparty(opts).then((data) => {
|
|
225
257
|
console.log('API called successfully. Returned data: ' + data);
|
|
226
258
|
}, (error) => {
|
|
227
259
|
console.error(error);
|
|
@@ -234,11 +266,11 @@ apiInstance.createMerchant(opts).then((data) => {
|
|
|
234
266
|
|
|
235
267
|
Name | Type | Description | Notes
|
|
236
268
|
------------- | ------------- | ------------- | -------------
|
|
237
|
-
**
|
|
269
|
+
**CreateCounterpartyRequest** | [**CreateCounterpartyRequest**](CreateCounterpartyRequest.md)| The request body to create a counterparty. | [optional]
|
|
238
270
|
|
|
239
271
|
### Return type
|
|
240
272
|
|
|
241
|
-
[**
|
|
273
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
242
274
|
|
|
243
275
|
### Authorization
|
|
244
276
|
|
|
@@ -250,13 +282,13 @@ Name | Type | Description | Notes
|
|
|
250
282
|
- **Accept**: application/json
|
|
251
283
|
|
|
252
284
|
|
|
253
|
-
##
|
|
285
|
+
## createCounterpartyWalletAddress
|
|
254
286
|
|
|
255
|
-
>
|
|
287
|
+
> WalletAddress createCounterpartyWalletAddress(opts)
|
|
256
288
|
|
|
257
|
-
Create
|
|
289
|
+
Create counterparty wallet address
|
|
258
290
|
|
|
259
|
-
This operation
|
|
291
|
+
This operation creates a counterparty wallet address.
|
|
260
292
|
|
|
261
293
|
### Example
|
|
262
294
|
|
|
@@ -271,9 +303,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
271
303
|
// Call the API
|
|
272
304
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
273
305
|
const opts = {
|
|
274
|
-
'
|
|
306
|
+
'CreateCounterpartyWalletAddressRequest': new CoboWaas2.CreateCounterpartyWalletAddressRequest()
|
|
275
307
|
};
|
|
276
|
-
apiInstance.
|
|
308
|
+
apiInstance.createCounterpartyWalletAddress(opts).then((data) => {
|
|
277
309
|
console.log('API called successfully. Returned data: ' + data);
|
|
278
310
|
}, (error) => {
|
|
279
311
|
console.error(error);
|
|
@@ -286,15 +318,15 @@ apiInstance.createOrderLink(opts).then((data) => {
|
|
|
286
318
|
|
|
287
319
|
Name | Type | Description | Notes
|
|
288
320
|
------------- | ------------- | ------------- | -------------
|
|
289
|
-
**
|
|
321
|
+
**CreateCounterpartyWalletAddressRequest** | [**CreateCounterpartyWalletAddressRequest**](CreateCounterpartyWalletAddressRequest.md)| The request body to create a counterparty wallet address. | [optional]
|
|
290
322
|
|
|
291
323
|
### Return type
|
|
292
324
|
|
|
293
|
-
[**
|
|
325
|
+
[**WalletAddress**](WalletAddress.md)
|
|
294
326
|
|
|
295
327
|
### Authorization
|
|
296
328
|
|
|
297
|
-
[CoboAuth](../README.md#CoboAuth)
|
|
329
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
298
330
|
|
|
299
331
|
### HTTP request headers
|
|
300
332
|
|
|
@@ -302,13 +334,13 @@ Name | Type | Description | Notes
|
|
|
302
334
|
- **Accept**: application/json
|
|
303
335
|
|
|
304
336
|
|
|
305
|
-
##
|
|
337
|
+
## createCryptoAddress
|
|
306
338
|
|
|
307
|
-
>
|
|
339
|
+
> CryptoAddress createCryptoAddress(opts)
|
|
308
340
|
|
|
309
|
-
Create
|
|
341
|
+
Create crypto address
|
|
310
342
|
|
|
311
|
-
This operation
|
|
343
|
+
This operation registers a crypto address for crypto payouts. The registered address can later be referenced by its ID when creating settlement requests.
|
|
312
344
|
|
|
313
345
|
### Example
|
|
314
346
|
|
|
@@ -323,9 +355,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
323
355
|
// Call the API
|
|
324
356
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
325
357
|
const opts = {
|
|
326
|
-
'
|
|
358
|
+
'CreateCryptoAddressRequest': new CoboWaas2.CreateCryptoAddressRequest()
|
|
327
359
|
};
|
|
328
|
-
apiInstance.
|
|
360
|
+
apiInstance.createCryptoAddress(opts).then((data) => {
|
|
329
361
|
console.log('API called successfully. Returned data: ' + data);
|
|
330
362
|
}, (error) => {
|
|
331
363
|
console.error(error);
|
|
@@ -338,11 +370,11 @@ apiInstance.createPaymentOrder(opts).then((data) => {
|
|
|
338
370
|
|
|
339
371
|
Name | Type | Description | Notes
|
|
340
372
|
------------- | ------------- | ------------- | -------------
|
|
341
|
-
**
|
|
373
|
+
**CreateCryptoAddressRequest** | [**CreateCryptoAddressRequest**](CreateCryptoAddressRequest.md)| The request body to register a crypto address. | [optional]
|
|
342
374
|
|
|
343
375
|
### Return type
|
|
344
376
|
|
|
345
|
-
[**
|
|
377
|
+
[**CryptoAddress**](CryptoAddress.md)
|
|
346
378
|
|
|
347
379
|
### Authorization
|
|
348
380
|
|
|
@@ -354,13 +386,13 @@ Name | Type | Description | Notes
|
|
|
354
386
|
- **Accept**: application/json
|
|
355
387
|
|
|
356
388
|
|
|
357
|
-
##
|
|
389
|
+
## createDestination
|
|
358
390
|
|
|
359
|
-
>
|
|
391
|
+
> DestinationDetail createDestination(opts)
|
|
360
392
|
|
|
361
|
-
Create
|
|
393
|
+
Create destination
|
|
362
394
|
|
|
363
|
-
This operation creates a
|
|
395
|
+
This operation creates a destination.
|
|
364
396
|
|
|
365
397
|
### Example
|
|
366
398
|
|
|
@@ -375,9 +407,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
375
407
|
// Call the API
|
|
376
408
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
377
409
|
const opts = {
|
|
378
|
-
'
|
|
410
|
+
'CreateDestinationRequest': new CoboWaas2.CreateDestinationRequest()
|
|
379
411
|
};
|
|
380
|
-
apiInstance.
|
|
412
|
+
apiInstance.createDestination(opts).then((data) => {
|
|
381
413
|
console.log('API called successfully. Returned data: ' + data);
|
|
382
414
|
}, (error) => {
|
|
383
415
|
console.error(error);
|
|
@@ -390,11 +422,11 @@ apiInstance.createRefund(opts).then((data) => {
|
|
|
390
422
|
|
|
391
423
|
Name | Type | Description | Notes
|
|
392
424
|
------------- | ------------- | ------------- | -------------
|
|
393
|
-
**
|
|
425
|
+
**CreateDestinationRequest** | [**CreateDestinationRequest**](CreateDestinationRequest.md)| The request body to create a destination. | [optional]
|
|
394
426
|
|
|
395
427
|
### Return type
|
|
396
428
|
|
|
397
|
-
[**
|
|
429
|
+
[**DestinationDetail**](DestinationDetail.md)
|
|
398
430
|
|
|
399
431
|
### Authorization
|
|
400
432
|
|
|
@@ -406,13 +438,13 @@ Name | Type | Description | Notes
|
|
|
406
438
|
- **Accept**: application/json
|
|
407
439
|
|
|
408
440
|
|
|
409
|
-
##
|
|
441
|
+
## createDestinationBankAccount
|
|
410
442
|
|
|
411
|
-
>
|
|
443
|
+
> DestinationBankAccount createDestinationBankAccount(opts)
|
|
412
444
|
|
|
413
|
-
Create
|
|
445
|
+
Create destination bank account
|
|
414
446
|
|
|
415
|
-
This operation creates a
|
|
447
|
+
This operation creates a destination bank account.
|
|
416
448
|
|
|
417
449
|
### Example
|
|
418
450
|
|
|
@@ -427,9 +459,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
427
459
|
// Call the API
|
|
428
460
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
429
461
|
const opts = {
|
|
430
|
-
'
|
|
462
|
+
'CreateDestinationBankAccountRequest': new CoboWaas2.CreateDestinationBankAccountRequest()
|
|
431
463
|
};
|
|
432
|
-
apiInstance.
|
|
464
|
+
apiInstance.createDestinationBankAccount(opts).then((data) => {
|
|
433
465
|
console.log('API called successfully. Returned data: ' + data);
|
|
434
466
|
}, (error) => {
|
|
435
467
|
console.error(error);
|
|
@@ -442,15 +474,15 @@ apiInstance.createRefundLink(opts).then((data) => {
|
|
|
442
474
|
|
|
443
475
|
Name | Type | Description | Notes
|
|
444
476
|
------------- | ------------- | ------------- | -------------
|
|
445
|
-
**
|
|
477
|
+
**CreateDestinationBankAccountRequest** | [**CreateDestinationBankAccountRequest**](CreateDestinationBankAccountRequest.md)| The request body to create a destination bank account. | [optional]
|
|
446
478
|
|
|
447
479
|
### Return type
|
|
448
480
|
|
|
449
|
-
[**
|
|
481
|
+
[**DestinationBankAccount**](DestinationBankAccount.md)
|
|
450
482
|
|
|
451
483
|
### Authorization
|
|
452
484
|
|
|
453
|
-
[CoboAuth](../README.md#CoboAuth)
|
|
485
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
454
486
|
|
|
455
487
|
### HTTP request headers
|
|
456
488
|
|
|
@@ -458,13 +490,13 @@ Name | Type | Description | Notes
|
|
|
458
490
|
- **Accept**: application/json
|
|
459
491
|
|
|
460
492
|
|
|
461
|
-
##
|
|
493
|
+
## createDestinationWalletAddress
|
|
462
494
|
|
|
463
|
-
>
|
|
495
|
+
> WalletAddress createDestinationWalletAddress(opts)
|
|
464
496
|
|
|
465
|
-
Create
|
|
497
|
+
Create destination wallet address
|
|
466
498
|
|
|
467
|
-
This operation creates a
|
|
499
|
+
This operation creates a destination wallet address.
|
|
468
500
|
|
|
469
501
|
### Example
|
|
470
502
|
|
|
@@ -479,9 +511,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
479
511
|
// Call the API
|
|
480
512
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
481
513
|
const opts = {
|
|
482
|
-
'
|
|
514
|
+
'CreateDestinationWalletAddressRequest': new CoboWaas2.CreateDestinationWalletAddressRequest()
|
|
483
515
|
};
|
|
484
|
-
apiInstance.
|
|
516
|
+
apiInstance.createDestinationWalletAddress(opts).then((data) => {
|
|
485
517
|
console.log('API called successfully. Returned data: ' + data);
|
|
486
518
|
}, (error) => {
|
|
487
519
|
console.error(error);
|
|
@@ -494,11 +526,11 @@ apiInstance.createSettlementRequest(opts).then((data) => {
|
|
|
494
526
|
|
|
495
527
|
Name | Type | Description | Notes
|
|
496
528
|
------------- | ------------- | ------------- | -------------
|
|
497
|
-
**
|
|
529
|
+
**CreateDestinationWalletAddressRequest** | [**CreateDestinationWalletAddressRequest**](CreateDestinationWalletAddressRequest.md)| The request body to create a destination wallet address. | [optional]
|
|
498
530
|
|
|
499
531
|
### Return type
|
|
500
532
|
|
|
501
|
-
[**
|
|
533
|
+
[**WalletAddress**](WalletAddress.md)
|
|
502
534
|
|
|
503
535
|
### Authorization
|
|
504
536
|
|
|
@@ -510,13 +542,13 @@ Name | Type | Description | Notes
|
|
|
510
542
|
- **Accept**: application/json
|
|
511
543
|
|
|
512
544
|
|
|
513
|
-
##
|
|
545
|
+
## createForcedSweepRequest
|
|
514
546
|
|
|
515
|
-
>
|
|
547
|
+
> ForcedSweep createForcedSweepRequest(opts)
|
|
516
548
|
|
|
517
|
-
|
|
549
|
+
Create forced sweep
|
|
518
550
|
|
|
519
|
-
This operation
|
|
551
|
+
<Warning>This operation has been deprecated.</Warning> This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address.
|
|
520
552
|
|
|
521
553
|
### Example
|
|
522
554
|
|
|
@@ -530,8 +562,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
530
562
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
531
563
|
// Call the API
|
|
532
564
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
533
|
-
const
|
|
534
|
-
|
|
565
|
+
const opts = {
|
|
566
|
+
'ForcedSweepRequest': new CoboWaas2.ForcedSweepRequest()
|
|
567
|
+
};
|
|
568
|
+
apiInstance.createForcedSweepRequest(opts).then((data) => {
|
|
535
569
|
console.log('API called successfully. Returned data: ' + data);
|
|
536
570
|
}, (error) => {
|
|
537
571
|
console.error(error);
|
|
@@ -544,11 +578,11 @@ apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
|
544
578
|
|
|
545
579
|
Name | Type | Description | Notes
|
|
546
580
|
------------- | ------------- | ------------- | -------------
|
|
547
|
-
**
|
|
581
|
+
**ForcedSweepRequest** | [**ForcedSweepRequest**](ForcedSweepRequest.md)| The request body for forced sweep. | [optional]
|
|
548
582
|
|
|
549
583
|
### Return type
|
|
550
584
|
|
|
551
|
-
[**
|
|
585
|
+
[**ForcedSweep**](ForcedSweep.md)
|
|
552
586
|
|
|
553
587
|
### Authorization
|
|
554
588
|
|
|
@@ -556,17 +590,17 @@ Name | Type | Description | Notes
|
|
|
556
590
|
|
|
557
591
|
### HTTP request headers
|
|
558
592
|
|
|
559
|
-
- **Content-Type**:
|
|
593
|
+
- **Content-Type**: application/json
|
|
560
594
|
- **Accept**: application/json
|
|
561
595
|
|
|
562
596
|
|
|
563
|
-
##
|
|
597
|
+
## createMerchant
|
|
564
598
|
|
|
565
|
-
>
|
|
599
|
+
> Merchant createMerchant(opts)
|
|
566
600
|
|
|
567
|
-
|
|
601
|
+
Create merchant
|
|
568
602
|
|
|
569
|
-
This operation
|
|
603
|
+
This operation creates a merchant. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. For more information on merchant creation, please refer to [Preparation](https://www.cobo.com/payments/en/guides/preparation#create-merchant).
|
|
570
604
|
|
|
571
605
|
### Example
|
|
572
606
|
|
|
@@ -580,9 +614,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
580
614
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
581
615
|
// Call the API
|
|
582
616
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
583
|
-
const
|
|
584
|
-
|
|
585
|
-
|
|
617
|
+
const opts = {
|
|
618
|
+
'CreateMerchantRequest': new CoboWaas2.CreateMerchantRequest()
|
|
619
|
+
};
|
|
620
|
+
apiInstance.createMerchant(opts).then((data) => {
|
|
586
621
|
console.log('API called successfully. Returned data: ' + data);
|
|
587
622
|
}, (error) => {
|
|
588
623
|
console.error(error);
|
|
@@ -595,30 +630,29 @@ apiInstance.getExchangeRate(token_id, currency).then((data) => {
|
|
|
595
630
|
|
|
596
631
|
Name | Type | Description | Notes
|
|
597
632
|
------------- | ------------- | ------------- | -------------
|
|
598
|
-
**
|
|
599
|
-
**currency** | **String**| The fiat currency. Currently, only `USD` is supported. | [default to 'USD']
|
|
633
|
+
**CreateMerchantRequest** | [**CreateMerchantRequest**](CreateMerchantRequest.md)| The request body to create a merchant. | [optional]
|
|
600
634
|
|
|
601
635
|
### Return type
|
|
602
636
|
|
|
603
|
-
[**
|
|
637
|
+
[**Merchant**](Merchant.md)
|
|
604
638
|
|
|
605
639
|
### Authorization
|
|
606
640
|
|
|
607
|
-
[CoboAuth](../README.md#CoboAuth)
|
|
641
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
608
642
|
|
|
609
643
|
### HTTP request headers
|
|
610
644
|
|
|
611
|
-
- **Content-Type**:
|
|
645
|
+
- **Content-Type**: application/json
|
|
612
646
|
- **Accept**: application/json
|
|
613
647
|
|
|
614
648
|
|
|
615
|
-
##
|
|
649
|
+
## createOrderLink
|
|
616
650
|
|
|
617
|
-
>
|
|
651
|
+
> Link createOrderLink(opts)
|
|
618
652
|
|
|
619
|
-
|
|
653
|
+
Create order link
|
|
620
654
|
|
|
621
|
-
This operation
|
|
655
|
+
This operation generates a payment link for a pay-in order. The link directs users to a hosted payment page where they can complete their payment for the order. You can share the link directly with users or embed the payment page in your website or application using an iframe. For more details, see [Payment Link](https://www.cobo.com/payments/en/guides/payment-link).
|
|
622
656
|
|
|
623
657
|
### Example
|
|
624
658
|
|
|
@@ -632,12 +666,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
632
666
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
633
667
|
// Call the API
|
|
634
668
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
635
|
-
const payer_id = "P20250619T0310056d7aa";
|
|
636
|
-
const token_id = "ETH_USDT";
|
|
637
669
|
const opts = {
|
|
638
|
-
'
|
|
670
|
+
'CreateOrderLinkRequest': new CoboWaas2.CreateOrderLinkRequest()
|
|
639
671
|
};
|
|
640
|
-
apiInstance.
|
|
672
|
+
apiInstance.createOrderLink(opts).then((data) => {
|
|
641
673
|
console.log('API called successfully. Returned data: ' + data);
|
|
642
674
|
}, (error) => {
|
|
643
675
|
console.error(error);
|
|
@@ -650,31 +682,29 @@ apiInstance.getPayerBalanceByAddress(payer_id, token_id, opts).then((data) => {
|
|
|
650
682
|
|
|
651
683
|
Name | Type | Description | Notes
|
|
652
684
|
------------- | ------------- | ------------- | -------------
|
|
653
|
-
**
|
|
654
|
-
**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` |
|
|
655
|
-
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
685
|
+
**CreateOrderLinkRequest** | [**CreateOrderLinkRequest**](CreateOrderLinkRequest.md)| The request body to create a payment link for a pay-in order. | [optional]
|
|
656
686
|
|
|
657
687
|
### Return type
|
|
658
688
|
|
|
659
|
-
[**
|
|
689
|
+
[**Link**](Link.md)
|
|
660
690
|
|
|
661
691
|
### Authorization
|
|
662
692
|
|
|
663
|
-
[
|
|
693
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
664
694
|
|
|
665
695
|
### HTTP request headers
|
|
666
696
|
|
|
667
|
-
- **Content-Type**:
|
|
697
|
+
- **Content-Type**: application/json
|
|
668
698
|
- **Accept**: application/json
|
|
669
699
|
|
|
670
700
|
|
|
671
|
-
##
|
|
701
|
+
## createPaymentOrder
|
|
672
702
|
|
|
673
|
-
> Order
|
|
703
|
+
> Order createPaymentOrder(opts)
|
|
674
704
|
|
|
675
|
-
|
|
705
|
+
Create pay-in order
|
|
676
706
|
|
|
677
|
-
This operation
|
|
707
|
+
This operation creates a pay-in order.
|
|
678
708
|
|
|
679
709
|
### Example
|
|
680
710
|
|
|
@@ -688,8 +718,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
688
718
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
689
719
|
// Call the API
|
|
690
720
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
691
|
-
const
|
|
692
|
-
|
|
721
|
+
const opts = {
|
|
722
|
+
'CreatePaymentOrderRequest': new CoboWaas2.CreatePaymentOrderRequest()
|
|
723
|
+
};
|
|
724
|
+
apiInstance.createPaymentOrder(opts).then((data) => {
|
|
693
725
|
console.log('API called successfully. Returned data: ' + data);
|
|
694
726
|
}, (error) => {
|
|
695
727
|
console.error(error);
|
|
@@ -702,7 +734,7 @@ apiInstance.getPaymentOrderDetailById(order_id).then((data) => {
|
|
|
702
734
|
|
|
703
735
|
Name | Type | Description | Notes
|
|
704
736
|
------------- | ------------- | ------------- | -------------
|
|
705
|
-
**
|
|
737
|
+
**CreatePaymentOrderRequest** | [**CreatePaymentOrderRequest**](CreatePaymentOrderRequest.md)| The request body to create a pay-in order. | [optional]
|
|
706
738
|
|
|
707
739
|
### Return type
|
|
708
740
|
|
|
@@ -714,17 +746,17 @@ Name | Type | Description | Notes
|
|
|
714
746
|
|
|
715
747
|
### HTTP request headers
|
|
716
748
|
|
|
717
|
-
- **Content-Type**:
|
|
749
|
+
- **Content-Type**: application/json
|
|
718
750
|
- **Accept**: application/json
|
|
719
751
|
|
|
720
752
|
|
|
721
|
-
##
|
|
753
|
+
## createPayout
|
|
722
754
|
|
|
723
|
-
>
|
|
755
|
+
> PaymentPayout createPayout(opts)
|
|
724
756
|
|
|
725
|
-
|
|
757
|
+
Create payout
|
|
726
758
|
|
|
727
|
-
This operation
|
|
759
|
+
This operation creates a payout to withdraw available balances. You can include multiple merchants and cryptocurrencies in a single payout record.
|
|
728
760
|
|
|
729
761
|
### Example
|
|
730
762
|
|
|
@@ -738,8 +770,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
738
770
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
739
771
|
// Call the API
|
|
740
772
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
741
|
-
const
|
|
742
|
-
|
|
773
|
+
const opts = {
|
|
774
|
+
'CreatePayoutRequest': new CoboWaas2.CreatePayoutRequest()
|
|
775
|
+
};
|
|
776
|
+
apiInstance.createPayout(opts).then((data) => {
|
|
743
777
|
console.log('API called successfully. Returned data: ' + data);
|
|
744
778
|
}, (error) => {
|
|
745
779
|
console.error(error);
|
|
@@ -752,11 +786,11 @@ apiInstance.getPspBalance(token_id).then((data) => {
|
|
|
752
786
|
|
|
753
787
|
Name | Type | Description | Notes
|
|
754
788
|
------------- | ------------- | ------------- | -------------
|
|
755
|
-
**
|
|
789
|
+
**CreatePayoutRequest** | [**CreatePayoutRequest**](CreatePayoutRequest.md)| The request body to create a payout. | [optional]
|
|
756
790
|
|
|
757
791
|
### Return type
|
|
758
792
|
|
|
759
|
-
[**
|
|
793
|
+
[**PaymentPayout**](PaymentPayout.md)
|
|
760
794
|
|
|
761
795
|
### Authorization
|
|
762
796
|
|
|
@@ -764,17 +798,17 @@ Name | Type | Description | Notes
|
|
|
764
798
|
|
|
765
799
|
### HTTP request headers
|
|
766
800
|
|
|
767
|
-
- **Content-Type**:
|
|
801
|
+
- **Content-Type**: application/json
|
|
768
802
|
- **Accept**: application/json
|
|
769
803
|
|
|
770
804
|
|
|
771
|
-
##
|
|
805
|
+
## createRefund
|
|
772
806
|
|
|
773
|
-
> Refund
|
|
807
|
+
> Refund createRefund(opts)
|
|
774
808
|
|
|
775
|
-
|
|
809
|
+
Create refund order
|
|
776
810
|
|
|
777
|
-
This operation
|
|
811
|
+
This operation creates a refund order to return cryptocurrency to a specified address. When creating a refund order, you can optionally link it to an existing pay-in order for tracking and reconciliation purposes.
|
|
778
812
|
|
|
779
813
|
### Example
|
|
780
814
|
|
|
@@ -788,8 +822,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
788
822
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
789
823
|
// Call the API
|
|
790
824
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
791
|
-
const
|
|
792
|
-
|
|
825
|
+
const opts = {
|
|
826
|
+
'CreateRefundRequest': new CoboWaas2.CreateRefundRequest()
|
|
827
|
+
};
|
|
828
|
+
apiInstance.createRefund(opts).then((data) => {
|
|
793
829
|
console.log('API called successfully. Returned data: ' + data);
|
|
794
830
|
}, (error) => {
|
|
795
831
|
console.error(error);
|
|
@@ -802,7 +838,7 @@ apiInstance.getRefundDetailById(refund_id).then((data) => {
|
|
|
802
838
|
|
|
803
839
|
Name | Type | Description | Notes
|
|
804
840
|
------------- | ------------- | ------------- | -------------
|
|
805
|
-
**
|
|
841
|
+
**CreateRefundRequest** | [**CreateRefundRequest**](CreateRefundRequest.md)| The request body to create a refund order. | [optional]
|
|
806
842
|
|
|
807
843
|
### Return type
|
|
808
844
|
|
|
@@ -814,17 +850,17 @@ Name | Type | Description | Notes
|
|
|
814
850
|
|
|
815
851
|
### HTTP request headers
|
|
816
852
|
|
|
817
|
-
- **Content-Type**:
|
|
853
|
+
- **Content-Type**: application/json
|
|
818
854
|
- **Accept**: application/json
|
|
819
855
|
|
|
820
856
|
|
|
821
|
-
##
|
|
857
|
+
## createRefundLink
|
|
822
858
|
|
|
823
|
-
>
|
|
859
|
+
> Link createRefundLink(opts)
|
|
824
860
|
|
|
825
|
-
|
|
861
|
+
Create refund link
|
|
826
862
|
|
|
827
|
-
This operation
|
|
863
|
+
This operation creates a link that points to a Cobo-hosted refund page. The user can submit their desired refund address on the page. Once the address is submitted, Cobo will automatically create a refund order and initiate the refund process according to your configuration. For details, see [Create refund link](https://www.cobo.com/payments/en/guides/create-refund-link).
|
|
828
864
|
|
|
829
865
|
### Example
|
|
830
866
|
|
|
@@ -839,14 +875,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
839
875
|
// Call the API
|
|
840
876
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
841
877
|
const opts = {
|
|
842
|
-
'
|
|
843
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
844
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
845
|
-
'merchant_id': "M1001",
|
|
846
|
-
'request_id': "random_request_id",
|
|
847
|
-
'statuses': "Pending,Processing"
|
|
878
|
+
'CreateRefundLinkRequest': new CoboWaas2.CreateRefundLinkRequest()
|
|
848
879
|
};
|
|
849
|
-
apiInstance.
|
|
880
|
+
apiInstance.createRefundLink(opts).then((data) => {
|
|
850
881
|
console.log('API called successfully. Returned data: ' + data);
|
|
851
882
|
}, (error) => {
|
|
852
883
|
console.error(error);
|
|
@@ -859,34 +890,29 @@ apiInstance.getRefunds(opts).then((data) => {
|
|
|
859
890
|
|
|
860
891
|
Name | Type | Description | Notes
|
|
861
892
|
------------- | ------------- | ------------- | -------------
|
|
862
|
-
**
|
|
863
|
-
**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]
|
|
864
|
-
**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]
|
|
865
|
-
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
866
|
-
**request_id** | **String**| The request ID. | [optional]
|
|
867
|
-
**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/developers/v2/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information) - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) | [optional]
|
|
893
|
+
**CreateRefundLinkRequest** | [**CreateRefundLinkRequest**](CreateRefundLinkRequest.md)| The request body to create a refund link. | [optional]
|
|
868
894
|
|
|
869
895
|
### Return type
|
|
870
896
|
|
|
871
|
-
[**
|
|
897
|
+
[**Link**](Link.md)
|
|
872
898
|
|
|
873
899
|
### Authorization
|
|
874
900
|
|
|
875
|
-
[
|
|
901
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
876
902
|
|
|
877
903
|
### HTTP request headers
|
|
878
904
|
|
|
879
|
-
- **Content-Type**:
|
|
905
|
+
- **Content-Type**: application/json
|
|
880
906
|
- **Accept**: application/json
|
|
881
907
|
|
|
882
908
|
|
|
883
|
-
##
|
|
909
|
+
## createSettlementRequest
|
|
884
910
|
|
|
885
|
-
> Settlement
|
|
911
|
+
> Settlement createSettlementRequest(opts)
|
|
886
912
|
|
|
887
|
-
|
|
913
|
+
Create settlement request
|
|
888
914
|
|
|
889
|
-
This operation
|
|
915
|
+
This operation creates a settlement request to withdraw available balances.
|
|
890
916
|
|
|
891
917
|
### Example
|
|
892
918
|
|
|
@@ -900,8 +926,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
900
926
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
901
927
|
// Call the API
|
|
902
928
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
903
|
-
const
|
|
904
|
-
|
|
929
|
+
const opts = {
|
|
930
|
+
'CreateSettlementRequestRequest': new CoboWaas2.CreateSettlementRequestRequest()
|
|
931
|
+
};
|
|
932
|
+
apiInstance.createSettlementRequest(opts).then((data) => {
|
|
905
933
|
console.log('API called successfully. Returned data: ' + data);
|
|
906
934
|
}, (error) => {
|
|
907
935
|
console.error(error);
|
|
@@ -914,7 +942,7 @@ apiInstance.getSettlementById(settlement_request_id).then((data) => {
|
|
|
914
942
|
|
|
915
943
|
Name | Type | Description | Notes
|
|
916
944
|
------------- | ------------- | ------------- | -------------
|
|
917
|
-
**
|
|
945
|
+
**CreateSettlementRequestRequest** | [**CreateSettlementRequestRequest**](CreateSettlementRequestRequest.md)| The request body to create a settlement request. | [optional]
|
|
918
946
|
|
|
919
947
|
### Return type
|
|
920
948
|
|
|
@@ -926,17 +954,17 @@ Name | Type | Description | Notes
|
|
|
926
954
|
|
|
927
955
|
### HTTP request headers
|
|
928
956
|
|
|
929
|
-
- **Content-Type**:
|
|
957
|
+
- **Content-Type**: application/json
|
|
930
958
|
- **Accept**: application/json
|
|
931
959
|
|
|
932
960
|
|
|
933
|
-
##
|
|
961
|
+
## deleteCounterparty
|
|
934
962
|
|
|
935
|
-
>
|
|
963
|
+
> DeleteCounterparty200Response deleteCounterparty(counterparty_id)
|
|
936
964
|
|
|
937
|
-
|
|
965
|
+
Delete counterparty
|
|
938
966
|
|
|
939
|
-
|
|
967
|
+
This operation deletes a counterparty.
|
|
940
968
|
|
|
941
969
|
### Example
|
|
942
970
|
|
|
@@ -950,12 +978,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
950
978
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
951
979
|
// Call the API
|
|
952
980
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
953
|
-
const
|
|
954
|
-
|
|
955
|
-
'currency': "USD",
|
|
956
|
-
'acquiring_type': new CoboWaas2.AcquiringType()
|
|
957
|
-
};
|
|
958
|
-
apiInstance.getSettlementInfoByIds(opts).then((data) => {
|
|
981
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
982
|
+
apiInstance.deleteCounterparty(counterparty_id).then((data) => {
|
|
959
983
|
console.log('API called successfully. Returned data: ' + data);
|
|
960
984
|
}, (error) => {
|
|
961
985
|
console.error(error);
|
|
@@ -968,13 +992,11 @@ apiInstance.getSettlementInfoByIds(opts).then((data) => {
|
|
|
968
992
|
|
|
969
993
|
Name | Type | Description | Notes
|
|
970
994
|
------------- | ------------- | ------------- | -------------
|
|
971
|
-
**
|
|
972
|
-
**currency** | **String**| The currency for the operation. Currently, only `USD` is supported. | [optional] [default to 'USD']
|
|
973
|
-
**acquiring_type** | [**AcquiringType**](.md)| | [optional]
|
|
995
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
974
996
|
|
|
975
997
|
### Return type
|
|
976
998
|
|
|
977
|
-
[**
|
|
999
|
+
[**DeleteCounterparty200Response**](DeleteCounterparty200Response.md)
|
|
978
1000
|
|
|
979
1001
|
### Authorization
|
|
980
1002
|
|
|
@@ -986,13 +1008,13 @@ Name | Type | Description | Notes
|
|
|
986
1008
|
- **Accept**: application/json
|
|
987
1009
|
|
|
988
1010
|
|
|
989
|
-
##
|
|
1011
|
+
## deleteCounterpartyWalletAddress
|
|
990
1012
|
|
|
991
|
-
>
|
|
1013
|
+
> DeleteCounterpartyWalletAddress200Response deleteCounterpartyWalletAddress(wallet_address_id)
|
|
992
1014
|
|
|
993
|
-
|
|
1015
|
+
Delete counterparty wallet address
|
|
994
1016
|
|
|
995
|
-
This operation
|
|
1017
|
+
This operation deletes a counterparty wallet address.
|
|
996
1018
|
|
|
997
1019
|
### Example
|
|
998
1020
|
|
|
@@ -1006,12 +1028,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1006
1028
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1007
1029
|
// Call the API
|
|
1008
1030
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1009
|
-
const
|
|
1010
|
-
|
|
1011
|
-
const opts = {
|
|
1012
|
-
'merchant_id': "M1001"
|
|
1013
|
-
};
|
|
1014
|
-
apiInstance.getTopUpAddress(token_id, custom_payer_id, opts).then((data) => {
|
|
1031
|
+
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1032
|
+
apiInstance.deleteCounterpartyWalletAddress(wallet_address_id).then((data) => {
|
|
1015
1033
|
console.log('API called successfully. Returned data: ' + data);
|
|
1016
1034
|
}, (error) => {
|
|
1017
1035
|
console.error(error);
|
|
@@ -1024,13 +1042,11 @@ apiInstance.getTopUpAddress(token_id, custom_payer_id, opts).then((data) => {
|
|
|
1024
1042
|
|
|
1025
1043
|
Name | Type | Description | Notes
|
|
1026
1044
|
------------- | ------------- | ------------- | -------------
|
|
1027
|
-
**
|
|
1028
|
-
**custom_payer_id** | **String**| A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
1029
|
-
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1045
|
+
**wallet_address_id** | **String**| The wallet address ID. |
|
|
1030
1046
|
|
|
1031
1047
|
### Return type
|
|
1032
1048
|
|
|
1033
|
-
[**
|
|
1049
|
+
[**DeleteCounterpartyWalletAddress200Response**](DeleteCounterpartyWalletAddress200Response.md)
|
|
1034
1050
|
|
|
1035
1051
|
### Authorization
|
|
1036
1052
|
|
|
@@ -1042,13 +1058,13 @@ Name | Type | Description | Notes
|
|
|
1042
1058
|
- **Accept**: application/json
|
|
1043
1059
|
|
|
1044
1060
|
|
|
1045
|
-
##
|
|
1061
|
+
## deleteCryptoAddress
|
|
1046
1062
|
|
|
1047
|
-
>
|
|
1063
|
+
> DeleteCryptoAddress201Response deleteCryptoAddress(crypto_address_id)
|
|
1048
1064
|
|
|
1049
|
-
|
|
1065
|
+
Delete crypto address
|
|
1050
1066
|
|
|
1051
|
-
This operation
|
|
1067
|
+
This operation unregisters a crypto address from being used for crypto payouts.
|
|
1052
1068
|
|
|
1053
1069
|
### Example
|
|
1054
1070
|
|
|
@@ -1062,7 +1078,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1062
1078
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1063
1079
|
// Call the API
|
|
1064
1080
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1065
|
-
|
|
1081
|
+
const crypto_address_id = "addr_ethusdt_20250506T123456_ab12cd";
|
|
1082
|
+
apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
1066
1083
|
console.log('API called successfully. Returned data: ' + data);
|
|
1067
1084
|
}, (error) => {
|
|
1068
1085
|
console.error(error);
|
|
@@ -1072,11 +1089,14 @@ apiInstance.listBankAccounts().then((data) => {
|
|
|
1072
1089
|
|
|
1073
1090
|
### Parameters
|
|
1074
1091
|
|
|
1075
|
-
|
|
1092
|
+
|
|
1093
|
+
Name | Type | Description | Notes
|
|
1094
|
+
------------- | ------------- | ------------- | -------------
|
|
1095
|
+
**crypto_address_id** | **String**| The crypto address ID. |
|
|
1076
1096
|
|
|
1077
1097
|
### Return type
|
|
1078
1098
|
|
|
1079
|
-
[**
|
|
1099
|
+
[**DeleteCryptoAddress201Response**](DeleteCryptoAddress201Response.md)
|
|
1080
1100
|
|
|
1081
1101
|
### Authorization
|
|
1082
1102
|
|
|
@@ -1088,13 +1108,13 @@ This endpoint does not need any parameter.
|
|
|
1088
1108
|
- **Accept**: application/json
|
|
1089
1109
|
|
|
1090
1110
|
|
|
1091
|
-
##
|
|
1111
|
+
## deleteDestination
|
|
1092
1112
|
|
|
1093
|
-
>
|
|
1113
|
+
> DeleteDestination200Response deleteDestination(destination_id)
|
|
1094
1114
|
|
|
1095
|
-
|
|
1115
|
+
Delete destination
|
|
1096
1116
|
|
|
1097
|
-
This operation
|
|
1117
|
+
This operation deletes a destination.
|
|
1098
1118
|
|
|
1099
1119
|
### Example
|
|
1100
1120
|
|
|
@@ -1108,10 +1128,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1108
1128
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1109
1129
|
// Call the API
|
|
1110
1130
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1111
|
-
const
|
|
1112
|
-
|
|
1113
|
-
};
|
|
1114
|
-
apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
1131
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1132
|
+
apiInstance.deleteDestination(destination_id).then((data) => {
|
|
1115
1133
|
console.log('API called successfully. Returned data: ' + data);
|
|
1116
1134
|
}, (error) => {
|
|
1117
1135
|
console.error(error);
|
|
@@ -1124,11 +1142,11 @@ apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
|
1124
1142
|
|
|
1125
1143
|
Name | Type | Description | Notes
|
|
1126
1144
|
------------- | ------------- | ------------- | -------------
|
|
1127
|
-
**
|
|
1145
|
+
**destination_id** | **String**| The destination ID. |
|
|
1128
1146
|
|
|
1129
1147
|
### Return type
|
|
1130
1148
|
|
|
1131
|
-
[**
|
|
1149
|
+
[**DeleteDestination200Response**](DeleteDestination200Response.md)
|
|
1132
1150
|
|
|
1133
1151
|
### Authorization
|
|
1134
1152
|
|
|
@@ -1140,13 +1158,13 @@ Name | Type | Description | Notes
|
|
|
1140
1158
|
- **Accept**: application/json
|
|
1141
1159
|
|
|
1142
1160
|
|
|
1143
|
-
##
|
|
1161
|
+
## deleteDestinationBankAccount
|
|
1144
1162
|
|
|
1145
|
-
>
|
|
1163
|
+
> DeleteDestinationBankAccount200Response deleteDestinationBankAccount(bank_account_id)
|
|
1146
1164
|
|
|
1147
|
-
|
|
1165
|
+
Delete destination bank account
|
|
1148
1166
|
|
|
1149
|
-
|
|
1167
|
+
This operation deletes a destination bank account.
|
|
1150
1168
|
|
|
1151
1169
|
### Example
|
|
1152
1170
|
|
|
@@ -1160,13 +1178,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1160
1178
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1161
1179
|
// Call the API
|
|
1162
1180
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1163
|
-
const
|
|
1164
|
-
|
|
1165
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1166
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1167
|
-
'request_id': "random_request_id"
|
|
1168
|
-
};
|
|
1169
|
-
apiInstance.listForcedSweepRequests(opts).then((data) => {
|
|
1181
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
1182
|
+
apiInstance.deleteDestinationBankAccount(bank_account_id).then((data) => {
|
|
1170
1183
|
console.log('API called successfully. Returned data: ' + data);
|
|
1171
1184
|
}, (error) => {
|
|
1172
1185
|
console.error(error);
|
|
@@ -1179,14 +1192,11 @@ apiInstance.listForcedSweepRequests(opts).then((data) => {
|
|
|
1179
1192
|
|
|
1180
1193
|
Name | Type | Description | Notes
|
|
1181
1194
|
------------- | ------------- | ------------- | -------------
|
|
1182
|
-
**
|
|
1183
|
-
**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]
|
|
1184
|
-
**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]
|
|
1185
|
-
**request_id** | **String**| The request ID. | [optional]
|
|
1195
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
1186
1196
|
|
|
1187
1197
|
### Return type
|
|
1188
1198
|
|
|
1189
|
-
[**
|
|
1199
|
+
[**DeleteDestinationBankAccount200Response**](DeleteDestinationBankAccount200Response.md)
|
|
1190
1200
|
|
|
1191
1201
|
### Authorization
|
|
1192
1202
|
|
|
@@ -1198,13 +1208,13 @@ Name | Type | Description | Notes
|
|
|
1198
1208
|
- **Accept**: application/json
|
|
1199
1209
|
|
|
1200
1210
|
|
|
1201
|
-
##
|
|
1211
|
+
## deleteDestinationWalletAddress
|
|
1202
1212
|
|
|
1203
|
-
>
|
|
1213
|
+
> DeleteDestinationWalletAddress200Response deleteDestinationWalletAddress(wallet_address_id)
|
|
1204
1214
|
|
|
1205
|
-
|
|
1215
|
+
Delete destination wallet address
|
|
1206
1216
|
|
|
1207
|
-
|
|
1217
|
+
This operation deletes a destination wallet address.
|
|
1208
1218
|
|
|
1209
1219
|
### Example
|
|
1210
1220
|
|
|
@@ -1218,12 +1228,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1218
1228
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1219
1229
|
// Call the API
|
|
1220
1230
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1221
|
-
const
|
|
1222
|
-
|
|
1223
|
-
const opts = {
|
|
1224
|
-
'merchant_ids': "M1001,M1002,M1003"
|
|
1225
|
-
};
|
|
1226
|
-
apiInstance.listMerchantBalances(token_id, acquiring_type, opts).then((data) => {
|
|
1231
|
+
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1232
|
+
apiInstance.deleteDestinationWalletAddress(wallet_address_id).then((data) => {
|
|
1227
1233
|
console.log('API called successfully. Returned data: ' + data);
|
|
1228
1234
|
}, (error) => {
|
|
1229
1235
|
console.error(error);
|
|
@@ -1236,13 +1242,11 @@ apiInstance.listMerchantBalances(token_id, acquiring_type, opts).then((data) =>
|
|
|
1236
1242
|
|
|
1237
1243
|
Name | Type | Description | Notes
|
|
1238
1244
|
------------- | ------------- | ------------- | -------------
|
|
1239
|
-
**
|
|
1240
|
-
**acquiring_type** | [**AcquiringType**](.md)| The payment acquisition type. - `Order`: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions. - `TopUp`: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models. |
|
|
1241
|
-
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
1245
|
+
**wallet_address_id** | **String**| The wallet address ID. |
|
|
1242
1246
|
|
|
1243
1247
|
### Return type
|
|
1244
1248
|
|
|
1245
|
-
[**
|
|
1249
|
+
[**DeleteDestinationWalletAddress200Response**](DeleteDestinationWalletAddress200Response.md)
|
|
1246
1250
|
|
|
1247
1251
|
### Authorization
|
|
1248
1252
|
|
|
@@ -1254,13 +1258,13 @@ Name | Type | Description | Notes
|
|
|
1254
1258
|
- **Accept**: application/json
|
|
1255
1259
|
|
|
1256
1260
|
|
|
1257
|
-
##
|
|
1261
|
+
## enableDestinationWhitelist
|
|
1258
1262
|
|
|
1259
|
-
>
|
|
1263
|
+
> QueryDestinationWhitelistEnabled200Response enableDestinationWhitelist(opts)
|
|
1260
1264
|
|
|
1261
|
-
|
|
1265
|
+
Enable or disable destination whitelist
|
|
1262
1266
|
|
|
1263
|
-
This operation
|
|
1267
|
+
This operation enables or disables the whitelist for a destination.
|
|
1264
1268
|
|
|
1265
1269
|
### Example
|
|
1266
1270
|
|
|
@@ -1275,14 +1279,9 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
1275
1279
|
// Call the API
|
|
1276
1280
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1277
1281
|
const opts = {
|
|
1278
|
-
'
|
|
1279
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1280
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1281
|
-
'keyword': "keyword",
|
|
1282
|
-
'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
1283
|
-
'wallet_setup': new CoboWaas2.WalletSetup()
|
|
1282
|
+
'EnableDestinationWhitelistRequest': new CoboWaas2.EnableDestinationWhitelistRequest()
|
|
1284
1283
|
};
|
|
1285
|
-
apiInstance.
|
|
1284
|
+
apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
1286
1285
|
console.log('API called successfully. Returned data: ' + data);
|
|
1287
1286
|
}, (error) => {
|
|
1288
1287
|
console.error(error);
|
|
@@ -1295,16 +1294,11 @@ apiInstance.listMerchants(opts).then((data) => {
|
|
|
1295
1294
|
|
|
1296
1295
|
Name | Type | Description | Notes
|
|
1297
1296
|
------------- | ------------- | ------------- | -------------
|
|
1298
|
-
**
|
|
1299
|
-
**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]
|
|
1300
|
-
**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]
|
|
1301
|
-
**keyword** | **String**| A search term used for fuzzy matching of merchant names. | [optional]
|
|
1302
|
-
**wallet_id** | **String**| This parameter has been deprecated. | [optional]
|
|
1303
|
-
**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]
|
|
1297
|
+
**EnableDestinationWhitelistRequest** | [**EnableDestinationWhitelistRequest**](EnableDestinationWhitelistRequest.md)| The request body to enable or disable the destination whitelist. | [optional]
|
|
1304
1298
|
|
|
1305
1299
|
### Return type
|
|
1306
1300
|
|
|
1307
|
-
[**
|
|
1301
|
+
[**QueryDestinationWhitelistEnabled200Response**](QueryDestinationWhitelistEnabled200Response.md)
|
|
1308
1302
|
|
|
1309
1303
|
### Authorization
|
|
1310
1304
|
|
|
@@ -1312,17 +1306,17 @@ Name | Type | Description | Notes
|
|
|
1312
1306
|
|
|
1313
1307
|
### HTTP request headers
|
|
1314
1308
|
|
|
1315
|
-
- **Content-Type**:
|
|
1309
|
+
- **Content-Type**: application/json
|
|
1316
1310
|
- **Accept**: application/json
|
|
1317
1311
|
|
|
1318
1312
|
|
|
1319
|
-
##
|
|
1313
|
+
## getAvailableAllocationAmount
|
|
1320
1314
|
|
|
1321
|
-
>
|
|
1315
|
+
> PaymentAllocationAmount getAvailableAllocationAmount(token_id, source_account, destination_account)
|
|
1322
1316
|
|
|
1323
|
-
|
|
1317
|
+
Get available allocation amount
|
|
1324
1318
|
|
|
1325
|
-
This operation retrieves the information of
|
|
1319
|
+
This operation retrieves the information of available allocation amount.
|
|
1326
1320
|
|
|
1327
1321
|
### Example
|
|
1328
1322
|
|
|
@@ -1336,15 +1330,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1336
1330
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1337
1331
|
// Call the API
|
|
1338
1332
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1339
|
-
const
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
'merchant_id': "M1001",
|
|
1344
|
-
'psp_order_id': "P20240201001",
|
|
1345
|
-
'statuses': "Pending,Processing"
|
|
1346
|
-
};
|
|
1347
|
-
apiInstance.listPaymentOrders(opts).then((data) => {
|
|
1333
|
+
const token_id = "ETH_USDT";
|
|
1334
|
+
const source_account = "source_account_example";
|
|
1335
|
+
const destination_account = "destination_account_example";
|
|
1336
|
+
apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_account).then((data) => {
|
|
1348
1337
|
console.log('API called successfully. Returned data: ' + data);
|
|
1349
1338
|
}, (error) => {
|
|
1350
1339
|
console.error(error);
|
|
@@ -1357,16 +1346,13 @@ apiInstance.listPaymentOrders(opts).then((data) => {
|
|
|
1357
1346
|
|
|
1358
1347
|
Name | Type | Description | Notes
|
|
1359
1348
|
------------- | ------------- | ------------- | -------------
|
|
1360
|
-
**
|
|
1361
|
-
**
|
|
1362
|
-
**
|
|
1363
|
-
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1364
|
-
**psp_order_id** | **String**| A unique reference code assigned by the developer to identify this order in their system. | [optional]
|
|
1365
|
-
**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/developers/v2/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information) - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) | [optional]
|
|
1349
|
+
**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` |
|
|
1350
|
+
**source_account** | **String**| |
|
|
1351
|
+
**destination_account** | **String**| |
|
|
1366
1352
|
|
|
1367
1353
|
### Return type
|
|
1368
1354
|
|
|
1369
|
-
[**
|
|
1355
|
+
[**PaymentAllocationAmount**](PaymentAllocationAmount.md)
|
|
1370
1356
|
|
|
1371
1357
|
### Authorization
|
|
1372
1358
|
|
|
@@ -1378,13 +1364,13 @@ Name | Type | Description | Notes
|
|
|
1378
1364
|
- **Accept**: application/json
|
|
1379
1365
|
|
|
1380
1366
|
|
|
1381
|
-
##
|
|
1367
|
+
## getBatchAllocationById
|
|
1382
1368
|
|
|
1383
|
-
>
|
|
1369
|
+
> BatchAllocationDetail getBatchAllocationById(batch_allocation_id)
|
|
1384
1370
|
|
|
1385
|
-
|
|
1371
|
+
Get batch allocation by id
|
|
1386
1372
|
|
|
1387
|
-
This operation retrieves the information of
|
|
1373
|
+
This operation retrieves the information of a batch allocation.
|
|
1388
1374
|
|
|
1389
1375
|
### Example
|
|
1390
1376
|
|
|
@@ -1398,7 +1384,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1398
1384
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1399
1385
|
// Call the API
|
|
1400
1386
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1401
|
-
|
|
1387
|
+
const batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1388
|
+
apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
1402
1389
|
console.log('API called successfully. Returned data: ' + data);
|
|
1403
1390
|
}, (error) => {
|
|
1404
1391
|
console.error(error);
|
|
@@ -1408,11 +1395,14 @@ apiInstance.listPaymentSupportedTokens().then((data) => {
|
|
|
1408
1395
|
|
|
1409
1396
|
### Parameters
|
|
1410
1397
|
|
|
1411
|
-
|
|
1398
|
+
|
|
1399
|
+
Name | Type | Description | Notes
|
|
1400
|
+
------------- | ------------- | ------------- | -------------
|
|
1401
|
+
**batch_allocation_id** | **String**| The batch allocation ID. |
|
|
1412
1402
|
|
|
1413
1403
|
### Return type
|
|
1414
1404
|
|
|
1415
|
-
[**
|
|
1405
|
+
[**BatchAllocationDetail**](BatchAllocationDetail.md)
|
|
1416
1406
|
|
|
1417
1407
|
### Authorization
|
|
1418
1408
|
|
|
@@ -1424,13 +1414,13 @@ This endpoint does not need any parameter.
|
|
|
1424
1414
|
- **Accept**: application/json
|
|
1425
1415
|
|
|
1426
1416
|
|
|
1427
|
-
##
|
|
1417
|
+
## getCounterpartyDetailById
|
|
1428
1418
|
|
|
1429
|
-
>
|
|
1419
|
+
> CounterpartyDetail getCounterpartyDetailById(counterparty_id)
|
|
1430
1420
|
|
|
1431
|
-
|
|
1421
|
+
Get counterparty information
|
|
1432
1422
|
|
|
1433
|
-
|
|
1423
|
+
This operation retrieves the detailed information about a specified counterparty.
|
|
1434
1424
|
|
|
1435
1425
|
### Example
|
|
1436
1426
|
|
|
@@ -1444,11 +1434,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1444
1434
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1445
1435
|
// Call the API
|
|
1446
1436
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1447
|
-
const
|
|
1448
|
-
|
|
1449
|
-
'wallet_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,f47ac10b-58cc-4372-a567-0e02b2c3d472"
|
|
1450
|
-
};
|
|
1451
|
-
apiInstance.listPaymentWalletBalances(token_id, opts).then((data) => {
|
|
1437
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1438
|
+
apiInstance.getCounterpartyDetailById(counterparty_id).then((data) => {
|
|
1452
1439
|
console.log('API called successfully. Returned data: ' + data);
|
|
1453
1440
|
}, (error) => {
|
|
1454
1441
|
console.error(error);
|
|
@@ -1461,12 +1448,11 @@ apiInstance.listPaymentWalletBalances(token_id, opts).then((data) => {
|
|
|
1461
1448
|
|
|
1462
1449
|
Name | Type | Description | Notes
|
|
1463
1450
|
------------- | ------------- | ------------- | -------------
|
|
1464
|
-
**
|
|
1465
|
-
**wallet_ids** | **String**| A list of wallet IDs to query. | [optional]
|
|
1451
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
1466
1452
|
|
|
1467
1453
|
### Return type
|
|
1468
1454
|
|
|
1469
|
-
[**
|
|
1455
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
1470
1456
|
|
|
1471
1457
|
### Authorization
|
|
1472
1458
|
|
|
@@ -1478,13 +1464,13 @@ Name | Type | Description | Notes
|
|
|
1478
1464
|
- **Accept**: application/json
|
|
1479
1465
|
|
|
1480
1466
|
|
|
1481
|
-
##
|
|
1467
|
+
## getDestinationBankAccountDetailById
|
|
1482
1468
|
|
|
1483
|
-
>
|
|
1469
|
+
> DestinationBankAccountDetail getDestinationBankAccountDetailById(bank_account_id)
|
|
1484
1470
|
|
|
1485
|
-
|
|
1471
|
+
Get destination bank account information
|
|
1486
1472
|
|
|
1487
|
-
This operation retrieves the information
|
|
1473
|
+
This operation retrieves the detailed information about a specified destination bank account.
|
|
1488
1474
|
|
|
1489
1475
|
### Example
|
|
1490
1476
|
|
|
@@ -1498,14 +1484,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1498
1484
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1499
1485
|
// Call the API
|
|
1500
1486
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1501
|
-
const
|
|
1502
|
-
|
|
1503
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1504
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1505
|
-
'merchant_id': "M1001",
|
|
1506
|
-
'statuses': "Pending,Processing"
|
|
1507
|
-
};
|
|
1508
|
-
apiInstance.listSettlementDetails(opts).then((data) => {
|
|
1487
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
1488
|
+
apiInstance.getDestinationBankAccountDetailById(bank_account_id).then((data) => {
|
|
1509
1489
|
console.log('API called successfully. Returned data: ' + data);
|
|
1510
1490
|
}, (error) => {
|
|
1511
1491
|
console.error(error);
|
|
@@ -1518,15 +1498,11 @@ apiInstance.listSettlementDetails(opts).then((data) => {
|
|
|
1518
1498
|
|
|
1519
1499
|
Name | Type | Description | Notes
|
|
1520
1500
|
------------- | ------------- | ------------- | -------------
|
|
1521
|
-
**
|
|
1522
|
-
**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]
|
|
1523
|
-
**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]
|
|
1524
|
-
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1525
|
-
**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/developers/v2/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/developers/v2/api-references/payment/get-refund-order-information) - [List all settlement details](https://www.cobo.com/developers/v2/api-references/payment/list-all-settlement-details) | [optional]
|
|
1501
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
1526
1502
|
|
|
1527
1503
|
### Return type
|
|
1528
1504
|
|
|
1529
|
-
[**
|
|
1505
|
+
[**DestinationBankAccountDetail**](DestinationBankAccountDetail.md)
|
|
1530
1506
|
|
|
1531
1507
|
### Authorization
|
|
1532
1508
|
|
|
@@ -1538,13 +1514,13 @@ Name | Type | Description | Notes
|
|
|
1538
1514
|
- **Accept**: application/json
|
|
1539
1515
|
|
|
1540
1516
|
|
|
1541
|
-
##
|
|
1517
|
+
## getDestinationDetailById
|
|
1542
1518
|
|
|
1543
|
-
>
|
|
1519
|
+
> DestinationDetail getDestinationDetailById(destination_id)
|
|
1544
1520
|
|
|
1545
|
-
|
|
1521
|
+
Get destination information
|
|
1546
1522
|
|
|
1547
|
-
This operation retrieves the information
|
|
1523
|
+
This operation retrieves the detailed information about a specified destination.
|
|
1548
1524
|
|
|
1549
1525
|
### Example
|
|
1550
1526
|
|
|
@@ -1558,13 +1534,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1558
1534
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1559
1535
|
// Call the API
|
|
1560
1536
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1561
|
-
const
|
|
1562
|
-
|
|
1563
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1564
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1565
|
-
'request_id': "random_request_id"
|
|
1566
|
-
};
|
|
1567
|
-
apiInstance.listSettlementRequests(opts).then((data) => {
|
|
1537
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1538
|
+
apiInstance.getDestinationDetailById(destination_id).then((data) => {
|
|
1568
1539
|
console.log('API called successfully. Returned data: ' + data);
|
|
1569
1540
|
}, (error) => {
|
|
1570
1541
|
console.error(error);
|
|
@@ -1577,14 +1548,11 @@ apiInstance.listSettlementRequests(opts).then((data) => {
|
|
|
1577
1548
|
|
|
1578
1549
|
Name | Type | Description | Notes
|
|
1579
1550
|
------------- | ------------- | ------------- | -------------
|
|
1580
|
-
**
|
|
1581
|
-
**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]
|
|
1582
|
-
**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]
|
|
1583
|
-
**request_id** | **String**| The request ID. | [optional]
|
|
1551
|
+
**destination_id** | **String**| The destination ID. |
|
|
1584
1552
|
|
|
1585
1553
|
### Return type
|
|
1586
1554
|
|
|
1587
|
-
[**
|
|
1555
|
+
[**DestinationDetail**](DestinationDetail.md)
|
|
1588
1556
|
|
|
1589
1557
|
### Authorization
|
|
1590
1558
|
|
|
@@ -1596,13 +1564,13 @@ Name | Type | Description | Notes
|
|
|
1596
1564
|
- **Accept**: application/json
|
|
1597
1565
|
|
|
1598
1566
|
|
|
1599
|
-
##
|
|
1567
|
+
## getExchangeRate
|
|
1600
1568
|
|
|
1601
|
-
>
|
|
1569
|
+
> GetExchangeRate200Response getExchangeRate(token_id, currency)
|
|
1602
1570
|
|
|
1603
|
-
|
|
1571
|
+
Get exchange rate
|
|
1604
1572
|
|
|
1605
|
-
This operation retrieves the
|
|
1573
|
+
This operation retrieves the current exchange rate between a specified currency pair. The exchange rate is updated approximately every 10 minutes. <Note>This operation returns the exchange rate for reference only. The actual exchange rate may vary due to market fluctuations and other factors.</Note>
|
|
1606
1574
|
|
|
1607
1575
|
### Example
|
|
1608
1576
|
|
|
@@ -1616,14 +1584,9 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1616
1584
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1617
1585
|
// Call the API
|
|
1618
1586
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1619
|
-
const
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1623
|
-
'merchant_id': "M1001",
|
|
1624
|
-
'payer_id': "P20250619T0310056d7aa"
|
|
1625
|
-
};
|
|
1626
|
-
apiInstance.listTopUpPayerAccounts(opts).then((data) => {
|
|
1587
|
+
const token_id = "ETH_USDT";
|
|
1588
|
+
const currency = "USD";
|
|
1589
|
+
apiInstance.getExchangeRate(token_id, currency).then((data) => {
|
|
1627
1590
|
console.log('API called successfully. Returned data: ' + data);
|
|
1628
1591
|
}, (error) => {
|
|
1629
1592
|
console.error(error);
|
|
@@ -1636,19 +1599,16 @@ apiInstance.listTopUpPayerAccounts(opts).then((data) => {
|
|
|
1636
1599
|
|
|
1637
1600
|
Name | Type | Description | Notes
|
|
1638
1601
|
------------- | ------------- | ------------- | -------------
|
|
1639
|
-
**
|
|
1640
|
-
**
|
|
1641
|
-
**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]
|
|
1642
|
-
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1643
|
-
**payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
1602
|
+
**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` |
|
|
1603
|
+
**currency** | **String**| The fiat currency. Currently, only `USD` is supported. | [default to 'USD']
|
|
1644
1604
|
|
|
1645
1605
|
### Return type
|
|
1646
1606
|
|
|
1647
|
-
[**
|
|
1607
|
+
[**GetExchangeRate200Response**](GetExchangeRate200Response.md)
|
|
1648
1608
|
|
|
1649
1609
|
### Authorization
|
|
1650
1610
|
|
|
1651
|
-
[
|
|
1611
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
1652
1612
|
|
|
1653
1613
|
### HTTP request headers
|
|
1654
1614
|
|
|
@@ -1656,13 +1616,13 @@ Name | Type | Description | Notes
|
|
|
1656
1616
|
- **Accept**: application/json
|
|
1657
1617
|
|
|
1658
1618
|
|
|
1659
|
-
##
|
|
1619
|
+
## getPaymentOrderDetailById
|
|
1660
1620
|
|
|
1661
|
-
>
|
|
1621
|
+
> Order getPaymentOrderDetailById(order_id)
|
|
1662
1622
|
|
|
1663
|
-
|
|
1623
|
+
Get pay-in order information
|
|
1664
1624
|
|
|
1665
|
-
This operation retrieves
|
|
1625
|
+
This operation retrieves details of a specific pay-in order.
|
|
1666
1626
|
|
|
1667
1627
|
### Example
|
|
1668
1628
|
|
|
@@ -1676,14 +1636,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1676
1636
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1677
1637
|
// Call the API
|
|
1678
1638
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1679
|
-
const
|
|
1680
|
-
|
|
1681
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1682
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1683
|
-
'merchant_id': "M1001",
|
|
1684
|
-
'payer_id': "P20250619T0310056d7aa"
|
|
1685
|
-
};
|
|
1686
|
-
apiInstance.listTopUpPayers(opts).then((data) => {
|
|
1639
|
+
const order_id = "O20250304-M1001-1001";
|
|
1640
|
+
apiInstance.getPaymentOrderDetailById(order_id).then((data) => {
|
|
1687
1641
|
console.log('API called successfully. Returned data: ' + data);
|
|
1688
1642
|
}, (error) => {
|
|
1689
1643
|
console.error(error);
|
|
@@ -1696,15 +1650,11 @@ apiInstance.listTopUpPayers(opts).then((data) => {
|
|
|
1696
1650
|
|
|
1697
1651
|
Name | Type | Description | Notes
|
|
1698
1652
|
------------- | ------------- | ------------- | -------------
|
|
1699
|
-
**
|
|
1700
|
-
**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]
|
|
1701
|
-
**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]
|
|
1702
|
-
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1703
|
-
**payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
1653
|
+
**order_id** | **String**| The pay-in order ID. |
|
|
1704
1654
|
|
|
1705
1655
|
### Return type
|
|
1706
1656
|
|
|
1707
|
-
[**
|
|
1657
|
+
[**Order**](Order.md)
|
|
1708
1658
|
|
|
1709
1659
|
### Authorization
|
|
1710
1660
|
|
|
@@ -1716,13 +1666,13 @@ Name | Type | Description | Notes
|
|
|
1716
1666
|
- **Accept**: application/json
|
|
1717
1667
|
|
|
1718
1668
|
|
|
1719
|
-
##
|
|
1669
|
+
## getPayoutById
|
|
1720
1670
|
|
|
1721
|
-
>
|
|
1671
|
+
> PaymentPayoutDetail getPayoutById(payout_id)
|
|
1722
1672
|
|
|
1723
|
-
|
|
1673
|
+
Get payout information
|
|
1724
1674
|
|
|
1725
|
-
This operation
|
|
1675
|
+
This operation retrieves the information of a specific payout.
|
|
1726
1676
|
|
|
1727
1677
|
### Example
|
|
1728
1678
|
|
|
@@ -1736,10 +1686,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1736
1686
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1737
1687
|
// Call the API
|
|
1738
1688
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1739
|
-
const
|
|
1740
|
-
|
|
1741
|
-
};
|
|
1742
|
-
apiInstance.paymentEstimateFee(opts).then((data) => {
|
|
1689
|
+
const payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f";
|
|
1690
|
+
apiInstance.getPayoutById(payout_id).then((data) => {
|
|
1743
1691
|
console.log('API called successfully. Returned data: ' + data);
|
|
1744
1692
|
}, (error) => {
|
|
1745
1693
|
console.error(error);
|
|
@@ -1752,11 +1700,11 @@ apiInstance.paymentEstimateFee(opts).then((data) => {
|
|
|
1752
1700
|
|
|
1753
1701
|
Name | Type | Description | Notes
|
|
1754
1702
|
------------- | ------------- | ------------- | -------------
|
|
1755
|
-
**
|
|
1703
|
+
**payout_id** | **String**| The payout ID. |
|
|
1756
1704
|
|
|
1757
1705
|
### Return type
|
|
1758
1706
|
|
|
1759
|
-
[**
|
|
1707
|
+
[**PaymentPayoutDetail**](PaymentPayoutDetail.md)
|
|
1760
1708
|
|
|
1761
1709
|
### Authorization
|
|
1762
1710
|
|
|
@@ -1764,17 +1712,17 @@ Name | Type | Description | Notes
|
|
|
1764
1712
|
|
|
1765
1713
|
### HTTP request headers
|
|
1766
1714
|
|
|
1767
|
-
- **Content-Type**:
|
|
1715
|
+
- **Content-Type**: Not defined
|
|
1768
1716
|
- **Accept**: application/json
|
|
1769
1717
|
|
|
1770
1718
|
|
|
1771
|
-
##
|
|
1719
|
+
## getPspBalance
|
|
1772
1720
|
|
|
1773
|
-
>
|
|
1721
|
+
> PspBalance getPspBalance(token_id)
|
|
1774
1722
|
|
|
1775
|
-
|
|
1723
|
+
Get developer balance
|
|
1776
1724
|
|
|
1777
|
-
This operation
|
|
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 [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).
|
|
1778
1726
|
|
|
1779
1727
|
### Example
|
|
1780
1728
|
|
|
@@ -1788,11 +1736,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1788
1736
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1789
1737
|
// Call the API
|
|
1790
1738
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1791
|
-
const
|
|
1792
|
-
|
|
1793
|
-
'UpdateBankAccountByIdRequest': new CoboWaas2.UpdateBankAccountByIdRequest()
|
|
1794
|
-
};
|
|
1795
|
-
apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
|
|
1739
|
+
const token_id = "ETH_USDT";
|
|
1740
|
+
apiInstance.getPspBalance(token_id).then((data) => {
|
|
1796
1741
|
console.log('API called successfully. Returned data: ' + data);
|
|
1797
1742
|
}, (error) => {
|
|
1798
1743
|
console.error(error);
|
|
@@ -1805,12 +1750,1825 @@ apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
|
|
|
1805
1750
|
|
|
1806
1751
|
Name | Type | Description | Notes
|
|
1807
1752
|
------------- | ------------- | ------------- | -------------
|
|
1808
|
-
**
|
|
1809
|
-
**UpdateBankAccountByIdRequest** | [**UpdateBankAccountByIdRequest**](UpdateBankAccountByIdRequest.md)| The request body for updating an existing bank account. | [optional]
|
|
1753
|
+
**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` |
|
|
1810
1754
|
|
|
1811
1755
|
### Return type
|
|
1812
1756
|
|
|
1813
|
-
[**
|
|
1757
|
+
[**PspBalance**](PspBalance.md)
|
|
1758
|
+
|
|
1759
|
+
### Authorization
|
|
1760
|
+
|
|
1761
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1762
|
+
|
|
1763
|
+
### HTTP request headers
|
|
1764
|
+
|
|
1765
|
+
- **Content-Type**: Not defined
|
|
1766
|
+
- **Accept**: application/json
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
## getRefundDetailById
|
|
1770
|
+
|
|
1771
|
+
> Refund getRefundDetailById(refund_id)
|
|
1772
|
+
|
|
1773
|
+
Get refund order information
|
|
1774
|
+
|
|
1775
|
+
This operation retrieves the detailed information about a specified refund order.
|
|
1776
|
+
|
|
1777
|
+
### Example
|
|
1778
|
+
|
|
1779
|
+
```javascript
|
|
1780
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1781
|
+
// Initialize the API client
|
|
1782
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1783
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1784
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1785
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1786
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1787
|
+
// Call the API
|
|
1788
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1789
|
+
const refund_id = "R20250304-M1001-1001";
|
|
1790
|
+
apiInstance.getRefundDetailById(refund_id).then((data) => {
|
|
1791
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1792
|
+
}, (error) => {
|
|
1793
|
+
console.error(error);
|
|
1794
|
+
});
|
|
1795
|
+
|
|
1796
|
+
```
|
|
1797
|
+
|
|
1798
|
+
### Parameters
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
Name | Type | Description | Notes
|
|
1802
|
+
------------- | ------------- | ------------- | -------------
|
|
1803
|
+
**refund_id** | **String**| The refund order ID. |
|
|
1804
|
+
|
|
1805
|
+
### Return type
|
|
1806
|
+
|
|
1807
|
+
[**Refund**](Refund.md)
|
|
1808
|
+
|
|
1809
|
+
### Authorization
|
|
1810
|
+
|
|
1811
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1812
|
+
|
|
1813
|
+
### HTTP request headers
|
|
1814
|
+
|
|
1815
|
+
- **Content-Type**: Not defined
|
|
1816
|
+
- **Accept**: application/json
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
## getRefunds
|
|
1820
|
+
|
|
1821
|
+
> GetRefunds200Response getRefunds(opts)
|
|
1822
|
+
|
|
1823
|
+
List all refund orders
|
|
1824
|
+
|
|
1825
|
+
This operation retrieves the information of all refund orders.
|
|
1826
|
+
|
|
1827
|
+
### Example
|
|
1828
|
+
|
|
1829
|
+
```javascript
|
|
1830
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1831
|
+
// Initialize the API client
|
|
1832
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1833
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1834
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1835
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1836
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1837
|
+
// Call the API
|
|
1838
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1839
|
+
const opts = {
|
|
1840
|
+
'limit': 10,
|
|
1841
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1842
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1843
|
+
'merchant_id': "M1001",
|
|
1844
|
+
'request_id': "random_request_id",
|
|
1845
|
+
'statuses': "Pending,Processing"
|
|
1846
|
+
};
|
|
1847
|
+
apiInstance.getRefunds(opts).then((data) => {
|
|
1848
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1849
|
+
}, (error) => {
|
|
1850
|
+
console.error(error);
|
|
1851
|
+
});
|
|
1852
|
+
|
|
1853
|
+
```
|
|
1854
|
+
|
|
1855
|
+
### Parameters
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
Name | Type | Description | Notes
|
|
1859
|
+
------------- | ------------- | ------------- | -------------
|
|
1860
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1861
|
+
**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]
|
|
1862
|
+
**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
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1864
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
1865
|
+
**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]
|
|
1866
|
+
|
|
1867
|
+
### Return type
|
|
1868
|
+
|
|
1869
|
+
[**GetRefunds200Response**](GetRefunds200Response.md)
|
|
1870
|
+
|
|
1871
|
+
### Authorization
|
|
1872
|
+
|
|
1873
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1874
|
+
|
|
1875
|
+
### HTTP request headers
|
|
1876
|
+
|
|
1877
|
+
- **Content-Type**: Not defined
|
|
1878
|
+
- **Accept**: application/json
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
## getSettlementById
|
|
1882
|
+
|
|
1883
|
+
> Settlement getSettlementById(settlement_request_id)
|
|
1884
|
+
|
|
1885
|
+
Get settlement request information
|
|
1886
|
+
|
|
1887
|
+
This operation retrieves the information of a specific settlement request.
|
|
1888
|
+
|
|
1889
|
+
### Example
|
|
1890
|
+
|
|
1891
|
+
```javascript
|
|
1892
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1893
|
+
// Initialize the API client
|
|
1894
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1895
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1896
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1897
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1898
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1899
|
+
// Call the API
|
|
1900
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1901
|
+
const settlement_request_id = "S20250304-1001";
|
|
1902
|
+
apiInstance.getSettlementById(settlement_request_id).then((data) => {
|
|
1903
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1904
|
+
}, (error) => {
|
|
1905
|
+
console.error(error);
|
|
1906
|
+
});
|
|
1907
|
+
|
|
1908
|
+
```
|
|
1909
|
+
|
|
1910
|
+
### Parameters
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
Name | Type | Description | Notes
|
|
1914
|
+
------------- | ------------- | ------------- | -------------
|
|
1915
|
+
**settlement_request_id** | **String**| The settlement request ID. |
|
|
1916
|
+
|
|
1917
|
+
### Return type
|
|
1918
|
+
|
|
1919
|
+
[**Settlement**](Settlement.md)
|
|
1920
|
+
|
|
1921
|
+
### Authorization
|
|
1922
|
+
|
|
1923
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1924
|
+
|
|
1925
|
+
### HTTP request headers
|
|
1926
|
+
|
|
1927
|
+
- **Content-Type**: Not defined
|
|
1928
|
+
- **Accept**: application/json
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
## getSettlementInfoByIds
|
|
1932
|
+
|
|
1933
|
+
> GetSettlementInfoByIds200Response getSettlementInfoByIds(opts)
|
|
1934
|
+
|
|
1935
|
+
Get withdrawable balances
|
|
1936
|
+
|
|
1937
|
+
<Warning>This operation has been deprecated.</Warning> This operation retrieves the balances of specified merchants or the developer.
|
|
1938
|
+
|
|
1939
|
+
### Example
|
|
1940
|
+
|
|
1941
|
+
```javascript
|
|
1942
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1943
|
+
// Initialize the API client
|
|
1944
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1945
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1946
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1947
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1948
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1949
|
+
// Call the API
|
|
1950
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1951
|
+
const opts = {
|
|
1952
|
+
'merchant_ids': "M1001,M1002,M1003",
|
|
1953
|
+
'currency': "USD",
|
|
1954
|
+
'acquiring_type': new CoboWaas2.AcquiringType()
|
|
1955
|
+
};
|
|
1956
|
+
apiInstance.getSettlementInfoByIds(opts).then((data) => {
|
|
1957
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1958
|
+
}, (error) => {
|
|
1959
|
+
console.error(error);
|
|
1960
|
+
});
|
|
1961
|
+
|
|
1962
|
+
```
|
|
1963
|
+
|
|
1964
|
+
### Parameters
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
Name | Type | Description | Notes
|
|
1968
|
+
------------- | ------------- | ------------- | -------------
|
|
1969
|
+
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
1970
|
+
**currency** | **String**| The currency for the operation. Currently, only `USD` is supported. | [optional] [default to 'USD']
|
|
1971
|
+
**acquiring_type** | [**AcquiringType**](.md)| | [optional]
|
|
1972
|
+
|
|
1973
|
+
### Return type
|
|
1974
|
+
|
|
1975
|
+
[**GetSettlementInfoByIds200Response**](GetSettlementInfoByIds200Response.md)
|
|
1976
|
+
|
|
1977
|
+
### Authorization
|
|
1978
|
+
|
|
1979
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1980
|
+
|
|
1981
|
+
### HTTP request headers
|
|
1982
|
+
|
|
1983
|
+
- **Content-Type**: Not defined
|
|
1984
|
+
- **Accept**: application/json
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
## getTopUpAddress
|
|
1988
|
+
|
|
1989
|
+
> TopUpAddress getTopUpAddress(token_id, custom_payer_id, opts)
|
|
1990
|
+
|
|
1991
|
+
Create/Get top-up address
|
|
1992
|
+
|
|
1993
|
+
This operation creates or retrieves a unique top-up address for a payer. In the request, you need to provide the `custom_payer_id` parameter to identify the payer in your system and link them to the top-up address. - If no address exists for the payer on the specified chain, a new address will be created and returned. - If an address already exists for the payer on the specified chain, the existing address details will be returned. You can also provide the `merchant_id` parameter to specify the merchant to which the payer belongs. If not provided, the default merchant will be used.
|
|
1994
|
+
|
|
1995
|
+
### Example
|
|
1996
|
+
|
|
1997
|
+
```javascript
|
|
1998
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1999
|
+
// Initialize the API client
|
|
2000
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2001
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2002
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2003
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2004
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2005
|
+
// Call the API
|
|
2006
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2007
|
+
const token_id = "ETH_USDT";
|
|
2008
|
+
const custom_payer_id = "payer_0001";
|
|
2009
|
+
const opts = {
|
|
2010
|
+
'merchant_id': "M1001"
|
|
2011
|
+
};
|
|
2012
|
+
apiInstance.getTopUpAddress(token_id, custom_payer_id, opts).then((data) => {
|
|
2013
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2014
|
+
}, (error) => {
|
|
2015
|
+
console.error(error);
|
|
2016
|
+
});
|
|
2017
|
+
|
|
2018
|
+
```
|
|
2019
|
+
|
|
2020
|
+
### Parameters
|
|
2021
|
+
|
|
2022
|
+
|
|
2023
|
+
Name | Type | Description | Notes
|
|
2024
|
+
------------- | ------------- | ------------- | -------------
|
|
2025
|
+
**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` |
|
|
2026
|
+
**custom_payer_id** | **String**| A unique identifier to track and identify individual payers in your system. |
|
|
2027
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
2028
|
+
|
|
2029
|
+
### Return type
|
|
2030
|
+
|
|
2031
|
+
[**TopUpAddress**](TopUpAddress.md)
|
|
2032
|
+
|
|
2033
|
+
### Authorization
|
|
2034
|
+
|
|
2035
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2036
|
+
|
|
2037
|
+
### HTTP request headers
|
|
2038
|
+
|
|
2039
|
+
- **Content-Type**: Not defined
|
|
2040
|
+
- **Accept**: application/json
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
## listAllocations
|
|
2044
|
+
|
|
2045
|
+
> ListAllocations200Response listAllocations(opts)
|
|
2046
|
+
|
|
2047
|
+
List all allocations
|
|
2048
|
+
|
|
2049
|
+
This operation retrieves the information of all allocations.
|
|
2050
|
+
|
|
2051
|
+
### Example
|
|
2052
|
+
|
|
2053
|
+
```javascript
|
|
2054
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2055
|
+
// Initialize the API client
|
|
2056
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2057
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2058
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2059
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2060
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2061
|
+
// Call the API
|
|
2062
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2063
|
+
const opts = {
|
|
2064
|
+
'limit': 10,
|
|
2065
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2066
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2067
|
+
'source_account': "source_account_example",
|
|
2068
|
+
'destination_account': "destination_account_example",
|
|
2069
|
+
'token_id': "ETH_USDT",
|
|
2070
|
+
'batch_allocation_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384"
|
|
2071
|
+
};
|
|
2072
|
+
apiInstance.listAllocations(opts).then((data) => {
|
|
2073
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2074
|
+
}, (error) => {
|
|
2075
|
+
console.error(error);
|
|
2076
|
+
});
|
|
2077
|
+
|
|
2078
|
+
```
|
|
2079
|
+
|
|
2080
|
+
### Parameters
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
Name | Type | Description | Notes
|
|
2084
|
+
------------- | ------------- | ------------- | -------------
|
|
2085
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2086
|
+
**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
|
+
**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]
|
|
2090
|
+
**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
|
+
**batch_allocation_id** | **String**| The batch allocation ID. | [optional]
|
|
2092
|
+
|
|
2093
|
+
### Return type
|
|
2094
|
+
|
|
2095
|
+
[**ListAllocations200Response**](ListAllocations200Response.md)
|
|
2096
|
+
|
|
2097
|
+
### Authorization
|
|
2098
|
+
|
|
2099
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2100
|
+
|
|
2101
|
+
### HTTP request headers
|
|
2102
|
+
|
|
2103
|
+
- **Content-Type**: Not defined
|
|
2104
|
+
- **Accept**: application/json
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
## listBankAccounts
|
|
2108
|
+
|
|
2109
|
+
> [BankAccount] listBankAccounts()
|
|
2110
|
+
|
|
2111
|
+
List all bank accounts
|
|
2112
|
+
|
|
2113
|
+
This operation retrieves the information of all bank accounts you have registered for payment settlement. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new bank account.
|
|
2114
|
+
|
|
2115
|
+
### Example
|
|
2116
|
+
|
|
2117
|
+
```javascript
|
|
2118
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2119
|
+
// Initialize the API client
|
|
2120
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2121
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2122
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2123
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2124
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2125
|
+
// Call the API
|
|
2126
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2127
|
+
apiInstance.listBankAccounts().then((data) => {
|
|
2128
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2129
|
+
}, (error) => {
|
|
2130
|
+
console.error(error);
|
|
2131
|
+
});
|
|
2132
|
+
|
|
2133
|
+
```
|
|
2134
|
+
|
|
2135
|
+
### Parameters
|
|
2136
|
+
|
|
2137
|
+
This endpoint does not need any parameter.
|
|
2138
|
+
|
|
2139
|
+
### Return type
|
|
2140
|
+
|
|
2141
|
+
[**[BankAccount]**](BankAccount.md)
|
|
2142
|
+
|
|
2143
|
+
### Authorization
|
|
2144
|
+
|
|
2145
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2146
|
+
|
|
2147
|
+
### HTTP request headers
|
|
2148
|
+
|
|
2149
|
+
- **Content-Type**: Not defined
|
|
2150
|
+
- **Accept**: application/json
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
## listBatchAllocations
|
|
2154
|
+
|
|
2155
|
+
> ListBatchAllocations200Response listBatchAllocations(opts)
|
|
2156
|
+
|
|
2157
|
+
List all batch allocations
|
|
2158
|
+
|
|
2159
|
+
This operation retrieves the information of all batch allocations.
|
|
2160
|
+
|
|
2161
|
+
### Example
|
|
2162
|
+
|
|
2163
|
+
```javascript
|
|
2164
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2165
|
+
// Initialize the API client
|
|
2166
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2167
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2168
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2169
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2170
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2171
|
+
// Call the API
|
|
2172
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2173
|
+
const opts = {
|
|
2174
|
+
'limit': 10,
|
|
2175
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2176
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2177
|
+
'request_id': "random_request_id"
|
|
2178
|
+
};
|
|
2179
|
+
apiInstance.listBatchAllocations(opts).then((data) => {
|
|
2180
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2181
|
+
}, (error) => {
|
|
2182
|
+
console.error(error);
|
|
2183
|
+
});
|
|
2184
|
+
|
|
2185
|
+
```
|
|
2186
|
+
|
|
2187
|
+
### Parameters
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
Name | Type | Description | Notes
|
|
2191
|
+
------------- | ------------- | ------------- | -------------
|
|
2192
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2193
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
2194
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
2195
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
2196
|
+
|
|
2197
|
+
### Return type
|
|
2198
|
+
|
|
2199
|
+
[**ListBatchAllocations200Response**](ListBatchAllocations200Response.md)
|
|
2200
|
+
|
|
2201
|
+
### Authorization
|
|
2202
|
+
|
|
2203
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2204
|
+
|
|
2205
|
+
### HTTP request headers
|
|
2206
|
+
|
|
2207
|
+
- **Content-Type**: Not defined
|
|
2208
|
+
- **Accept**: application/json
|
|
2209
|
+
|
|
2210
|
+
|
|
2211
|
+
## listCounterparties
|
|
2212
|
+
|
|
2213
|
+
> ListCounterparties200Response listCounterparties(opts)
|
|
2214
|
+
|
|
2215
|
+
List all counterparties
|
|
2216
|
+
|
|
2217
|
+
This operation retrieves the information of all counterparties. You can filter the results by using a keyword for fuzzy search on counterparty names.
|
|
2218
|
+
|
|
2219
|
+
### Example
|
|
2220
|
+
|
|
2221
|
+
```javascript
|
|
2222
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2223
|
+
// Initialize the API client
|
|
2224
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2225
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2226
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2227
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2228
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2229
|
+
// Call the API
|
|
2230
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2231
|
+
const opts = {
|
|
2232
|
+
'limit': 10,
|
|
2233
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2234
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2235
|
+
'keyword': "keyword",
|
|
2236
|
+
'counterparty_type': new CoboWaas2.CounterpartyType(),
|
|
2237
|
+
'country': "USA"
|
|
2238
|
+
};
|
|
2239
|
+
apiInstance.listCounterparties(opts).then((data) => {
|
|
2240
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2241
|
+
}, (error) => {
|
|
2242
|
+
console.error(error);
|
|
2243
|
+
});
|
|
2244
|
+
|
|
2245
|
+
```
|
|
2246
|
+
|
|
2247
|
+
### Parameters
|
|
2248
|
+
|
|
2249
|
+
|
|
2250
|
+
Name | Type | Description | Notes
|
|
2251
|
+
------------- | ------------- | ------------- | -------------
|
|
2252
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2253
|
+
**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
|
+
**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 used for fuzzy matching of merchant names. | [optional]
|
|
2256
|
+
**counterparty_type** | [**CounterpartyType**](.md)| CounterpartyType defines the type of the counterparty: - `Individual`: The counterparty is an individual. - `Organization`: The counterparty is an organization. | [optional]
|
|
2257
|
+
**country** | **String**| The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
2258
|
+
|
|
2259
|
+
### Return type
|
|
2260
|
+
|
|
2261
|
+
[**ListCounterparties200Response**](ListCounterparties200Response.md)
|
|
2262
|
+
|
|
2263
|
+
### Authorization
|
|
2264
|
+
|
|
2265
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2266
|
+
|
|
2267
|
+
### HTTP request headers
|
|
2268
|
+
|
|
2269
|
+
- **Content-Type**: Not defined
|
|
2270
|
+
- **Accept**: application/json
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
## listCounterpartyWalletAddress
|
|
2274
|
+
|
|
2275
|
+
> ListCounterpartyWalletAddress200Response listCounterpartyWalletAddress(opts)
|
|
2276
|
+
|
|
2277
|
+
List counterparty wallet addresses
|
|
2278
|
+
|
|
2279
|
+
This operation retrieves the information of counterparty wallet addresses.
|
|
2280
|
+
|
|
2281
|
+
### Example
|
|
2282
|
+
|
|
2283
|
+
```javascript
|
|
2284
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2285
|
+
// Initialize the API client
|
|
2286
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2287
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2288
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2289
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2290
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2291
|
+
// Call the API
|
|
2292
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2293
|
+
const opts = {
|
|
2294
|
+
'limit': 10,
|
|
2295
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2296
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2297
|
+
'counterparty_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384",
|
|
2298
|
+
'chain_ids': "ETH",
|
|
2299
|
+
'wallet_address': "0x1234567890abcdef..."
|
|
2300
|
+
};
|
|
2301
|
+
apiInstance.listCounterpartyWalletAddress(opts).then((data) => {
|
|
2302
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2303
|
+
}, (error) => {
|
|
2304
|
+
console.error(error);
|
|
2305
|
+
});
|
|
2306
|
+
|
|
2307
|
+
```
|
|
2308
|
+
|
|
2309
|
+
### Parameters
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
Name | Type | Description | Notes
|
|
2313
|
+
------------- | ------------- | ------------- | -------------
|
|
2314
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2315
|
+
**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]
|
|
2316
|
+
**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]
|
|
2317
|
+
**counterparty_id** | **String**| The counterparty ID. | [optional]
|
|
2318
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
2319
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
2320
|
+
|
|
2321
|
+
### Return type
|
|
2322
|
+
|
|
2323
|
+
[**ListCounterpartyWalletAddress200Response**](ListCounterpartyWalletAddress200Response.md)
|
|
2324
|
+
|
|
2325
|
+
### Authorization
|
|
2326
|
+
|
|
2327
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2328
|
+
|
|
2329
|
+
### HTTP request headers
|
|
2330
|
+
|
|
2331
|
+
- **Content-Type**: Not defined
|
|
2332
|
+
- **Accept**: application/json
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
## listCryptoAddresses
|
|
2336
|
+
|
|
2337
|
+
> [CryptoAddress] listCryptoAddresses(opts)
|
|
2338
|
+
|
|
2339
|
+
List crypto addresses
|
|
2340
|
+
|
|
2341
|
+
This operation retrieves a list of crypto addresses registered for crypto payouts. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new crypto address.
|
|
2342
|
+
|
|
2343
|
+
### Example
|
|
2344
|
+
|
|
2345
|
+
```javascript
|
|
2346
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2347
|
+
// Initialize the API client
|
|
2348
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2349
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2350
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2351
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2352
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2353
|
+
// Call the API
|
|
2354
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2355
|
+
const opts = {
|
|
2356
|
+
'token_id': "ETH_USDT"
|
|
2357
|
+
};
|
|
2358
|
+
apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
2359
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2360
|
+
}, (error) => {
|
|
2361
|
+
console.error(error);
|
|
2362
|
+
});
|
|
2363
|
+
|
|
2364
|
+
```
|
|
2365
|
+
|
|
2366
|
+
### Parameters
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
Name | Type | Description | Notes
|
|
2370
|
+
------------- | ------------- | ------------- | -------------
|
|
2371
|
+
**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]
|
|
2372
|
+
|
|
2373
|
+
### Return type
|
|
2374
|
+
|
|
2375
|
+
[**[CryptoAddress]**](CryptoAddress.md)
|
|
2376
|
+
|
|
2377
|
+
### Authorization
|
|
2378
|
+
|
|
2379
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2380
|
+
|
|
2381
|
+
### HTTP request headers
|
|
2382
|
+
|
|
2383
|
+
- **Content-Type**: Not defined
|
|
2384
|
+
- **Accept**: application/json
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
## listDestinationBankAccounts
|
|
2388
|
+
|
|
2389
|
+
> ListDestinationBankAccounts200Response listDestinationBankAccounts(opts)
|
|
2390
|
+
|
|
2391
|
+
List destination bank accounts
|
|
2392
|
+
|
|
2393
|
+
This operation retrieves the information of destination bank accounts.
|
|
2394
|
+
|
|
2395
|
+
### Example
|
|
2396
|
+
|
|
2397
|
+
```javascript
|
|
2398
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2399
|
+
// Initialize the API client
|
|
2400
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2401
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2402
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2403
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2404
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2405
|
+
// Call the API
|
|
2406
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2407
|
+
const opts = {
|
|
2408
|
+
'limit': 10,
|
|
2409
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2410
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2411
|
+
'keyword': "keyword",
|
|
2412
|
+
'destination_id': "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
|
|
2413
|
+
'bank_account_status': new CoboWaas2.BankAccountStatus()
|
|
2414
|
+
};
|
|
2415
|
+
apiInstance.listDestinationBankAccounts(opts).then((data) => {
|
|
2416
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2417
|
+
}, (error) => {
|
|
2418
|
+
console.error(error);
|
|
2419
|
+
});
|
|
2420
|
+
|
|
2421
|
+
```
|
|
2422
|
+
|
|
2423
|
+
### Parameters
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
Name | Type | Description | Notes
|
|
2427
|
+
------------- | ------------- | ------------- | -------------
|
|
2428
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2429
|
+
**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
|
+
**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 used for fuzzy matching of merchant names. | [optional]
|
|
2432
|
+
**destination_id** | **String**| The destination ID. | [optional]
|
|
2433
|
+
**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
|
+
|
|
2435
|
+
### Return type
|
|
2436
|
+
|
|
2437
|
+
[**ListDestinationBankAccounts200Response**](ListDestinationBankAccounts200Response.md)
|
|
2438
|
+
|
|
2439
|
+
### Authorization
|
|
2440
|
+
|
|
2441
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2442
|
+
|
|
2443
|
+
### HTTP request headers
|
|
2444
|
+
|
|
2445
|
+
- **Content-Type**: Not defined
|
|
2446
|
+
- **Accept**: application/json
|
|
2447
|
+
|
|
2448
|
+
|
|
2449
|
+
## listDestinationWalletAddresses
|
|
2450
|
+
|
|
2451
|
+
> ListDestinationWalletAddresses200Response listDestinationWalletAddresses(opts)
|
|
2452
|
+
|
|
2453
|
+
List destination wallet addresses
|
|
2454
|
+
|
|
2455
|
+
This operation retrieves the information of destination wallet addresses.
|
|
2456
|
+
|
|
2457
|
+
### Example
|
|
2458
|
+
|
|
2459
|
+
```javascript
|
|
2460
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2461
|
+
// Initialize the API client
|
|
2462
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2463
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2464
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2465
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2466
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2467
|
+
// Call the API
|
|
2468
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2469
|
+
const opts = {
|
|
2470
|
+
'limit': 10,
|
|
2471
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2472
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2473
|
+
'destination_id': "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
|
|
2474
|
+
'chain_ids': "ETH",
|
|
2475
|
+
'wallet_address': "0x1234567890abcdef..."
|
|
2476
|
+
};
|
|
2477
|
+
apiInstance.listDestinationWalletAddresses(opts).then((data) => {
|
|
2478
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2479
|
+
}, (error) => {
|
|
2480
|
+
console.error(error);
|
|
2481
|
+
});
|
|
2482
|
+
|
|
2483
|
+
```
|
|
2484
|
+
|
|
2485
|
+
### Parameters
|
|
2486
|
+
|
|
2487
|
+
|
|
2488
|
+
Name | Type | Description | Notes
|
|
2489
|
+
------------- | ------------- | ------------- | -------------
|
|
2490
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2491
|
+
**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]
|
|
2492
|
+
**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]
|
|
2493
|
+
**destination_id** | **String**| The destination ID. | [optional]
|
|
2494
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
2495
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
2496
|
+
|
|
2497
|
+
### Return type
|
|
2498
|
+
|
|
2499
|
+
[**ListDestinationWalletAddresses200Response**](ListDestinationWalletAddresses200Response.md)
|
|
2500
|
+
|
|
2501
|
+
### Authorization
|
|
2502
|
+
|
|
2503
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2504
|
+
|
|
2505
|
+
### HTTP request headers
|
|
2506
|
+
|
|
2507
|
+
- **Content-Type**: Not defined
|
|
2508
|
+
- **Accept**: application/json
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
## listDestinations
|
|
2512
|
+
|
|
2513
|
+
> ListDestinations200Response listDestinations(opts)
|
|
2514
|
+
|
|
2515
|
+
List all destinations
|
|
2516
|
+
|
|
2517
|
+
This operation retrieves the information of all destinations. You can filter the results by using a keyword for fuzzy search on destination names.
|
|
2518
|
+
|
|
2519
|
+
### Example
|
|
2520
|
+
|
|
2521
|
+
```javascript
|
|
2522
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2523
|
+
// Initialize the API client
|
|
2524
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2525
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2526
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2527
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2528
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2529
|
+
// Call the API
|
|
2530
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2531
|
+
const opts = {
|
|
2532
|
+
'limit': 10,
|
|
2533
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2534
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2535
|
+
'keyword': "keyword",
|
|
2536
|
+
'destination_type': new CoboWaas2.DestinationType(),
|
|
2537
|
+
'country': "USA",
|
|
2538
|
+
'merchant_ids': "M1001,M1002,M1003"
|
|
2539
|
+
};
|
|
2540
|
+
apiInstance.listDestinations(opts).then((data) => {
|
|
2541
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2542
|
+
}, (error) => {
|
|
2543
|
+
console.error(error);
|
|
2544
|
+
});
|
|
2545
|
+
|
|
2546
|
+
```
|
|
2547
|
+
|
|
2548
|
+
### Parameters
|
|
2549
|
+
|
|
2550
|
+
|
|
2551
|
+
Name | Type | Description | Notes
|
|
2552
|
+
------------- | ------------- | ------------- | -------------
|
|
2553
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2554
|
+
**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
|
+
**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 used for fuzzy matching of merchant names. | [optional]
|
|
2557
|
+
**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**| The country of the destination, in ISO 3166-1 alpha-3 format. | [optional]
|
|
2559
|
+
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
2560
|
+
|
|
2561
|
+
### Return type
|
|
2562
|
+
|
|
2563
|
+
[**ListDestinations200Response**](ListDestinations200Response.md)
|
|
2564
|
+
|
|
2565
|
+
### Authorization
|
|
2566
|
+
|
|
2567
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2568
|
+
|
|
2569
|
+
### HTTP request headers
|
|
2570
|
+
|
|
2571
|
+
- **Content-Type**: Not defined
|
|
2572
|
+
- **Accept**: application/json
|
|
2573
|
+
|
|
2574
|
+
|
|
2575
|
+
## listForcedSweepRequests
|
|
2576
|
+
|
|
2577
|
+
> ListForcedSweepRequests200Response listForcedSweepRequests(opts)
|
|
2578
|
+
|
|
2579
|
+
List forced sweeps
|
|
2580
|
+
|
|
2581
|
+
<Warning>This operation has been deprecated.</Warning> This operation retrieves the information of all forced sweeps.
|
|
2582
|
+
|
|
2583
|
+
### Example
|
|
2584
|
+
|
|
2585
|
+
```javascript
|
|
2586
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2587
|
+
// Initialize the API client
|
|
2588
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2589
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2590
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2591
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2592
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2593
|
+
// Call the API
|
|
2594
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2595
|
+
const opts = {
|
|
2596
|
+
'limit': 10,
|
|
2597
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2598
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2599
|
+
'request_id': "random_request_id"
|
|
2600
|
+
};
|
|
2601
|
+
apiInstance.listForcedSweepRequests(opts).then((data) => {
|
|
2602
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2603
|
+
}, (error) => {
|
|
2604
|
+
console.error(error);
|
|
2605
|
+
});
|
|
2606
|
+
|
|
2607
|
+
```
|
|
2608
|
+
|
|
2609
|
+
### Parameters
|
|
2610
|
+
|
|
2611
|
+
|
|
2612
|
+
Name | Type | Description | Notes
|
|
2613
|
+
------------- | ------------- | ------------- | -------------
|
|
2614
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2615
|
+
**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]
|
|
2616
|
+
**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]
|
|
2617
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
2618
|
+
|
|
2619
|
+
### Return type
|
|
2620
|
+
|
|
2621
|
+
[**ListForcedSweepRequests200Response**](ListForcedSweepRequests200Response.md)
|
|
2622
|
+
|
|
2623
|
+
### Authorization
|
|
2624
|
+
|
|
2625
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2626
|
+
|
|
2627
|
+
### HTTP request headers
|
|
2628
|
+
|
|
2629
|
+
- **Content-Type**: Not defined
|
|
2630
|
+
- **Accept**: application/json
|
|
2631
|
+
|
|
2632
|
+
|
|
2633
|
+
## listMerchantBalances
|
|
2634
|
+
|
|
2635
|
+
> ListMerchantBalances200Response listMerchantBalances(token_id, opts)
|
|
2636
|
+
|
|
2637
|
+
List merchant balances
|
|
2638
|
+
|
|
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 [Funds allocation and balances](https://www.cobo.com/payments/en/guides/amounts-and-balances).
|
|
2640
|
+
|
|
2641
|
+
### Example
|
|
2642
|
+
|
|
2643
|
+
```javascript
|
|
2644
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2645
|
+
// Initialize the API client
|
|
2646
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2647
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2648
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2649
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2650
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2651
|
+
// Call the API
|
|
2652
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2653
|
+
const token_id = "ETH_USDT";
|
|
2654
|
+
const opts = {
|
|
2655
|
+
'merchant_ids': "M1001,M1002,M1003",
|
|
2656
|
+
'acquiring_type': new CoboWaas2.AcquiringType()
|
|
2657
|
+
};
|
|
2658
|
+
apiInstance.listMerchantBalances(token_id, opts).then((data) => {
|
|
2659
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2660
|
+
}, (error) => {
|
|
2661
|
+
console.error(error);
|
|
2662
|
+
});
|
|
2663
|
+
|
|
2664
|
+
```
|
|
2665
|
+
|
|
2666
|
+
### Parameters
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
Name | Type | Description | Notes
|
|
2670
|
+
------------- | ------------- | ------------- | -------------
|
|
2671
|
+
**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
|
+
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
2673
|
+
**acquiring_type** | [**AcquiringType**](.md)| | [optional]
|
|
2674
|
+
|
|
2675
|
+
### Return type
|
|
2676
|
+
|
|
2677
|
+
[**ListMerchantBalances200Response**](ListMerchantBalances200Response.md)
|
|
2678
|
+
|
|
2679
|
+
### Authorization
|
|
2680
|
+
|
|
2681
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2682
|
+
|
|
2683
|
+
### HTTP request headers
|
|
2684
|
+
|
|
2685
|
+
- **Content-Type**: Not defined
|
|
2686
|
+
- **Accept**: application/json
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
## listMerchants
|
|
2690
|
+
|
|
2691
|
+
> ListMerchants200Response listMerchants(opts)
|
|
2692
|
+
|
|
2693
|
+
List all merchants
|
|
2694
|
+
|
|
2695
|
+
This operation retrieves the information of all merchants. You can filter the results by using a keyword for fuzzy search on merchant names or by specifying a wallet ID.
|
|
2696
|
+
|
|
2697
|
+
### Example
|
|
2698
|
+
|
|
2699
|
+
```javascript
|
|
2700
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2701
|
+
// Initialize the API client
|
|
2702
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2703
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2704
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2705
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2706
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2707
|
+
// Call the API
|
|
2708
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2709
|
+
const opts = {
|
|
2710
|
+
'limit': 10,
|
|
2711
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2712
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2713
|
+
'keyword': "keyword",
|
|
2714
|
+
'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
2715
|
+
'wallet_setup': new CoboWaas2.WalletSetup()
|
|
2716
|
+
};
|
|
2717
|
+
apiInstance.listMerchants(opts).then((data) => {
|
|
2718
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2719
|
+
}, (error) => {
|
|
2720
|
+
console.error(error);
|
|
2721
|
+
});
|
|
2722
|
+
|
|
2723
|
+
```
|
|
2724
|
+
|
|
2725
|
+
### Parameters
|
|
2726
|
+
|
|
2727
|
+
|
|
2728
|
+
Name | Type | Description | Notes
|
|
2729
|
+
------------- | ------------- | ------------- | -------------
|
|
2730
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2731
|
+
**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
|
+
**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 used for fuzzy matching of merchant names. | [optional]
|
|
2734
|
+
**wallet_id** | **String**| This parameter has been deprecated. | [optional]
|
|
2735
|
+
**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
|
+
|
|
2737
|
+
### Return type
|
|
2738
|
+
|
|
2739
|
+
[**ListMerchants200Response**](ListMerchants200Response.md)
|
|
2740
|
+
|
|
2741
|
+
### Authorization
|
|
2742
|
+
|
|
2743
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2744
|
+
|
|
2745
|
+
### HTTP request headers
|
|
2746
|
+
|
|
2747
|
+
- **Content-Type**: Not defined
|
|
2748
|
+
- **Accept**: application/json
|
|
2749
|
+
|
|
2750
|
+
|
|
2751
|
+
## listPaymentOrders
|
|
2752
|
+
|
|
2753
|
+
> ListPaymentOrders200Response listPaymentOrders(opts)
|
|
2754
|
+
|
|
2755
|
+
List all pay-in orders
|
|
2756
|
+
|
|
2757
|
+
This operation retrieves the information of all pay-in orders. You can filter the result by merchant ID.
|
|
2758
|
+
|
|
2759
|
+
### Example
|
|
2760
|
+
|
|
2761
|
+
```javascript
|
|
2762
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2763
|
+
// Initialize the API client
|
|
2764
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2765
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2766
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2767
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2768
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2769
|
+
// Call the API
|
|
2770
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2771
|
+
const opts = {
|
|
2772
|
+
'limit': 10,
|
|
2773
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2774
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2775
|
+
'merchant_id': "M1001",
|
|
2776
|
+
'psp_order_id': "P20240201001",
|
|
2777
|
+
'statuses': "Pending,Processing"
|
|
2778
|
+
};
|
|
2779
|
+
apiInstance.listPaymentOrders(opts).then((data) => {
|
|
2780
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2781
|
+
}, (error) => {
|
|
2782
|
+
console.error(error);
|
|
2783
|
+
});
|
|
2784
|
+
|
|
2785
|
+
```
|
|
2786
|
+
|
|
2787
|
+
### Parameters
|
|
2788
|
+
|
|
2789
|
+
|
|
2790
|
+
Name | Type | Description | Notes
|
|
2791
|
+
------------- | ------------- | ------------- | -------------
|
|
2792
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2793
|
+
**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]
|
|
2794
|
+
**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
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
2796
|
+
**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 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]
|
|
2798
|
+
|
|
2799
|
+
### Return type
|
|
2800
|
+
|
|
2801
|
+
[**ListPaymentOrders200Response**](ListPaymentOrders200Response.md)
|
|
2802
|
+
|
|
2803
|
+
### Authorization
|
|
2804
|
+
|
|
2805
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2806
|
+
|
|
2807
|
+
### HTTP request headers
|
|
2808
|
+
|
|
2809
|
+
- **Content-Type**: Not defined
|
|
2810
|
+
- **Accept**: application/json
|
|
2811
|
+
|
|
2812
|
+
|
|
2813
|
+
## listPaymentSupportedTokens
|
|
2814
|
+
|
|
2815
|
+
> [SupportedToken] listPaymentSupportedTokens()
|
|
2816
|
+
|
|
2817
|
+
List all supported tokens
|
|
2818
|
+
|
|
2819
|
+
This operation retrieves the information of all supported tokens.
|
|
2820
|
+
|
|
2821
|
+
### Example
|
|
2822
|
+
|
|
2823
|
+
```javascript
|
|
2824
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2825
|
+
// Initialize the API client
|
|
2826
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2827
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2828
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2829
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2830
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2831
|
+
// Call the API
|
|
2832
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2833
|
+
apiInstance.listPaymentSupportedTokens().then((data) => {
|
|
2834
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2835
|
+
}, (error) => {
|
|
2836
|
+
console.error(error);
|
|
2837
|
+
});
|
|
2838
|
+
|
|
2839
|
+
```
|
|
2840
|
+
|
|
2841
|
+
### Parameters
|
|
2842
|
+
|
|
2843
|
+
This endpoint does not need any parameter.
|
|
2844
|
+
|
|
2845
|
+
### Return type
|
|
2846
|
+
|
|
2847
|
+
[**[SupportedToken]**](SupportedToken.md)
|
|
2848
|
+
|
|
2849
|
+
### Authorization
|
|
2850
|
+
|
|
2851
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2852
|
+
|
|
2853
|
+
### HTTP request headers
|
|
2854
|
+
|
|
2855
|
+
- **Content-Type**: Not defined
|
|
2856
|
+
- **Accept**: application/json
|
|
2857
|
+
|
|
2858
|
+
|
|
2859
|
+
## listPaymentWalletBalances
|
|
2860
|
+
|
|
2861
|
+
> ListPaymentWalletBalances200Response listPaymentWalletBalances(token_id, opts)
|
|
2862
|
+
|
|
2863
|
+
List payment wallet balances
|
|
2864
|
+
|
|
2865
|
+
<Warning>This operation has been deprecated.</Warning> This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the `wallet_ids` parameter, the balance information for all payment wallets will be returned.
|
|
2866
|
+
|
|
2867
|
+
### Example
|
|
2868
|
+
|
|
2869
|
+
```javascript
|
|
2870
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2871
|
+
// Initialize the API client
|
|
2872
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2873
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2874
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2875
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2876
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2877
|
+
// Call the API
|
|
2878
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2879
|
+
const token_id = "ETH_USDT";
|
|
2880
|
+
const opts = {
|
|
2881
|
+
'wallet_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,f47ac10b-58cc-4372-a567-0e02b2c3d472"
|
|
2882
|
+
};
|
|
2883
|
+
apiInstance.listPaymentWalletBalances(token_id, opts).then((data) => {
|
|
2884
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2885
|
+
}, (error) => {
|
|
2886
|
+
console.error(error);
|
|
2887
|
+
});
|
|
2888
|
+
|
|
2889
|
+
```
|
|
2890
|
+
|
|
2891
|
+
### Parameters
|
|
2892
|
+
|
|
2893
|
+
|
|
2894
|
+
Name | Type | Description | Notes
|
|
2895
|
+
------------- | ------------- | ------------- | -------------
|
|
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` |
|
|
2897
|
+
**wallet_ids** | **String**| A list of wallet IDs to query. | [optional]
|
|
2898
|
+
|
|
2899
|
+
### Return type
|
|
2900
|
+
|
|
2901
|
+
[**ListPaymentWalletBalances200Response**](ListPaymentWalletBalances200Response.md)
|
|
2902
|
+
|
|
2903
|
+
### Authorization
|
|
2904
|
+
|
|
2905
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2906
|
+
|
|
2907
|
+
### HTTP request headers
|
|
2908
|
+
|
|
2909
|
+
- **Content-Type**: Not defined
|
|
2910
|
+
- **Accept**: application/json
|
|
2911
|
+
|
|
2912
|
+
|
|
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
|
+
## listPayouts
|
|
2974
|
+
|
|
2975
|
+
> ListPayouts200Response listPayouts(opts)
|
|
2976
|
+
|
|
2977
|
+
List all payouts
|
|
2978
|
+
|
|
2979
|
+
This operation retrieves the information of all payouts.
|
|
2980
|
+
|
|
2981
|
+
### Example
|
|
2982
|
+
|
|
2983
|
+
```javascript
|
|
2984
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2985
|
+
// Initialize the API client
|
|
2986
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
2987
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2988
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2989
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2990
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2991
|
+
// Call the API
|
|
2992
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2993
|
+
const opts = {
|
|
2994
|
+
'limit': 10,
|
|
2995
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2996
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2997
|
+
'request_id': "random_request_id"
|
|
2998
|
+
};
|
|
2999
|
+
apiInstance.listPayouts(opts).then((data) => {
|
|
3000
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3001
|
+
}, (error) => {
|
|
3002
|
+
console.error(error);
|
|
3003
|
+
});
|
|
3004
|
+
|
|
3005
|
+
```
|
|
3006
|
+
|
|
3007
|
+
### Parameters
|
|
3008
|
+
|
|
3009
|
+
|
|
3010
|
+
Name | Type | Description | Notes
|
|
3011
|
+
------------- | ------------- | ------------- | -------------
|
|
3012
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3013
|
+
**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]
|
|
3014
|
+
**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]
|
|
3015
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
3016
|
+
|
|
3017
|
+
### Return type
|
|
3018
|
+
|
|
3019
|
+
[**ListPayouts200Response**](ListPayouts200Response.md)
|
|
3020
|
+
|
|
3021
|
+
### Authorization
|
|
3022
|
+
|
|
3023
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3024
|
+
|
|
3025
|
+
### HTTP request headers
|
|
3026
|
+
|
|
3027
|
+
- **Content-Type**: Not defined
|
|
3028
|
+
- **Accept**: application/json
|
|
3029
|
+
|
|
3030
|
+
|
|
3031
|
+
## listSettlementDetails
|
|
3032
|
+
|
|
3033
|
+
> ListSettlementDetails200Response listSettlementDetails(opts)
|
|
3034
|
+
|
|
3035
|
+
List all settlement details
|
|
3036
|
+
|
|
3037
|
+
This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status.
|
|
3038
|
+
|
|
3039
|
+
### Example
|
|
3040
|
+
|
|
3041
|
+
```javascript
|
|
3042
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3043
|
+
// Initialize the API client
|
|
3044
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3045
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3046
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3047
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3048
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3049
|
+
// Call the API
|
|
3050
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3051
|
+
const opts = {
|
|
3052
|
+
'limit': 10,
|
|
3053
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3054
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3055
|
+
'merchant_id': "M1001",
|
|
3056
|
+
'statuses': "Pending,Processing"
|
|
3057
|
+
};
|
|
3058
|
+
apiInstance.listSettlementDetails(opts).then((data) => {
|
|
3059
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3060
|
+
}, (error) => {
|
|
3061
|
+
console.error(error);
|
|
3062
|
+
});
|
|
3063
|
+
|
|
3064
|
+
```
|
|
3065
|
+
|
|
3066
|
+
### Parameters
|
|
3067
|
+
|
|
3068
|
+
|
|
3069
|
+
Name | Type | Description | Notes
|
|
3070
|
+
------------- | ------------- | ------------- | -------------
|
|
3071
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3072
|
+
**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
|
+
**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
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
3075
|
+
**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]
|
|
3076
|
+
|
|
3077
|
+
### Return type
|
|
3078
|
+
|
|
3079
|
+
[**ListSettlementDetails200Response**](ListSettlementDetails200Response.md)
|
|
3080
|
+
|
|
3081
|
+
### Authorization
|
|
3082
|
+
|
|
3083
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3084
|
+
|
|
3085
|
+
### HTTP request headers
|
|
3086
|
+
|
|
3087
|
+
- **Content-Type**: Not defined
|
|
3088
|
+
- **Accept**: application/json
|
|
3089
|
+
|
|
3090
|
+
|
|
3091
|
+
## listSettlementRequests
|
|
3092
|
+
|
|
3093
|
+
> ListSettlementRequests200Response listSettlementRequests(opts)
|
|
3094
|
+
|
|
3095
|
+
List all settlement requests
|
|
3096
|
+
|
|
3097
|
+
This operation retrieves the information of all settlement requests.
|
|
3098
|
+
|
|
3099
|
+
### Example
|
|
3100
|
+
|
|
3101
|
+
```javascript
|
|
3102
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3103
|
+
// Initialize the API client
|
|
3104
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3105
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3106
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3107
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3108
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3109
|
+
// Call the API
|
|
3110
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3111
|
+
const opts = {
|
|
3112
|
+
'limit': 10,
|
|
3113
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3114
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3115
|
+
'request_id': "random_request_id"
|
|
3116
|
+
};
|
|
3117
|
+
apiInstance.listSettlementRequests(opts).then((data) => {
|
|
3118
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3119
|
+
}, (error) => {
|
|
3120
|
+
console.error(error);
|
|
3121
|
+
});
|
|
3122
|
+
|
|
3123
|
+
```
|
|
3124
|
+
|
|
3125
|
+
### Parameters
|
|
3126
|
+
|
|
3127
|
+
|
|
3128
|
+
Name | Type | Description | Notes
|
|
3129
|
+
------------- | ------------- | ------------- | -------------
|
|
3130
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3131
|
+
**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]
|
|
3132
|
+
**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]
|
|
3133
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
3134
|
+
|
|
3135
|
+
### Return type
|
|
3136
|
+
|
|
3137
|
+
[**ListSettlementRequests200Response**](ListSettlementRequests200Response.md)
|
|
3138
|
+
|
|
3139
|
+
### Authorization
|
|
3140
|
+
|
|
3141
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3142
|
+
|
|
3143
|
+
### HTTP request headers
|
|
3144
|
+
|
|
3145
|
+
- **Content-Type**: Not defined
|
|
3146
|
+
- **Accept**: application/json
|
|
3147
|
+
|
|
3148
|
+
|
|
3149
|
+
## listTopUpPayerAccounts
|
|
3150
|
+
|
|
3151
|
+
> ListTopUpPayerAccounts200Response listTopUpPayerAccounts(opts)
|
|
3152
|
+
|
|
3153
|
+
List top-up payer accounts
|
|
3154
|
+
|
|
3155
|
+
This operation retrieves the accounts of all payers. You can filter the result by merchant ID and payer_id.
|
|
3156
|
+
|
|
3157
|
+
### Example
|
|
3158
|
+
|
|
3159
|
+
```javascript
|
|
3160
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3161
|
+
// Initialize the API client
|
|
3162
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3163
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3164
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3165
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3166
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3167
|
+
// Call the API
|
|
3168
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3169
|
+
const opts = {
|
|
3170
|
+
'limit': 10,
|
|
3171
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3172
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3173
|
+
'merchant_id': "M1001",
|
|
3174
|
+
'payer_id': "P20250619T0310056d7aa"
|
|
3175
|
+
};
|
|
3176
|
+
apiInstance.listTopUpPayerAccounts(opts).then((data) => {
|
|
3177
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3178
|
+
}, (error) => {
|
|
3179
|
+
console.error(error);
|
|
3180
|
+
});
|
|
3181
|
+
|
|
3182
|
+
```
|
|
3183
|
+
|
|
3184
|
+
### Parameters
|
|
3185
|
+
|
|
3186
|
+
|
|
3187
|
+
Name | Type | Description | Notes
|
|
3188
|
+
------------- | ------------- | ------------- | -------------
|
|
3189
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3190
|
+
**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]
|
|
3191
|
+
**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]
|
|
3192
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
3193
|
+
**payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
3194
|
+
|
|
3195
|
+
### Return type
|
|
3196
|
+
|
|
3197
|
+
[**ListTopUpPayerAccounts200Response**](ListTopUpPayerAccounts200Response.md)
|
|
3198
|
+
|
|
3199
|
+
### Authorization
|
|
3200
|
+
|
|
3201
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3202
|
+
|
|
3203
|
+
### HTTP request headers
|
|
3204
|
+
|
|
3205
|
+
- **Content-Type**: Not defined
|
|
3206
|
+
- **Accept**: application/json
|
|
3207
|
+
|
|
3208
|
+
|
|
3209
|
+
## listTopUpPayers
|
|
3210
|
+
|
|
3211
|
+
> ListTopUpPayers200Response listTopUpPayers(opts)
|
|
3212
|
+
|
|
3213
|
+
List payers
|
|
3214
|
+
|
|
3215
|
+
This operation retrieves the information of all payers under a merchant. You can filter the result by the payer ID.
|
|
3216
|
+
|
|
3217
|
+
### Example
|
|
3218
|
+
|
|
3219
|
+
```javascript
|
|
3220
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3221
|
+
// Initialize the API client
|
|
3222
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3223
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3224
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3225
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3226
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3227
|
+
// Call the API
|
|
3228
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3229
|
+
const opts = {
|
|
3230
|
+
'limit': 10,
|
|
3231
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3232
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3233
|
+
'merchant_id': "M1001",
|
|
3234
|
+
'payer_id': "P20250619T0310056d7aa"
|
|
3235
|
+
};
|
|
3236
|
+
apiInstance.listTopUpPayers(opts).then((data) => {
|
|
3237
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3238
|
+
}, (error) => {
|
|
3239
|
+
console.error(error);
|
|
3240
|
+
});
|
|
3241
|
+
|
|
3242
|
+
```
|
|
3243
|
+
|
|
3244
|
+
### Parameters
|
|
3245
|
+
|
|
3246
|
+
|
|
3247
|
+
Name | Type | Description | Notes
|
|
3248
|
+
------------- | ------------- | ------------- | -------------
|
|
3249
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3250
|
+
**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]
|
|
3251
|
+
**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]
|
|
3252
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
3253
|
+
**payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
3254
|
+
|
|
3255
|
+
### Return type
|
|
3256
|
+
|
|
3257
|
+
[**ListTopUpPayers200Response**](ListTopUpPayers200Response.md)
|
|
3258
|
+
|
|
3259
|
+
### Authorization
|
|
3260
|
+
|
|
3261
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3262
|
+
|
|
3263
|
+
### HTTP request headers
|
|
3264
|
+
|
|
3265
|
+
- **Content-Type**: Not defined
|
|
3266
|
+
- **Accept**: application/json
|
|
3267
|
+
|
|
3268
|
+
|
|
3269
|
+
## paymentEstimateFee
|
|
3270
|
+
|
|
3271
|
+
> PaymentEstimateFee201Response paymentEstimateFee(opts)
|
|
3272
|
+
|
|
3273
|
+
Estimate fees
|
|
3274
|
+
|
|
3275
|
+
This operation calculates fees for payment-related operations, including: - **Pay-in**: Fees for accepting payments - **Refunds**: Fees for refunding the payment - **Crypto payouts**: Fees for payouts in crypto - **Fiat off-ramp**: Fees for fiat currency transfers via off-ramp. The returned fees represent the charges that would apply if the operation were executed immediately. Note that actual fees may vary over time based on your usage volume and applicable fee rates.
|
|
3276
|
+
|
|
3277
|
+
### Example
|
|
3278
|
+
|
|
3279
|
+
```javascript
|
|
3280
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3281
|
+
// Initialize the API client
|
|
3282
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3283
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3284
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3285
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3286
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3287
|
+
// Call the API
|
|
3288
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3289
|
+
const opts = {
|
|
3290
|
+
'PaymentEstimateFeeRequest': new CoboWaas2.PaymentEstimateFeeRequest()
|
|
3291
|
+
};
|
|
3292
|
+
apiInstance.paymentEstimateFee(opts).then((data) => {
|
|
3293
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3294
|
+
}, (error) => {
|
|
3295
|
+
console.error(error);
|
|
3296
|
+
});
|
|
3297
|
+
|
|
3298
|
+
```
|
|
3299
|
+
|
|
3300
|
+
### Parameters
|
|
3301
|
+
|
|
3302
|
+
|
|
3303
|
+
Name | Type | Description | Notes
|
|
3304
|
+
------------- | ------------- | ------------- | -------------
|
|
3305
|
+
**PaymentEstimateFeeRequest** | [**PaymentEstimateFeeRequest**](PaymentEstimateFeeRequest.md)| The request body for fee estimation. | [optional]
|
|
3306
|
+
|
|
3307
|
+
### Return type
|
|
3308
|
+
|
|
3309
|
+
[**PaymentEstimateFee201Response**](PaymentEstimateFee201Response.md)
|
|
3310
|
+
|
|
3311
|
+
### Authorization
|
|
3312
|
+
|
|
3313
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3314
|
+
|
|
3315
|
+
### HTTP request headers
|
|
3316
|
+
|
|
3317
|
+
- **Content-Type**: application/json
|
|
3318
|
+
- **Accept**: application/json
|
|
3319
|
+
|
|
3320
|
+
|
|
3321
|
+
## queryDestinationWhitelistEnabled
|
|
3322
|
+
|
|
3323
|
+
> QueryDestinationWhitelistEnabled200Response queryDestinationWhitelistEnabled()
|
|
3324
|
+
|
|
3325
|
+
Query destination whitelist enabled status
|
|
3326
|
+
|
|
3327
|
+
This operation retrieves the information of whether the destination whitelist is enabled.
|
|
3328
|
+
|
|
3329
|
+
### Example
|
|
3330
|
+
|
|
3331
|
+
```javascript
|
|
3332
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3333
|
+
// Initialize the API client
|
|
3334
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3335
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3336
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3337
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3338
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3339
|
+
// Call the API
|
|
3340
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3341
|
+
apiInstance.queryDestinationWhitelistEnabled().then((data) => {
|
|
3342
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3343
|
+
}, (error) => {
|
|
3344
|
+
console.error(error);
|
|
3345
|
+
});
|
|
3346
|
+
|
|
3347
|
+
```
|
|
3348
|
+
|
|
3349
|
+
### Parameters
|
|
3350
|
+
|
|
3351
|
+
This endpoint does not need any parameter.
|
|
3352
|
+
|
|
3353
|
+
### Return type
|
|
3354
|
+
|
|
3355
|
+
[**QueryDestinationWhitelistEnabled200Response**](QueryDestinationWhitelistEnabled200Response.md)
|
|
3356
|
+
|
|
3357
|
+
### Authorization
|
|
3358
|
+
|
|
3359
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3360
|
+
|
|
3361
|
+
### HTTP request headers
|
|
3362
|
+
|
|
3363
|
+
- **Content-Type**: Not defined
|
|
3364
|
+
- **Accept**: application/json
|
|
3365
|
+
|
|
3366
|
+
|
|
3367
|
+
## updateBankAccountById
|
|
3368
|
+
|
|
3369
|
+
> BankAccount updateBankAccountById(bank_account_id, opts)
|
|
3370
|
+
|
|
3371
|
+
Update bank account
|
|
3372
|
+
|
|
3373
|
+
This operation updates the information of an existing bank account.
|
|
3374
|
+
|
|
3375
|
+
### Example
|
|
3376
|
+
|
|
3377
|
+
```javascript
|
|
3378
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3379
|
+
// Initialize the API client
|
|
3380
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3381
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3382
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3383
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3384
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3385
|
+
// Call the API
|
|
3386
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3387
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
3388
|
+
const opts = {
|
|
3389
|
+
'UpdateBankAccountByIdRequest': new CoboWaas2.UpdateBankAccountByIdRequest()
|
|
3390
|
+
};
|
|
3391
|
+
apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
|
|
3392
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3393
|
+
}, (error) => {
|
|
3394
|
+
console.error(error);
|
|
3395
|
+
});
|
|
3396
|
+
|
|
3397
|
+
```
|
|
3398
|
+
|
|
3399
|
+
### Parameters
|
|
3400
|
+
|
|
3401
|
+
|
|
3402
|
+
Name | Type | Description | Notes
|
|
3403
|
+
------------- | ------------- | ------------- | -------------
|
|
3404
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
3405
|
+
**UpdateBankAccountByIdRequest** | [**UpdateBankAccountByIdRequest**](UpdateBankAccountByIdRequest.md)| The request body for updating an existing bank account. | [optional]
|
|
3406
|
+
|
|
3407
|
+
### Return type
|
|
3408
|
+
|
|
3409
|
+
[**BankAccount**](BankAccount.md)
|
|
3410
|
+
|
|
3411
|
+
### Authorization
|
|
3412
|
+
|
|
3413
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3414
|
+
|
|
3415
|
+
### HTTP request headers
|
|
3416
|
+
|
|
3417
|
+
- **Content-Type**: application/json
|
|
3418
|
+
- **Accept**: application/json
|
|
3419
|
+
|
|
3420
|
+
|
|
3421
|
+
## updateCounterpartyById
|
|
3422
|
+
|
|
3423
|
+
> Counterparty updateCounterpartyById(counterparty_id, opts)
|
|
3424
|
+
|
|
3425
|
+
Update counterparty
|
|
3426
|
+
|
|
3427
|
+
This operation updates the information of a specified counterparty.
|
|
3428
|
+
|
|
3429
|
+
### Example
|
|
3430
|
+
|
|
3431
|
+
```javascript
|
|
3432
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3433
|
+
// Initialize the API client
|
|
3434
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3435
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3436
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3437
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3438
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3439
|
+
// Call the API
|
|
3440
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3441
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
3442
|
+
const opts = {
|
|
3443
|
+
'UpdateCounterpartyByIdRequest': new CoboWaas2.UpdateCounterpartyByIdRequest()
|
|
3444
|
+
};
|
|
3445
|
+
apiInstance.updateCounterpartyById(counterparty_id, opts).then((data) => {
|
|
3446
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3447
|
+
}, (error) => {
|
|
3448
|
+
console.error(error);
|
|
3449
|
+
});
|
|
3450
|
+
|
|
3451
|
+
```
|
|
3452
|
+
|
|
3453
|
+
### Parameters
|
|
3454
|
+
|
|
3455
|
+
|
|
3456
|
+
Name | Type | Description | Notes
|
|
3457
|
+
------------- | ------------- | ------------- | -------------
|
|
3458
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
3459
|
+
**UpdateCounterpartyByIdRequest** | [**UpdateCounterpartyByIdRequest**](UpdateCounterpartyByIdRequest.md)| The request body to update a counterparty. | [optional]
|
|
3460
|
+
|
|
3461
|
+
### Return type
|
|
3462
|
+
|
|
3463
|
+
[**Counterparty**](Counterparty.md)
|
|
3464
|
+
|
|
3465
|
+
### Authorization
|
|
3466
|
+
|
|
3467
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3468
|
+
|
|
3469
|
+
### HTTP request headers
|
|
3470
|
+
|
|
3471
|
+
- **Content-Type**: application/json
|
|
3472
|
+
- **Accept**: application/json
|
|
3473
|
+
|
|
3474
|
+
|
|
3475
|
+
## updateDestinationBankAccountById
|
|
3476
|
+
|
|
3477
|
+
> DestinationBankAccount updateDestinationBankAccountById(bank_account_id, opts)
|
|
3478
|
+
|
|
3479
|
+
Update destination bank account
|
|
3480
|
+
|
|
3481
|
+
This operation updates the information of a specified destination bank account.
|
|
3482
|
+
|
|
3483
|
+
### Example
|
|
3484
|
+
|
|
3485
|
+
```javascript
|
|
3486
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3487
|
+
// Initialize the API client
|
|
3488
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3489
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3490
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3491
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3492
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3493
|
+
// Call the API
|
|
3494
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3495
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
3496
|
+
const opts = {
|
|
3497
|
+
'UpdateDestinationBankAccount': new CoboWaas2.UpdateDestinationBankAccount()
|
|
3498
|
+
};
|
|
3499
|
+
apiInstance.updateDestinationBankAccountById(bank_account_id, opts).then((data) => {
|
|
3500
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3501
|
+
}, (error) => {
|
|
3502
|
+
console.error(error);
|
|
3503
|
+
});
|
|
3504
|
+
|
|
3505
|
+
```
|
|
3506
|
+
|
|
3507
|
+
### Parameters
|
|
3508
|
+
|
|
3509
|
+
|
|
3510
|
+
Name | Type | Description | Notes
|
|
3511
|
+
------------- | ------------- | ------------- | -------------
|
|
3512
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
3513
|
+
**UpdateDestinationBankAccount** | [**UpdateDestinationBankAccount**](UpdateDestinationBankAccount.md)| The request body to update a destination bank account. | [optional]
|
|
3514
|
+
|
|
3515
|
+
### Return type
|
|
3516
|
+
|
|
3517
|
+
[**DestinationBankAccount**](DestinationBankAccount.md)
|
|
3518
|
+
|
|
3519
|
+
### Authorization
|
|
3520
|
+
|
|
3521
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3522
|
+
|
|
3523
|
+
### HTTP request headers
|
|
3524
|
+
|
|
3525
|
+
- **Content-Type**: application/json
|
|
3526
|
+
- **Accept**: application/json
|
|
3527
|
+
|
|
3528
|
+
|
|
3529
|
+
## updateDestinationById
|
|
3530
|
+
|
|
3531
|
+
> Destination updateDestinationById(destination_id, opts)
|
|
3532
|
+
|
|
3533
|
+
Update destination
|
|
3534
|
+
|
|
3535
|
+
This operation updates the information of a specified destination.
|
|
3536
|
+
|
|
3537
|
+
### Example
|
|
3538
|
+
|
|
3539
|
+
```javascript
|
|
3540
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3541
|
+
// Initialize the API client
|
|
3542
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3543
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3544
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3545
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3546
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3547
|
+
// Call the API
|
|
3548
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3549
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
3550
|
+
const opts = {
|
|
3551
|
+
'UpdateDestinationByIdRequest': new CoboWaas2.UpdateDestinationByIdRequest()
|
|
3552
|
+
};
|
|
3553
|
+
apiInstance.updateDestinationById(destination_id, opts).then((data) => {
|
|
3554
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3555
|
+
}, (error) => {
|
|
3556
|
+
console.error(error);
|
|
3557
|
+
});
|
|
3558
|
+
|
|
3559
|
+
```
|
|
3560
|
+
|
|
3561
|
+
### Parameters
|
|
3562
|
+
|
|
3563
|
+
|
|
3564
|
+
Name | Type | Description | Notes
|
|
3565
|
+
------------- | ------------- | ------------- | -------------
|
|
3566
|
+
**destination_id** | **String**| The destination ID. |
|
|
3567
|
+
**UpdateDestinationByIdRequest** | [**UpdateDestinationByIdRequest**](UpdateDestinationByIdRequest.md)| The request body to create a destination. | [optional]
|
|
3568
|
+
|
|
3569
|
+
### Return type
|
|
3570
|
+
|
|
3571
|
+
[**Destination**](Destination.md)
|
|
1814
3572
|
|
|
1815
3573
|
### Authorization
|
|
1816
3574
|
|