@cobo/cobo-waas2 1.20.0 → 1.22.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 +60 -4
- package/dist/ApiClient.js +11 -2
- package/dist/PreRequestScript.js +2 -4
- package/dist/api/AutoSweepApi.js +289 -0
- package/dist/api/PaymentApi.js +386 -24
- package/dist/api/TokenizationApi.js +1024 -0
- package/dist/api/TransactionsApi.js +103 -2
- package/dist/api/WalletsApi.js +2 -2
- package/dist/crypto/ApiSigner.js +5 -1
- package/dist/index.js +175 -0
- package/dist/model/AddressesEventData.js +3 -3
- package/dist/model/ApprovalDetail.js +7 -7
- package/dist/model/AutoSweepTask.js +198 -0
- package/dist/model/AutoSweepTaskStatus.js +61 -0
- package/dist/model/BalanceUpdateInfoEventData.js +3 -3
- package/dist/model/ChainsEventData.js +3 -3
- package/dist/model/CreateAutoSweepTask.js +126 -0
- package/dist/model/CreateCryptoAddressRequest.js +138 -0
- package/dist/model/CreateCustodialWalletParams.js +9 -0
- package/dist/model/CreateExchangeWalletParams.js +14 -0
- package/dist/model/CreateMpcWalletParams.js +14 -0
- package/dist/model/CreatePaymentOrderRequest.js +5 -5
- package/dist/model/CreateSafeWalletParams.js +9 -0
- package/dist/model/CreateSettlement.js +27 -4
- package/dist/model/CreateSmartContractWalletParams.js +6 -0
- package/dist/model/CreateSweepToAddress.js +126 -0
- package/dist/model/CreateWalletParams.js +6 -0
- package/dist/model/CreatedWalletInfo.js +6 -0
- package/dist/model/CryptoAddress.js +12 -12
- package/dist/model/CustodialWalletInfo.js +9 -0
- package/dist/model/DeleteCryptoAddress201Response.js +110 -0
- package/dist/model/ExchangeWalletInfo.js +14 -0
- package/dist/model/ForcedSweep.js +9 -9
- package/dist/model/ForcedSweepRequest.js +8 -9
- package/dist/model/GetTokenizationAllowlistActivation200Response.js +107 -0
- package/dist/model/ListAutoSweepTask200Response.js +123 -0
- package/dist/model/ListMerchantBalances200Response.js +107 -0
- package/dist/model/ListPaymentWalletBalances200Response.js +107 -0
- package/dist/model/ListSettlementDetails200Response.js +123 -0
- package/dist/model/ListTokenizationBlocklistAddresses200Response.js +145 -0
- package/dist/model/ListWalletSweepToAddresses200Response.js +107 -0
- package/dist/model/MPCVaultEventData.js +3 -3
- package/dist/model/MPCWalletInfo.js +14 -0
- package/dist/model/MerchantBalance.js +201 -0
- package/dist/model/PaymentAddressUpdateEventData.js +13 -13
- package/dist/model/PaymentOrderEventData.js +3 -3
- package/dist/model/PaymentRefundEventData.js +3 -3
- package/dist/model/PaymentSettlementEvent.js +42 -3
- package/dist/model/PaymentTransactionEventData.js +6 -6
- package/dist/model/PaymentWalletBalance.js +177 -0
- package/dist/model/PspBalance.js +175 -0
- package/dist/model/ReceivedAmountPerAddress.js +126 -0
- package/dist/model/SafeWallet.js +9 -0
- package/dist/model/Settlement.js +27 -0
- package/dist/model/SettlementDetail.js +26 -0
- package/dist/model/SettlementInfo.js +7 -7
- package/dist/model/SmartContractWalletInfo.js +6 -0
- package/dist/model/SuspendedTokenEventData.js +3 -3
- package/dist/model/SweepToAddress.js +135 -0
- package/dist/model/SweepToAddressStatus.js +61 -0
- package/dist/model/TSSRequestWebhookEventData.js +3 -3
- package/dist/model/TokenListingEventData.js +3 -3
- package/dist/model/TokenizationActivityInfo.js +8 -4
- package/dist/model/TokenizationAllowlistActivationRequest.js +13 -0
- package/dist/model/TokenizationAllowlistAddressNote.js +4 -4
- package/dist/model/TokenizationAllowlistAddressesResponse.js +145 -0
- package/dist/model/TokenizationBlocklistAddressNote.js +4 -4
- package/dist/model/TokenizationBurnEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationBurnTokenParamsBurnsInner.js +4 -4
- package/dist/model/TokenizationBurnTokenRequest.js +13 -0
- package/dist/model/TokenizationContractCallEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationContractCallParamsData.js +43 -9
- package/dist/model/TokenizationContractCallRequest.js +13 -0
- package/dist/model/TokenizationContractCallType.js +5 -0
- package/dist/model/TokenizationERC20TokenParams.js +4 -4
- package/dist/model/TokenizationEstimateFeeRequestOperationParams.js +6 -0
- package/dist/model/TokenizationEvmContractCallParams.js +2 -2
- package/dist/model/TokenizationIssueEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationIssueTokenParamsTokenParams.js +40 -12
- package/dist/model/TokenizationIssuedTokenRequest.js +14 -1
- package/dist/model/TokenizationMintEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationMintTokenRequest.js +13 -0
- package/dist/model/TokenizationMpcOperationSource.js +2 -2
- package/dist/model/TokenizationPauseEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationPauseTokenRequest.js +13 -0
- package/dist/model/TokenizationSOLTokenParams.js +173 -0
- package/dist/model/TokenizationSolContractCallParams.js +137 -0
- package/dist/model/TokenizationSolTokenPermissionParams.js +140 -0
- package/dist/model/TokenizationToggleAllowlistEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationTokenDetailInfo.js +6 -6
- package/dist/model/TokenizationTokenInfo.js +4 -4
- package/dist/model/TokenizationTokenOperationSource.js +1 -1
- package/dist/model/TokenizationTokenPermissionParams.js +1 -1
- package/dist/model/TokenizationTokenPermissionType.js +15 -0
- package/dist/model/TokenizationTokenStandard.js +5 -0
- package/dist/model/TokenizationUnpauseEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationUnpauseTokenRequest.js +13 -0
- package/dist/model/TokenizationUpdateAllowlistAddressesEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationUpdateAllowlistAddressesParamsAddressesInner.js +1 -1
- package/dist/model/TokenizationUpdateAllowlistAddressesRequest.js +13 -0
- package/dist/model/TokenizationUpdateBlocklistAddressesEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationUpdateBlocklistAddressesParamsAddressesInner.js +1 -1
- package/dist/model/TokenizationUpdateBlocklistAddressesRequest.js +13 -0
- package/dist/model/TokenizationWeb3OperationSource.js +2 -2
- package/dist/model/TokensEventData.js +3 -3
- package/dist/model/TopUpAddress.js +0 -1
- package/dist/model/TransactionWebhookEventData.js +3 -3
- package/dist/model/UpdateCustodialWalletParams.js +13 -6
- package/dist/model/UpdateMpcWalletParams.js +13 -6
- package/dist/model/UpdateTopUpAddress.js +3 -3
- package/dist/model/UpdateWalletParams.js +6 -0
- package/dist/model/WalletInfo.js +6 -0
- package/dist/model/WalletInfoEventData.js +3 -3
- package/dist/model/WebhookEventData.js +19 -7
- package/dist/model/WebhookEventDataType.js +2 -2
- package/docs/AddressesEventData.md +1 -1
- package/docs/ApprovalDetail.md +1 -1
- package/docs/AutoSweepApi.md +285 -0
- package/docs/AutoSweepTask.md +16 -0
- package/docs/AutoSweepTaskStatus.md +12 -0
- package/docs/BalanceUpdateInfoEventData.md +1 -1
- package/docs/ChainsEventData.md +1 -1
- package/docs/CreateAutoSweepTask.md +10 -0
- package/docs/CreateCryptoAddressRequest.md +11 -0
- package/docs/CreateCustodialWalletParams.md +1 -0
- package/docs/CreateExchangeWalletParams.md +1 -0
- package/docs/CreateMpcWalletParams.md +1 -0
- package/docs/CreatePaymentOrderRequest.md +3 -3
- package/docs/CreateSafeWalletParams.md +1 -0
- package/docs/CreateSettlement.md +1 -1
- package/docs/CreateSmartContractWalletParams.md +1 -0
- package/docs/CreateSweepToAddress.md +10 -0
- package/docs/CreateWalletParams.md +1 -0
- package/docs/CreatedWalletInfo.md +1 -0
- package/docs/CryptoAddress.md +1 -1
- package/docs/CustodialWalletInfo.md +1 -0
- package/docs/DeleteCryptoAddress201Response.md +9 -0
- package/docs/ExchangeWalletInfo.md +1 -0
- package/docs/ForcedSweep.md +7 -7
- package/docs/ForcedSweepRequest.md +4 -4
- package/docs/GetTokenizationAllowlistActivation200Response.md +9 -0
- package/docs/ListAutoSweepTask200Response.md +10 -0
- package/docs/ListMerchantBalances200Response.md +9 -0
- package/docs/ListPaymentWalletBalances200Response.md +9 -0
- package/docs/ListSettlementDetails200Response.md +10 -0
- package/docs/ListTokenizationBlocklistAddresses200Response.md +10 -0
- package/docs/ListWalletSweepToAddresses200Response.md +9 -0
- package/docs/MPCVaultEventData.md +1 -1
- package/docs/MPCWalletInfo.md +1 -0
- package/docs/MerchantBalance.md +16 -0
- package/docs/PaymentAddressUpdateEventData.md +6 -6
- package/docs/PaymentApi.md +403 -16
- package/docs/PaymentOrderEventData.md +1 -1
- package/docs/PaymentRefundEventData.md +1 -1
- package/docs/PaymentSettlementEvent.md +4 -1
- package/docs/PaymentTransactionEventData.md +4 -4
- package/docs/PaymentWalletBalance.md +14 -0
- package/docs/PspBalance.md +14 -0
- package/docs/ReceivedAmountPerAddress.md +10 -0
- package/docs/SafeWallet.md +1 -0
- package/docs/Settlement.md +3 -0
- package/docs/SettlementDetail.md +2 -0
- package/docs/SettlementInfo.md +6 -6
- package/docs/SmartContractWalletInfo.md +1 -0
- package/docs/SuspendedTokenEventData.md +1 -1
- package/docs/SweepToAddress.md +11 -0
- package/docs/SweepToAddressStatus.md +12 -0
- package/docs/TSSRequestWebhookEventData.md +1 -1
- package/docs/TokenListingEventData.md +1 -1
- package/docs/TokenizationActivityInfo.md +2 -2
- package/docs/TokenizationAllowlistActivationRequest.md +1 -0
- package/docs/TokenizationAllowlistAddressNote.md +3 -3
- package/docs/TokenizationAllowlistAddressesResponse.md +10 -0
- package/docs/TokenizationApi.md +1069 -0
- package/docs/TokenizationBlocklistAddressNote.md +3 -3
- package/docs/TokenizationBurnEstimateFeeParams.md +1 -0
- package/docs/TokenizationBurnTokenParamsBurnsInner.md +2 -2
- package/docs/TokenizationBurnTokenRequest.md +1 -0
- package/docs/TokenizationContractCallEstimateFeeParams.md +1 -0
- package/docs/TokenizationContractCallParamsData.md +2 -1
- package/docs/TokenizationContractCallRequest.md +1 -0
- package/docs/TokenizationContractCallType.md +2 -0
- package/docs/TokenizationERC20TokenParams.md +1 -1
- package/docs/TokenizationEstimateFeeRequestOperationParams.md +1 -0
- package/docs/TokenizationEvmContractCallParams.md +1 -1
- package/docs/TokenizationIssueEstimateFeeParams.md +1 -0
- package/docs/TokenizationIssueTokenParamsTokenParams.md +2 -2
- package/docs/TokenizationIssuedTokenRequest.md +2 -1
- package/docs/TokenizationMintEstimateFeeParams.md +1 -0
- package/docs/TokenizationMintTokenRequest.md +1 -0
- package/docs/TokenizationMpcOperationSource.md +1 -1
- package/docs/TokenizationPauseEstimateFeeParams.md +1 -0
- package/docs/TokenizationPauseTokenRequest.md +1 -0
- package/docs/TokenizationSOLTokenParams.md +14 -0
- package/docs/TokenizationSolContractCallParams.md +10 -0
- package/docs/TokenizationSolTokenPermissionParams.md +13 -0
- package/docs/TokenizationToggleAllowlistEstimateFeeParams.md +1 -0
- package/docs/TokenizationTokenDetailInfo.md +1 -1
- package/docs/TokenizationTokenInfo.md +1 -1
- package/docs/TokenizationTokenOperationSource.md +1 -1
- package/docs/TokenizationTokenPermissionType.md +6 -0
- package/docs/TokenizationTokenStandard.md +2 -0
- package/docs/TokenizationUnpauseEstimateFeeParams.md +1 -0
- package/docs/TokenizationUnpauseTokenRequest.md +1 -0
- package/docs/TokenizationUpdateAllowlistAddressesEstimateFeeParams.md +1 -0
- package/docs/TokenizationUpdateAllowlistAddressesParamsAddressesInner.md +1 -1
- package/docs/TokenizationUpdateAllowlistAddressesRequest.md +1 -0
- package/docs/TokenizationUpdateBlocklistAddressesEstimateFeeParams.md +1 -0
- package/docs/TokenizationUpdateBlocklistAddressesParamsAddressesInner.md +1 -1
- package/docs/TokenizationUpdateBlocklistAddressesRequest.md +1 -0
- package/docs/TokenizationWeb3OperationSource.md +1 -1
- package/docs/TokensEventData.md +1 -1
- package/docs/TransactionWebhookEventData.md +1 -1
- package/docs/TransactionsApi.md +113 -1
- package/docs/UpdateCustodialWalletParams.md +2 -1
- package/docs/UpdateMpcWalletParams.md +2 -1
- package/docs/UpdateTopUpAddress.md +1 -1
- package/docs/UpdateWalletParams.md +1 -0
- package/docs/WalletInfo.md +1 -0
- package/docs/WalletInfoEventData.md +1 -1
- package/docs/WalletsApi.md +1 -1
- package/docs/WebhookEventData.md +9 -7
- package/docs/WebhookEventDataType.md +1 -1
- package/package.json +1 -1
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
8
|
**vault_id** | **String** | The vault ID. | [optional]
|
|
9
9
|
**project_id** | **String** | The project ID. | [optional]
|
|
10
10
|
**name** | **String** | The vault name. | [optional]
|
package/docs/MPCWalletInfo.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
10
|
**name** | **String** | The wallet name. |
|
|
11
11
|
**org_id** | **String** | The ID of the owning organization. |
|
|
12
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional]
|
|
12
13
|
**project_id** | **String** | The project ID. | [optional]
|
|
13
14
|
**project_name** | **String** | The project name. | [optional]
|
|
14
15
|
**vault_id** | **String** | The ID of the owning vault. |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.MerchantBalance
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**merchant_id** | **String** | The merchant ID. |
|
|
8
|
+
**token_id** | **String** | The ID of the cryptocurrency. |
|
|
9
|
+
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
|
|
10
|
+
**total_received_amount** | **String** | The merchant total received amount. | [optional]
|
|
11
|
+
**settled_amount** | **String** | The merchant settled amount. | [optional]
|
|
12
|
+
**refunded_amount** | **String** | The merchant total refunded amount. | [optional]
|
|
13
|
+
**total_balance** | **String** | The merchant total balance. | [optional]
|
|
14
|
+
**available_balance** | **String** | The merchant available balance. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The
|
|
8
|
-
**custom_payer_id** | **String** |
|
|
9
|
-
**payer_id** | **String** |
|
|
10
|
-
**chain** | **String** |
|
|
11
|
-
**previous_address** | **String** | The previous
|
|
12
|
-
**updated_address** | **String** | The new
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
|
+
**custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
9
|
+
**payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. |
|
|
10
|
+
**chain** | **String** | The chain ID. |
|
|
11
|
+
**previous_address** | **String** | The previous top-up address that was assigned to the payer. |
|
|
12
|
+
**updated_address** | **String** | The new top-up address that has been assigned to the payer. |
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
|
package/docs/PaymentApi.md
CHANGED
|
@@ -5,13 +5,17 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**cancelRefundById**](PaymentApi.md#cancelRefundById) | **PUT** /payments/refunds/{refund_id}/cancel | Cancel refund order
|
|
8
|
-
[**
|
|
8
|
+
[**createCryptoAddress**](PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
|
|
9
|
+
[**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
|
|
9
10
|
[**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
10
11
|
[**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
|
|
11
12
|
[**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
|
|
12
13
|
[**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
|
|
14
|
+
[**deleteCryptoAddress**](PaymentApi.md#deleteCryptoAddress) | **POST** /payments/crypto_addresses/{crypto_address_id}/delete | Delete crypto address
|
|
13
15
|
[**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
|
|
16
|
+
[**getPayerBalanceByAddress**](PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance by address
|
|
14
17
|
[**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
|
|
18
|
+
[**getPspBalance**](PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get psp balance
|
|
15
19
|
[**getRefundDetailById**](PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
|
|
16
20
|
[**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
|
|
17
21
|
[**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
|
|
@@ -19,15 +23,18 @@ Method | HTTP request | Description
|
|
|
19
23
|
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Get top-up address
|
|
20
24
|
[**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
|
|
21
25
|
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
22
|
-
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List
|
|
26
|
+
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List forced sweeps
|
|
27
|
+
[**listMerchantBalances**](PaymentApi.md#listMerchantBalances) | **GET** /payments/balance/merchants | List merchant balances
|
|
23
28
|
[**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
|
|
24
29
|
[**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
|
|
25
30
|
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List all supported tokens
|
|
31
|
+
[**listPaymentWalletBalances**](PaymentApi.md#listPaymentWalletBalances) | **GET** /payments/balance/payment_wallets | List payment wallet balances
|
|
32
|
+
[**listSettlementDetails**](PaymentApi.md#listSettlementDetails) | **GET** /payments/settlement_details | List all settlement details
|
|
26
33
|
[**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
|
|
27
34
|
[**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
|
|
28
35
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
29
36
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
30
|
-
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
|
|
37
|
+
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
|
|
31
38
|
[**updateTopUpAddress**](PaymentApi.md#updateTopUpAddress) | **PUT** /payments/topup/address | Update top-up address
|
|
32
39
|
|
|
33
40
|
|
|
@@ -38,7 +45,7 @@ Method | HTTP request | Description
|
|
|
38
45
|
|
|
39
46
|
Cancel refund order
|
|
40
47
|
|
|
41
|
-
This operation cancels a specified refund order.
|
|
48
|
+
This operation cancels a specified refund order. You can only cancel refund orders that have not been processed yet.
|
|
42
49
|
|
|
43
50
|
### Example
|
|
44
51
|
|
|
@@ -82,13 +89,65 @@ Name | Type | Description | Notes
|
|
|
82
89
|
- **Accept**: application/json
|
|
83
90
|
|
|
84
91
|
|
|
92
|
+
## createCryptoAddress
|
|
93
|
+
|
|
94
|
+
> CryptoAddress createCryptoAddress(opts)
|
|
95
|
+
|
|
96
|
+
Create crypto address
|
|
97
|
+
|
|
98
|
+
This operation registers a crypto address for crypto withdrawal. The registered address can later be referenced by its ID when creating settlement requests.
|
|
99
|
+
|
|
100
|
+
### Example
|
|
101
|
+
|
|
102
|
+
```javascript
|
|
103
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
104
|
+
// Initialize the API client
|
|
105
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
106
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
107
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
108
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
109
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
110
|
+
// Call the API
|
|
111
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
112
|
+
const opts = {
|
|
113
|
+
'CreateCryptoAddressRequest': new CoboWaas2.CreateCryptoAddressRequest()
|
|
114
|
+
};
|
|
115
|
+
apiInstance.createCryptoAddress(opts).then((data) => {
|
|
116
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
117
|
+
}, (error) => {
|
|
118
|
+
console.error(error);
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
Name | Type | Description | Notes
|
|
127
|
+
------------- | ------------- | ------------- | -------------
|
|
128
|
+
**CreateCryptoAddressRequest** | [**CreateCryptoAddressRequest**](CreateCryptoAddressRequest.md)| The request body to register a crypto address. | [optional]
|
|
129
|
+
|
|
130
|
+
### Return type
|
|
131
|
+
|
|
132
|
+
[**CryptoAddress**](CryptoAddress.md)
|
|
133
|
+
|
|
134
|
+
### Authorization
|
|
135
|
+
|
|
136
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
137
|
+
|
|
138
|
+
### HTTP request headers
|
|
139
|
+
|
|
140
|
+
- **Content-Type**: application/json
|
|
141
|
+
- **Accept**: application/json
|
|
142
|
+
|
|
143
|
+
|
|
85
144
|
## createForcedSweepRequest
|
|
86
145
|
|
|
87
146
|
> ForcedSweep createForcedSweepRequest(opts)
|
|
88
147
|
|
|
89
|
-
Create
|
|
148
|
+
Create forced sweep
|
|
90
149
|
|
|
91
|
-
This operation creates a
|
|
150
|
+
This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address.
|
|
92
151
|
|
|
93
152
|
### Example
|
|
94
153
|
|
|
@@ -118,7 +177,7 @@ apiInstance.createForcedSweepRequest(opts).then((data) => {
|
|
|
118
177
|
|
|
119
178
|
Name | Type | Description | Notes
|
|
120
179
|
------------- | ------------- | ------------- | -------------
|
|
121
|
-
**ForcedSweepRequest** | [**ForcedSweepRequest**](ForcedSweepRequest.md)| The request body
|
|
180
|
+
**ForcedSweepRequest** | [**ForcedSweepRequest**](ForcedSweepRequest.md)| The request body for forced sweep. | [optional]
|
|
122
181
|
|
|
123
182
|
### Return type
|
|
124
183
|
|
|
@@ -342,6 +401,56 @@ Name | Type | Description | Notes
|
|
|
342
401
|
- **Accept**: application/json
|
|
343
402
|
|
|
344
403
|
|
|
404
|
+
## deleteCryptoAddress
|
|
405
|
+
|
|
406
|
+
> DeleteCryptoAddress201Response deleteCryptoAddress(crypto_address_id)
|
|
407
|
+
|
|
408
|
+
Delete crypto address
|
|
409
|
+
|
|
410
|
+
This operation unregisters a crypto address from being used for crypto withdrawals.
|
|
411
|
+
|
|
412
|
+
### Example
|
|
413
|
+
|
|
414
|
+
```javascript
|
|
415
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
416
|
+
// Initialize the API client
|
|
417
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
418
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
419
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
420
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
421
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
422
|
+
// Call the API
|
|
423
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
424
|
+
const crypto_address_id = "addr_ethusdt_20250506T123456_ab12cd";
|
|
425
|
+
apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
426
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
427
|
+
}, (error) => {
|
|
428
|
+
console.error(error);
|
|
429
|
+
});
|
|
430
|
+
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### Parameters
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
Name | Type | Description | Notes
|
|
437
|
+
------------- | ------------- | ------------- | -------------
|
|
438
|
+
**crypto_address_id** | **String**| The crypto address ID. |
|
|
439
|
+
|
|
440
|
+
### Return type
|
|
441
|
+
|
|
442
|
+
[**DeleteCryptoAddress201Response**](DeleteCryptoAddress201Response.md)
|
|
443
|
+
|
|
444
|
+
### Authorization
|
|
445
|
+
|
|
446
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
447
|
+
|
|
448
|
+
### HTTP request headers
|
|
449
|
+
|
|
450
|
+
- **Content-Type**: Not defined
|
|
451
|
+
- **Accept**: application/json
|
|
452
|
+
|
|
453
|
+
|
|
345
454
|
## getExchangeRate
|
|
346
455
|
|
|
347
456
|
> GetExchangeRate200Response getExchangeRate(token_id, currency)
|
|
@@ -394,6 +503,60 @@ Name | Type | Description | Notes
|
|
|
394
503
|
- **Accept**: application/json
|
|
395
504
|
|
|
396
505
|
|
|
506
|
+
## getPayerBalanceByAddress
|
|
507
|
+
|
|
508
|
+
> [ReceivedAmountPerAddress] getPayerBalanceByAddress(merchant_id, payer_id, token_id)
|
|
509
|
+
|
|
510
|
+
Get payer balance by address
|
|
511
|
+
|
|
512
|
+
This operation retrieves aggregated balance details for a specific token and payer, with amounts grouped by address.
|
|
513
|
+
|
|
514
|
+
### Example
|
|
515
|
+
|
|
516
|
+
```javascript
|
|
517
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
518
|
+
// Initialize the API client
|
|
519
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
520
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
521
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
522
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
523
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
524
|
+
// Call the API
|
|
525
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
526
|
+
const merchant_id = "M1001";
|
|
527
|
+
const payer_id = "P20250619T0310056d7aa";
|
|
528
|
+
const token_id = "ETH_USDT";
|
|
529
|
+
apiInstance.getPayerBalanceByAddress(merchant_id, payer_id, token_id).then((data) => {
|
|
530
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
531
|
+
}, (error) => {
|
|
532
|
+
console.error(error);
|
|
533
|
+
});
|
|
534
|
+
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
### Parameters
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
Name | Type | Description | Notes
|
|
541
|
+
------------- | ------------- | ------------- | -------------
|
|
542
|
+
**merchant_id** | **String**| The merchant ID. |
|
|
543
|
+
**payer_id** | **String**| Unique payer identifier on the Cobo side, auto-generated by the system. |
|
|
544
|
+
**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` |
|
|
545
|
+
|
|
546
|
+
### Return type
|
|
547
|
+
|
|
548
|
+
[**[ReceivedAmountPerAddress]**](ReceivedAmountPerAddress.md)
|
|
549
|
+
|
|
550
|
+
### Authorization
|
|
551
|
+
|
|
552
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
553
|
+
|
|
554
|
+
### HTTP request headers
|
|
555
|
+
|
|
556
|
+
- **Content-Type**: Not defined
|
|
557
|
+
- **Accept**: application/json
|
|
558
|
+
|
|
559
|
+
|
|
397
560
|
## getPaymentOrderDetailById
|
|
398
561
|
|
|
399
562
|
> Order getPaymentOrderDetailById(order_id)
|
|
@@ -444,6 +607,56 @@ Name | Type | Description | Notes
|
|
|
444
607
|
- **Accept**: application/json
|
|
445
608
|
|
|
446
609
|
|
|
610
|
+
## getPspBalance
|
|
611
|
+
|
|
612
|
+
> PspBalance getPspBalance(token_id)
|
|
613
|
+
|
|
614
|
+
Get psp balance
|
|
615
|
+
|
|
616
|
+
This operation retrieves the information of psp balance.
|
|
617
|
+
|
|
618
|
+
### Example
|
|
619
|
+
|
|
620
|
+
```javascript
|
|
621
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
622
|
+
// Initialize the API client
|
|
623
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
624
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
625
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
626
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
627
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
628
|
+
// Call the API
|
|
629
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
630
|
+
const token_id = "ETH_USDT";
|
|
631
|
+
apiInstance.getPspBalance(token_id).then((data) => {
|
|
632
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
633
|
+
}, (error) => {
|
|
634
|
+
console.error(error);
|
|
635
|
+
});
|
|
636
|
+
|
|
637
|
+
```
|
|
638
|
+
|
|
639
|
+
### Parameters
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
Name | Type | Description | Notes
|
|
643
|
+
------------- | ------------- | ------------- | -------------
|
|
644
|
+
**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` |
|
|
645
|
+
|
|
646
|
+
### Return type
|
|
647
|
+
|
|
648
|
+
[**PspBalance**](PspBalance.md)
|
|
649
|
+
|
|
650
|
+
### Authorization
|
|
651
|
+
|
|
652
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
653
|
+
|
|
654
|
+
### HTTP request headers
|
|
655
|
+
|
|
656
|
+
- **Content-Type**: Not defined
|
|
657
|
+
- **Accept**: application/json
|
|
658
|
+
|
|
659
|
+
|
|
447
660
|
## getRefundDetailById
|
|
448
661
|
|
|
449
662
|
> Refund getRefundDetailById(refund_id)
|
|
@@ -519,7 +732,8 @@ const opts = {
|
|
|
519
732
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
520
733
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
521
734
|
'merchant_id': "M1001",
|
|
522
|
-
'request_id': "random_request_id"
|
|
735
|
+
'request_id': "random_request_id",
|
|
736
|
+
'statuses': "Pending,Processing"
|
|
523
737
|
};
|
|
524
738
|
apiInstance.getRefunds(opts).then((data) => {
|
|
525
739
|
console.log('API called successfully. Returned data: ' + data);
|
|
@@ -539,6 +753,7 @@ Name | Type | Description | Notes
|
|
|
539
753
|
**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]
|
|
540
754
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
541
755
|
**request_id** | **String**| The request ID. | [optional]
|
|
756
|
+
**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]
|
|
542
757
|
|
|
543
758
|
### Return type
|
|
544
759
|
|
|
@@ -610,7 +825,7 @@ Name | Type | Description | Notes
|
|
|
610
825
|
|
|
611
826
|
Get withdrawable balances
|
|
612
827
|
|
|
613
|
-
This operation retrieves the
|
|
828
|
+
This operation retrieves the balances of specified merchants or the developer.
|
|
614
829
|
|
|
615
830
|
### Example
|
|
616
831
|
|
|
@@ -816,9 +1031,9 @@ Name | Type | Description | Notes
|
|
|
816
1031
|
|
|
817
1032
|
> ListForcedSweepRequests200Response listForcedSweepRequests(opts)
|
|
818
1033
|
|
|
819
|
-
List
|
|
1034
|
+
List forced sweeps
|
|
820
1035
|
|
|
821
|
-
This operation retrieves the information of
|
|
1036
|
+
This operation retrieves the information of all forced sweeps.
|
|
822
1037
|
|
|
823
1038
|
### Example
|
|
824
1039
|
|
|
@@ -870,6 +1085,62 @@ Name | Type | Description | Notes
|
|
|
870
1085
|
- **Accept**: application/json
|
|
871
1086
|
|
|
872
1087
|
|
|
1088
|
+
## listMerchantBalances
|
|
1089
|
+
|
|
1090
|
+
> ListMerchantBalances200Response listMerchantBalances(token_id, acquiring_type, opts)
|
|
1091
|
+
|
|
1092
|
+
List merchant balances
|
|
1093
|
+
|
|
1094
|
+
This operation retrieves the information of merchant balances.
|
|
1095
|
+
|
|
1096
|
+
### Example
|
|
1097
|
+
|
|
1098
|
+
```javascript
|
|
1099
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1100
|
+
// Initialize the API client
|
|
1101
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1102
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1103
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1104
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1105
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1106
|
+
// Call the API
|
|
1107
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1108
|
+
const token_id = "ETH_USDT";
|
|
1109
|
+
const acquiring_type = new CoboWaas2.AcquiringType();
|
|
1110
|
+
const opts = {
|
|
1111
|
+
'merchant_ids': "M1001,M1002,M1003"
|
|
1112
|
+
};
|
|
1113
|
+
apiInstance.listMerchantBalances(token_id, acquiring_type, opts).then((data) => {
|
|
1114
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1115
|
+
}, (error) => {
|
|
1116
|
+
console.error(error);
|
|
1117
|
+
});
|
|
1118
|
+
|
|
1119
|
+
```
|
|
1120
|
+
|
|
1121
|
+
### Parameters
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
Name | Type | Description | Notes
|
|
1125
|
+
------------- | ------------- | ------------- | -------------
|
|
1126
|
+
**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` |
|
|
1127
|
+
**acquiring_type** | [**AcquiringType**](.md)| AcquiringType defines the acquisition logic used in the payment flow: - `Order`: Each order is created with a specific amount and associated payment request. Funds are settled on a per-order basis. - `TopUp`: Recharge-style flow where funds are topped up to a payer balance or account. Useful for flexible or usage-based payment models. |
|
|
1128
|
+
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
1129
|
+
|
|
1130
|
+
### Return type
|
|
1131
|
+
|
|
1132
|
+
[**ListMerchantBalances200Response**](ListMerchantBalances200Response.md)
|
|
1133
|
+
|
|
1134
|
+
### Authorization
|
|
1135
|
+
|
|
1136
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1137
|
+
|
|
1138
|
+
### HTTP request headers
|
|
1139
|
+
|
|
1140
|
+
- **Content-Type**: Not defined
|
|
1141
|
+
- **Accept**: application/json
|
|
1142
|
+
|
|
1143
|
+
|
|
873
1144
|
## listMerchants
|
|
874
1145
|
|
|
875
1146
|
> ListMerchants200Response listMerchants(opts)
|
|
@@ -955,7 +1226,8 @@ const opts = {
|
|
|
955
1226
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
956
1227
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
957
1228
|
'merchant_id': "M1001",
|
|
958
|
-
'psp_order_id': "P20240201001"
|
|
1229
|
+
'psp_order_id': "P20240201001",
|
|
1230
|
+
'statuses': "Pending,Processing"
|
|
959
1231
|
};
|
|
960
1232
|
apiInstance.listPaymentOrders(opts).then((data) => {
|
|
961
1233
|
console.log('API called successfully. Returned data: ' + data);
|
|
@@ -975,6 +1247,7 @@ Name | Type | Description | Notes
|
|
|
975
1247
|
**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]
|
|
976
1248
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
977
1249
|
**psp_order_id** | **String**| A unique reference code assigned by the developer to identify this order in their system. | [optional]
|
|
1250
|
+
**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]
|
|
978
1251
|
|
|
979
1252
|
### Return type
|
|
980
1253
|
|
|
@@ -1036,6 +1309,120 @@ This endpoint does not need any parameter.
|
|
|
1036
1309
|
- **Accept**: application/json
|
|
1037
1310
|
|
|
1038
1311
|
|
|
1312
|
+
## listPaymentWalletBalances
|
|
1313
|
+
|
|
1314
|
+
> ListPaymentWalletBalances200Response listPaymentWalletBalances(token_id, opts)
|
|
1315
|
+
|
|
1316
|
+
List payment wallet balances
|
|
1317
|
+
|
|
1318
|
+
This operation retrieves the information of payment wallet balances.
|
|
1319
|
+
|
|
1320
|
+
### Example
|
|
1321
|
+
|
|
1322
|
+
```javascript
|
|
1323
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1324
|
+
// Initialize the API client
|
|
1325
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1326
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1327
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1328
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1329
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1330
|
+
// Call the API
|
|
1331
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1332
|
+
const token_id = "ETH_USDT";
|
|
1333
|
+
const opts = {
|
|
1334
|
+
'wallet_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,f47ac10b-58cc-4372-a567-0e02b2c3d472"
|
|
1335
|
+
};
|
|
1336
|
+
apiInstance.listPaymentWalletBalances(token_id, opts).then((data) => {
|
|
1337
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1338
|
+
}, (error) => {
|
|
1339
|
+
console.error(error);
|
|
1340
|
+
});
|
|
1341
|
+
|
|
1342
|
+
```
|
|
1343
|
+
|
|
1344
|
+
### Parameters
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
Name | Type | Description | Notes
|
|
1348
|
+
------------- | ------------- | ------------- | -------------
|
|
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
|
+
**wallet_ids** | **String**| A list of wallet IDs to query. | [optional]
|
|
1351
|
+
|
|
1352
|
+
### Return type
|
|
1353
|
+
|
|
1354
|
+
[**ListPaymentWalletBalances200Response**](ListPaymentWalletBalances200Response.md)
|
|
1355
|
+
|
|
1356
|
+
### Authorization
|
|
1357
|
+
|
|
1358
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1359
|
+
|
|
1360
|
+
### HTTP request headers
|
|
1361
|
+
|
|
1362
|
+
- **Content-Type**: Not defined
|
|
1363
|
+
- **Accept**: application/json
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
## listSettlementDetails
|
|
1367
|
+
|
|
1368
|
+
> ListSettlementDetails200Response listSettlementDetails(opts)
|
|
1369
|
+
|
|
1370
|
+
List all settlement details
|
|
1371
|
+
|
|
1372
|
+
This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status.
|
|
1373
|
+
|
|
1374
|
+
### Example
|
|
1375
|
+
|
|
1376
|
+
```javascript
|
|
1377
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1378
|
+
// Initialize the API client
|
|
1379
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1380
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1381
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1382
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1383
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1384
|
+
// Call the API
|
|
1385
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1386
|
+
const opts = {
|
|
1387
|
+
'limit': 10,
|
|
1388
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1389
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1390
|
+
'merchant_id': "M1001",
|
|
1391
|
+
'statuses': "Pending,Processing"
|
|
1392
|
+
};
|
|
1393
|
+
apiInstance.listSettlementDetails(opts).then((data) => {
|
|
1394
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1395
|
+
}, (error) => {
|
|
1396
|
+
console.error(error);
|
|
1397
|
+
});
|
|
1398
|
+
|
|
1399
|
+
```
|
|
1400
|
+
|
|
1401
|
+
### Parameters
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
Name | Type | Description | Notes
|
|
1405
|
+
------------- | ------------- | ------------- | -------------
|
|
1406
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1407
|
+
**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]
|
|
1408
|
+
**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]
|
|
1409
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1410
|
+
**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]
|
|
1411
|
+
|
|
1412
|
+
### Return type
|
|
1413
|
+
|
|
1414
|
+
[**ListSettlementDetails200Response**](ListSettlementDetails200Response.md)
|
|
1415
|
+
|
|
1416
|
+
### Authorization
|
|
1417
|
+
|
|
1418
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1419
|
+
|
|
1420
|
+
### HTTP request headers
|
|
1421
|
+
|
|
1422
|
+
- **Content-Type**: Not defined
|
|
1423
|
+
- **Accept**: application/json
|
|
1424
|
+
|
|
1425
|
+
|
|
1039
1426
|
## listSettlementRequests
|
|
1040
1427
|
|
|
1041
1428
|
> ListSettlementRequests200Response listSettlementRequests(opts)
|
|
@@ -1266,9 +1653,9 @@ Name | Type | Description | Notes
|
|
|
1266
1653
|
|
|
1267
1654
|
> Refund updateRefundById(refund_id, opts)
|
|
1268
1655
|
|
|
1269
|
-
Update refund order
|
|
1656
|
+
Update refund order
|
|
1270
1657
|
|
|
1271
|
-
This operation updates a specified refund order.
|
|
1658
|
+
This operation updates a specified refund order by modifying its recipient address. You can only update the recipient address for refund orders that have not been processed yet.
|
|
1272
1659
|
|
|
1273
1660
|
### Example
|
|
1274
1661
|
|
|
@@ -1322,7 +1709,7 @@ Name | Type | Description | Notes
|
|
|
1322
1709
|
|
|
1323
1710
|
Update top-up address
|
|
1324
1711
|
|
|
1325
|
-
|
|
1712
|
+
This operation updates the dedicated top-up address assigned to a specific payer under a merchant on a specified chain.
|
|
1326
1713
|
|
|
1327
1714
|
### Example
|
|
1328
1715
|
|
|
@@ -1352,7 +1739,7 @@ apiInstance.updateTopUpAddress(opts).then((data) => {
|
|
|
1352
1739
|
|
|
1353
1740
|
Name | Type | Description | Notes
|
|
1354
1741
|
------------- | ------------- | ------------- | -------------
|
|
1355
|
-
**UpdateTopUpAddress** | [**UpdateTopUpAddress**](UpdateTopUpAddress.md)| The request body to update top
|
|
1742
|
+
**UpdateTopUpAddress** | [**UpdateTopUpAddress**](UpdateTopUpAddress.md)| The request body to update top-up address. | [optional]
|
|
1356
1743
|
|
|
1357
1744
|
### Return type
|
|
1358
1745
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
8
|
**order_id** | **String** | The order ID. |
|
|
9
9
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
10
10
|
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - 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` |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the refund request. | [optional]
|
|
9
9
|
**refund_id** | **String** | The refund order ID. |
|
|
10
10
|
**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional]
|