@cobo/cobo-waas2 1.16.0 → 1.18.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 +46 -6
- package/dist/ApiClient.js +1 -1
- package/dist/PreRequestScript.js +27 -33
- package/dist/api/AppWorkflowsApi.js +22 -22
- package/dist/api/FeeStationApi.js +2 -2
- package/dist/api/OAuthApi.js +93 -6
- package/dist/api/OrganizationsApi.js +79 -0
- package/dist/api/PaymentApi.js +265 -55
- package/dist/api/TransactionsApi.js +2 -2
- package/dist/api/WalletsApi.js +11 -8
- package/dist/index.js +252 -14
- package/dist/model/Account.js +174 -0
- package/dist/model/AcquiringType.js +61 -0
- package/dist/model/AddressTransferDestination.js +2 -2
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/AppWorkflow.js +7 -7
- package/dist/model/AppWorkflowField.js +5 -5
- package/dist/model/AppWorkflowPolicy.js +1 -1
- package/dist/model/ApprovalEntry.js +1 -1
- package/dist/model/ApprovalRequest.js +5 -3
- package/dist/model/ApprovalRequestDetail.js +2 -1
- package/dist/model/ApprovalUser.js +4 -4
- package/dist/model/BalanceUpdateInfo.js +170 -0
- package/dist/model/BalanceUpdateInfoEventData.js +297 -0
- package/dist/model/BankAccount.js +2 -2
- package/dist/model/ChainInfo.js +1 -1
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/CreateApprovalRequest201Response.js +2 -1
- package/dist/model/CreateMerchantRequest.js +13 -0
- package/dist/model/CreatePaymentOrderRequest.js +14 -5
- package/dist/model/CreateRefundRequest.js +41 -8
- package/dist/model/CreateSettlement.js +28 -12
- package/dist/model/CreateSettlementRequestRequest.js +27 -0
- package/dist/model/CryptoAddress.js +171 -0
- package/dist/model/CustodialTransferDestination.js +137 -0
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +1 -1
- package/dist/model/EstimatedFILFee.js +170 -0
- package/dist/model/EstimatedFILFeeSlow.js +186 -0
- package/dist/model/EstimatedFee.js +68 -12
- package/dist/model/EstimatedSOLFee.js +170 -0
- package/dist/model/EstimatedSOLFeeSlow.js +184 -0
- package/dist/model/ExchangePermissionToken201Response.js +122 -0
- package/dist/model/{CreateBankAccountRequest.js → ExchangePermissionTokenRequest.js} +30 -28
- package/dist/model/FILBase.js +88 -0
- package/dist/model/FILPrice.js +114 -0
- package/dist/model/FeeType.js +10 -0
- package/dist/model/GetExchangeRate200Response.js +2 -2
- package/dist/model/GraphQLError.js +135 -0
- package/dist/model/GraphQLErrorLocationsInner.js +92 -0
- package/dist/model/{TransactionMessageSignBTCEIP191Destination.js → GraphQLRequest.js} +49 -36
- package/dist/model/GraphQLResponse.js +119 -0
- package/dist/model/ListTopUpPayers200Response.js +123 -0
- package/dist/model/ListTopUpPayers200ResponseDataInner.js +189 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/Merchant.js +15 -2
- package/dist/model/Order.js +16 -7
- package/dist/model/PayerAccount.js +189 -0
- package/dist/model/PaymentOrderEventData.js +33 -15
- package/dist/model/PaymentRefundEventData.js +66 -11
- package/dist/model/PaymentSettlementEvent.js +14 -9
- package/dist/model/PayoutChannel.js +61 -0
- package/dist/model/PolicyAction.js +1 -1
- package/dist/model/PolicyActionContent.js +6 -4
- package/dist/model/PolicyCondition.js +5 -5
- package/dist/model/RefreshPermissionTokenRequest.js +110 -0
- package/dist/model/Refund.js +39 -4
- package/dist/model/RefundStatus.js +5 -0
- package/dist/model/RequestApproval.js +9 -9
- package/dist/model/RevokeApprovalRequest201Response.js +2 -1
- package/dist/model/RevokeApprovalRequestRequest.js +2 -2
- package/dist/model/SOLBase.js +101 -0
- package/dist/model/SOLComputeUnit.js +101 -0
- package/dist/model/Settlement.js +3 -3
- package/dist/model/SettlementDetail.js +24 -6
- package/dist/model/SettlementInfo.js +11 -2
- package/dist/model/SupportedToken.js +222 -0
- package/dist/model/SwapActivityDetail.js +30 -0
- package/dist/model/SwapActivitySigners.js +110 -0
- package/dist/model/SwapQuote.js +17 -4
- package/dist/model/SwapSingingStatus.js +71 -0
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TopUpAddress.js +230 -0
- package/dist/model/TransactionCoboCategory.js +20 -0
- package/dist/model/TransactionDestination.js +14 -38
- package/dist/model/TransactionDestinationType.js +5 -0
- package/dist/model/TransactionEvmCalldataInfo.js +1 -1
- package/dist/model/TransactionFILFee.js +229 -0
- package/dist/model/TransactionFee.js +107 -9
- package/dist/model/TransactionRequestFILFee.js +186 -0
- package/dist/model/TransactionRequestFee.js +89 -9
- package/dist/model/TransactionRequestSOLFee.js +168 -0
- package/dist/model/TransactionSOLFee.js +229 -0
- package/dist/model/TransactionTransferToAddressDestination.js +2 -2
- package/dist/model/TransactionTransferToWalletDestination.js +2 -2
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/TransferDestination.js +44 -16
- package/dist/model/TransferDestinationType.js +5 -0
- package/dist/model/UpdateMerchantByIdRequest.js +13 -0
- package/dist/model/UpdateRefundByIdRequest.js +110 -0
- package/dist/model/UpdateTopUpAddress.js +141 -0
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEvent.js +2 -2
- package/dist/model/WebhookEventData.js +83 -13
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventLog.js +2 -2
- package/dist/model/WebhookEventType.js +15 -0
- package/docs/Account.md +14 -0
- package/docs/AcquiringType.md +12 -0
- package/docs/AddressTransferDestination.md +2 -2
- package/docs/AddressesEventData.md +3 -1
- package/docs/AppWorkflow.md +3 -3
- package/docs/AppWorkflowField.md +2 -2
- package/docs/AppWorkflowsApi.md +12 -12
- package/docs/ApprovalRequest.md +2 -2
- package/docs/ApprovalRequestDetail.md +1 -1
- package/docs/ApprovalUser.md +2 -2
- package/docs/BalanceUpdateInfo.md +13 -0
- package/docs/BalanceUpdateInfoEventData.md +47 -0
- package/docs/BankAccount.md +2 -2
- package/docs/ChainInfo.md +1 -1
- package/docs/ChainsEventData.md +3 -1
- package/docs/CreateApprovalRequest201Response.md +1 -1
- package/docs/CreateMerchantRequest.md +1 -0
- package/docs/CreatePaymentOrderRequest.md +2 -1
- package/docs/CreateRefundRequest.md +5 -2
- package/docs/CreateSettlement.md +7 -6
- package/docs/CreateSettlementRequestRequest.md +3 -0
- package/docs/CryptoAddress.md +14 -0
- package/docs/CustodialTransferDestination.md +11 -0
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +1 -1
- package/docs/EstimatedFILFee.md +13 -0
- package/docs/EstimatedFILFeeSlow.md +12 -0
- package/docs/EstimatedFee.md +3 -3
- package/docs/EstimatedSOLFee.md +13 -0
- package/docs/EstimatedSOLFeeSlow.md +12 -0
- package/docs/ExchangePermissionToken201Response.md +12 -0
- package/docs/ExchangePermissionTokenRequest.md +9 -0
- package/docs/FILBase.md +9 -0
- package/docs/FILPrice.md +11 -0
- package/docs/FeeStationApi.md +1 -1
- package/docs/FeeType.md +4 -0
- package/docs/GetExchangeRate200Response.md +1 -1
- package/docs/GraphQLError.md +11 -0
- package/docs/GraphQLErrorLocationsInner.md +10 -0
- package/docs/GraphQLRequest.md +11 -0
- package/docs/GraphQLResponse.md +10 -0
- package/docs/ListTopUpPayers200Response.md +10 -0
- package/docs/ListTopUpPayers200ResponseDataInner.md +14 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/Merchant.md +3 -2
- package/docs/OAuthApi.md +102 -0
- package/docs/Order.md +6 -5
- package/docs/OrganizationsApi.md +55 -0
- package/docs/PayerAccount.md +14 -0
- package/docs/PaymentApi.md +247 -29
- package/docs/PaymentOrderEventData.md +9 -6
- package/docs/PaymentRefundEventData.md +10 -5
- package/docs/PaymentSettlementEvent.md +6 -4
- package/docs/PayoutChannel.md +12 -0
- package/docs/PolicyActionContent.md +4 -4
- package/docs/PolicyCondition.md +2 -2
- package/docs/RefreshPermissionTokenRequest.md +9 -0
- package/docs/Refund.md +7 -4
- package/docs/RefundStatus.md +2 -0
- package/docs/RequestApproval.md +4 -4
- package/docs/RevokeApprovalRequest201Response.md +1 -1
- package/docs/RevokeApprovalRequestRequest.md +1 -1
- package/docs/SOLBase.md +10 -0
- package/docs/SOLComputeUnit.md +10 -0
- package/docs/Settlement.md +3 -3
- package/docs/SettlementDetail.md +8 -6
- package/docs/SettlementInfo.md +3 -2
- package/docs/SupportedToken.md +17 -0
- package/docs/SwapActivityDetail.md +1 -0
- package/docs/SwapActivitySigners.md +11 -0
- package/docs/SwapQuote.md +3 -2
- package/docs/SwapSingingStatus.md +16 -0
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokensEventData.md +3 -1
- package/docs/TopUpAddress.md +18 -0
- package/docs/TransactionCoboCategory.md +8 -0
- package/docs/TransactionDestination.md +2 -2
- package/docs/TransactionDestinationType.md +2 -0
- package/docs/TransactionEvmCalldataInfo.md +1 -1
- package/docs/TransactionFILFee.md +16 -0
- package/docs/TransactionFee.md +8 -1
- package/docs/TransactionRequestFILFee.md +13 -0
- package/docs/TransactionRequestFee.md +5 -1
- package/docs/TransactionRequestSOLFee.md +12 -0
- package/docs/TransactionSOLFee.md +16 -0
- package/docs/TransactionTransferToAddressDestination.md +2 -2
- package/docs/TransactionTransferToWalletDestination.md +1 -1
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +1 -1
- package/docs/TransferDestination.md +3 -3
- package/docs/TransferDestinationType.md +2 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -0
- package/docs/UpdateRefundByIdRequest.md +9 -0
- package/docs/UpdateTopUpAddress.md +11 -0
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletsApi.md +6 -4
- package/docs/WebhookEvent.md +1 -1
- package/docs/WebhookEventData.md +14 -5
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventLog.md +1 -1
- package/docs/WebhookEventType.md +6 -0
- package/package.json +1 -1
- package/docs/CreateBankAccountRequest.md +0 -9
- package/docs/TransactionMessageSignBTCEIP191Destination.md +0 -10
package/docs/PaymentApi.md
CHANGED
|
@@ -4,7 +4,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
4
4
|
|
|
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
|
[**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
9
9
|
[**createPaymentOrder**](PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
|
|
10
10
|
[**createRefund**](PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
|
|
@@ -15,23 +15,27 @@ Method | HTTP request | Description
|
|
|
15
15
|
[**getRefunds**](PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
|
|
16
16
|
[**getSettlementById**](PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
|
|
17
17
|
[**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
|
|
18
|
+
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Get top-up address
|
|
18
19
|
[**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
|
|
20
|
+
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
19
21
|
[**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
|
|
20
22
|
[**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
|
|
23
|
+
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List all supported tokens
|
|
21
24
|
[**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
|
|
22
|
-
[**
|
|
25
|
+
[**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
|
|
23
26
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
24
27
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
28
|
+
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order information
|
|
25
29
|
|
|
26
30
|
|
|
27
31
|
|
|
28
|
-
##
|
|
32
|
+
## cancelRefundById
|
|
29
33
|
|
|
30
|
-
>
|
|
34
|
+
> Refund cancelRefundById(refund_id)
|
|
31
35
|
|
|
32
|
-
|
|
36
|
+
Cancel refund order
|
|
33
37
|
|
|
34
|
-
This operation
|
|
38
|
+
This operation cancels a specified refund order.
|
|
35
39
|
|
|
36
40
|
### Example
|
|
37
41
|
|
|
@@ -45,10 +49,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
45
49
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
46
50
|
// Call the API
|
|
47
51
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
48
|
-
const
|
|
49
|
-
|
|
50
|
-
};
|
|
51
|
-
apiInstance.createBankAccount(opts).then((data) => {
|
|
52
|
+
const refund_id = "R20250304-M1001-1001";
|
|
53
|
+
apiInstance.cancelRefundById(refund_id).then((data) => {
|
|
52
54
|
console.log('API called successfully. Returned data: ' + data);
|
|
53
55
|
}, (error) => {
|
|
54
56
|
console.error(error);
|
|
@@ -61,11 +63,11 @@ apiInstance.createBankAccount(opts).then((data) => {
|
|
|
61
63
|
|
|
62
64
|
Name | Type | Description | Notes
|
|
63
65
|
------------- | ------------- | ------------- | -------------
|
|
64
|
-
**
|
|
66
|
+
**refund_id** | **String**| The refund order ID. |
|
|
65
67
|
|
|
66
68
|
### Return type
|
|
67
69
|
|
|
68
|
-
[**
|
|
70
|
+
[**Refund**](Refund.md)
|
|
69
71
|
|
|
70
72
|
### Authorization
|
|
71
73
|
|
|
@@ -73,7 +75,7 @@ Name | Type | Description | Notes
|
|
|
73
75
|
|
|
74
76
|
### HTTP request headers
|
|
75
77
|
|
|
76
|
-
- **Content-Type**:
|
|
78
|
+
- **Content-Type**: Not defined
|
|
77
79
|
- **Accept**: application/json
|
|
78
80
|
|
|
79
81
|
|
|
@@ -239,7 +241,7 @@ Name | Type | Description | Notes
|
|
|
239
241
|
|
|
240
242
|
Create settlement request
|
|
241
243
|
|
|
242
|
-
This operation creates a settlement request to withdraw available balances.
|
|
244
|
+
This operation creates a settlement request to withdraw available balances.
|
|
243
245
|
|
|
244
246
|
### Example
|
|
245
247
|
|
|
@@ -320,7 +322,7 @@ apiInstance.getExchangeRate(token_id, currency).then((data) => {
|
|
|
320
322
|
|
|
321
323
|
Name | Type | Description | Notes
|
|
322
324
|
------------- | ------------- | ------------- | -------------
|
|
323
|
-
**token_id** | **String**| The token ID, which
|
|
325
|
+
**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_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
324
326
|
**currency** | **String**| The fiat currency. Currently, only `USD` is supported. | [default to 'USD']
|
|
325
327
|
|
|
326
328
|
### Return type
|
|
@@ -569,7 +571,8 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
569
571
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
570
572
|
const opts = {
|
|
571
573
|
'merchant_ids': "M1001,M1002,M1003",
|
|
572
|
-
'currency': "USD"
|
|
574
|
+
'currency': "USD",
|
|
575
|
+
'acquiring_type': new CoboWaas2.AcquiringType()
|
|
573
576
|
};
|
|
574
577
|
apiInstance.getSettlementInfoByIds(opts).then((data) => {
|
|
575
578
|
console.log('API called successfully. Returned data: ' + data);
|
|
@@ -586,6 +589,7 @@ Name | Type | Description | Notes
|
|
|
586
589
|
------------- | ------------- | ------------- | -------------
|
|
587
590
|
**merchant_ids** | **String**| A list of merchant IDs to query. | [optional]
|
|
588
591
|
**currency** | **String**| The currency for the operation. Currently, only `USD` is supported. | [optional] [default to 'USD']
|
|
592
|
+
**acquiring_type** | [**AcquiringType**](.md)| | [optional]
|
|
589
593
|
|
|
590
594
|
### Return type
|
|
591
595
|
|
|
@@ -601,13 +605,67 @@ Name | Type | Description | Notes
|
|
|
601
605
|
- **Accept**: application/json
|
|
602
606
|
|
|
603
607
|
|
|
608
|
+
## getTopUpAddress
|
|
609
|
+
|
|
610
|
+
> TopUpAddress getTopUpAddress(merchant_id, token_id, custom_payer_id)
|
|
611
|
+
|
|
612
|
+
Get top-up address
|
|
613
|
+
|
|
614
|
+
This operation retrieves the information of the dedicated top-up address assigned to a specific payer under a merchant on a specified chain.
|
|
615
|
+
|
|
616
|
+
### Example
|
|
617
|
+
|
|
618
|
+
```javascript
|
|
619
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
620
|
+
// Initialize the API client
|
|
621
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
622
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
623
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
624
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
625
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
626
|
+
// Call the API
|
|
627
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
628
|
+
const merchant_id = "M1001";
|
|
629
|
+
const token_id = "ETH_USDT";
|
|
630
|
+
const custom_payer_id = "payer_0001";
|
|
631
|
+
apiInstance.getTopUpAddress(merchant_id, token_id, custom_payer_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
|
+
**merchant_id** | **String**| The merchant ID. |
|
|
645
|
+
**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_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
646
|
+
**custom_payer_id** | **String**| A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
647
|
+
|
|
648
|
+
### Return type
|
|
649
|
+
|
|
650
|
+
[**TopUpAddress**](TopUpAddress.md)
|
|
651
|
+
|
|
652
|
+
### Authorization
|
|
653
|
+
|
|
654
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
655
|
+
|
|
656
|
+
### HTTP request headers
|
|
657
|
+
|
|
658
|
+
- **Content-Type**: Not defined
|
|
659
|
+
- **Accept**: application/json
|
|
660
|
+
|
|
661
|
+
|
|
604
662
|
## listBankAccounts
|
|
605
663
|
|
|
606
664
|
> [BankAccount] listBankAccounts()
|
|
607
665
|
|
|
608
666
|
List all bank accounts
|
|
609
667
|
|
|
610
|
-
This operation retrieves the information of all bank accounts registered.
|
|
668
|
+
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.
|
|
611
669
|
|
|
612
670
|
### Example
|
|
613
671
|
|
|
@@ -647,6 +705,58 @@ This endpoint does not need any parameter.
|
|
|
647
705
|
- **Accept**: application/json
|
|
648
706
|
|
|
649
707
|
|
|
708
|
+
## listCryptoAddresses
|
|
709
|
+
|
|
710
|
+
> [CryptoAddress] listCryptoAddresses(opts)
|
|
711
|
+
|
|
712
|
+
List crypto addresses
|
|
713
|
+
|
|
714
|
+
This operation retrieves a list of crypto addresses registered for crypto withdrawal. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new crypto address.
|
|
715
|
+
|
|
716
|
+
### Example
|
|
717
|
+
|
|
718
|
+
```javascript
|
|
719
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
720
|
+
// Initialize the API client
|
|
721
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
722
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
723
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
724
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
725
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
726
|
+
// Call the API
|
|
727
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
728
|
+
const opts = {
|
|
729
|
+
'token_id': "ETH_USDT"
|
|
730
|
+
};
|
|
731
|
+
apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
732
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
733
|
+
}, (error) => {
|
|
734
|
+
console.error(error);
|
|
735
|
+
});
|
|
736
|
+
|
|
737
|
+
```
|
|
738
|
+
|
|
739
|
+
### Parameters
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
Name | Type | Description | Notes
|
|
743
|
+
------------- | ------------- | ------------- | -------------
|
|
744
|
+
**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_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
745
|
+
|
|
746
|
+
### Return type
|
|
747
|
+
|
|
748
|
+
[**[CryptoAddress]**](CryptoAddress.md)
|
|
749
|
+
|
|
750
|
+
### Authorization
|
|
751
|
+
|
|
752
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
753
|
+
|
|
754
|
+
### HTTP request headers
|
|
755
|
+
|
|
756
|
+
- **Content-Type**: Not defined
|
|
757
|
+
- **Accept**: application/json
|
|
758
|
+
|
|
759
|
+
|
|
650
760
|
## listMerchants
|
|
651
761
|
|
|
652
762
|
> ListMerchants200Response listMerchants(opts)
|
|
@@ -731,7 +841,8 @@ const opts = {
|
|
|
731
841
|
'limit': 10,
|
|
732
842
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
733
843
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
734
|
-
'merchant_id': "M1001"
|
|
844
|
+
'merchant_id': "M1001",
|
|
845
|
+
'psp_order_id': "P20240201001"
|
|
735
846
|
};
|
|
736
847
|
apiInstance.listPaymentOrders(opts).then((data) => {
|
|
737
848
|
console.log('API called successfully. Returned data: ' + data);
|
|
@@ -750,6 +861,7 @@ Name | Type | Description | Notes
|
|
|
750
861
|
**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]
|
|
751
862
|
**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]
|
|
752
863
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
864
|
+
**psp_order_id** | **String**| A unique reference code assigned by the developer to identify this order in their system. | [optional]
|
|
753
865
|
|
|
754
866
|
### Return type
|
|
755
867
|
|
|
@@ -765,6 +877,52 @@ Name | Type | Description | Notes
|
|
|
765
877
|
- **Accept**: application/json
|
|
766
878
|
|
|
767
879
|
|
|
880
|
+
## listPaymentSupportedTokens
|
|
881
|
+
|
|
882
|
+
> [SupportedToken] listPaymentSupportedTokens()
|
|
883
|
+
|
|
884
|
+
List all supported tokens
|
|
885
|
+
|
|
886
|
+
This operation retrieves the information of all supported tokens.
|
|
887
|
+
|
|
888
|
+
### Example
|
|
889
|
+
|
|
890
|
+
```javascript
|
|
891
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
892
|
+
// Initialize the API client
|
|
893
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
894
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
895
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
896
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
897
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
898
|
+
// Call the API
|
|
899
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
900
|
+
apiInstance.listPaymentSupportedTokens().then((data) => {
|
|
901
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
902
|
+
}, (error) => {
|
|
903
|
+
console.error(error);
|
|
904
|
+
});
|
|
905
|
+
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
### Parameters
|
|
909
|
+
|
|
910
|
+
This endpoint does not need any parameter.
|
|
911
|
+
|
|
912
|
+
### Return type
|
|
913
|
+
|
|
914
|
+
[**[SupportedToken]**](SupportedToken.md)
|
|
915
|
+
|
|
916
|
+
### Authorization
|
|
917
|
+
|
|
918
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
919
|
+
|
|
920
|
+
### HTTP request headers
|
|
921
|
+
|
|
922
|
+
- **Content-Type**: Not defined
|
|
923
|
+
- **Accept**: application/json
|
|
924
|
+
|
|
925
|
+
|
|
768
926
|
## listSettlementRequests
|
|
769
927
|
|
|
770
928
|
> ListSettlementRequests200Response listSettlementRequests(opts)
|
|
@@ -823,13 +981,13 @@ Name | Type | Description | Notes
|
|
|
823
981
|
- **Accept**: application/json
|
|
824
982
|
|
|
825
983
|
|
|
826
|
-
##
|
|
984
|
+
## listTopUpPayers
|
|
827
985
|
|
|
828
|
-
>
|
|
986
|
+
> ListTopUpPayers200Response listTopUpPayers(merchant_id, opts)
|
|
829
987
|
|
|
830
|
-
|
|
988
|
+
List payers
|
|
831
989
|
|
|
832
|
-
This operation
|
|
990
|
+
This operation retrieves the information of all payers under a merchant. You can filter the result by the payer ID.
|
|
833
991
|
|
|
834
992
|
### Example
|
|
835
993
|
|
|
@@ -843,11 +1001,14 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
843
1001
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
844
1002
|
// Call the API
|
|
845
1003
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
846
|
-
const
|
|
1004
|
+
const merchant_id = "M1001";
|
|
847
1005
|
const opts = {
|
|
848
|
-
'
|
|
1006
|
+
'limit': 10,
|
|
1007
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1008
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1009
|
+
'payer_id': "P20250619T0310056d7aa"
|
|
849
1010
|
};
|
|
850
|
-
apiInstance.
|
|
1011
|
+
apiInstance.listTopUpPayers(merchant_id, opts).then((data) => {
|
|
851
1012
|
console.log('API called successfully. Returned data: ' + data);
|
|
852
1013
|
}, (error) => {
|
|
853
1014
|
console.error(error);
|
|
@@ -860,12 +1021,15 @@ apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
|
|
|
860
1021
|
|
|
861
1022
|
Name | Type | Description | Notes
|
|
862
1023
|
------------- | ------------- | ------------- | -------------
|
|
863
|
-
**
|
|
864
|
-
**
|
|
1024
|
+
**merchant_id** | **String**| The merchant ID. |
|
|
1025
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1026
|
+
**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]
|
|
1027
|
+
**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]
|
|
1028
|
+
**payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
865
1029
|
|
|
866
1030
|
### Return type
|
|
867
1031
|
|
|
868
|
-
[**
|
|
1032
|
+
[**ListTopUpPayers200Response**](ListTopUpPayers200Response.md)
|
|
869
1033
|
|
|
870
1034
|
### Authorization
|
|
871
1035
|
|
|
@@ -873,7 +1037,7 @@ Name | Type | Description | Notes
|
|
|
873
1037
|
|
|
874
1038
|
### HTTP request headers
|
|
875
1039
|
|
|
876
|
-
- **Content-Type**:
|
|
1040
|
+
- **Content-Type**: Not defined
|
|
877
1041
|
- **Accept**: application/json
|
|
878
1042
|
|
|
879
1043
|
|
|
@@ -984,3 +1148,57 @@ Name | Type | Description | Notes
|
|
|
984
1148
|
- **Content-Type**: application/json
|
|
985
1149
|
- **Accept**: application/json
|
|
986
1150
|
|
|
1151
|
+
|
|
1152
|
+
## updateRefundById
|
|
1153
|
+
|
|
1154
|
+
> Refund updateRefundById(refund_id, opts)
|
|
1155
|
+
|
|
1156
|
+
Update refund order information
|
|
1157
|
+
|
|
1158
|
+
This operation updates a specified refund order.
|
|
1159
|
+
|
|
1160
|
+
### Example
|
|
1161
|
+
|
|
1162
|
+
```javascript
|
|
1163
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1164
|
+
// Initialize the API client
|
|
1165
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1166
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1167
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1168
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1169
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1170
|
+
// Call the API
|
|
1171
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1172
|
+
const refund_id = "R20250304-M1001-1001";
|
|
1173
|
+
const opts = {
|
|
1174
|
+
'UpdateRefundByIdRequest': new CoboWaas2.UpdateRefundByIdRequest()
|
|
1175
|
+
};
|
|
1176
|
+
apiInstance.updateRefundById(refund_id, opts).then((data) => {
|
|
1177
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1178
|
+
}, (error) => {
|
|
1179
|
+
console.error(error);
|
|
1180
|
+
});
|
|
1181
|
+
|
|
1182
|
+
```
|
|
1183
|
+
|
|
1184
|
+
### Parameters
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
Name | Type | Description | Notes
|
|
1188
|
+
------------- | ------------- | ------------- | -------------
|
|
1189
|
+
**refund_id** | **String**| The refund order ID. |
|
|
1190
|
+
**UpdateRefundByIdRequest** | [**UpdateRefundByIdRequest**](UpdateRefundByIdRequest.md)| The request body to update a refund order. | [optional]
|
|
1191
|
+
|
|
1192
|
+
### Return type
|
|
1193
|
+
|
|
1194
|
+
[**Refund**](Refund.md)
|
|
1195
|
+
|
|
1196
|
+
### Authorization
|
|
1197
|
+
|
|
1198
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1199
|
+
|
|
1200
|
+
### HTTP request headers
|
|
1201
|
+
|
|
1202
|
+
- **Content-Type**: application/json
|
|
1203
|
+
- **Accept**: application/json
|
|
1204
|
+
|
|
@@ -4,11 +4,11 @@
|
|
|
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. |
|
|
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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**order_id** | **String** | The order ID. |
|
|
9
9
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
10
|
-
**token_id** | **String** |
|
|
11
|
-
**chain_id** | **String** |
|
|
10
|
+
**token_id** | **String** | The ID of the cryptocurrency used for payment. Supported tokens: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
11
|
+
**chain_id** | **String** | The ID of the blockchain network where the payment transaction should be made. Supported chains: - USDC: `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` - USDT: `TRON`, `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` |
|
|
12
12
|
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
13
13
|
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
14
14
|
**currency** | **String** | The fiat currency of the order. |
|
|
@@ -20,9 +20,10 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
21
21
|
**status** | [**OrderStatus**](OrderStatus.md) | |
|
|
22
22
|
**received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
|
23
|
-
**created_timestamp** | **Number** | The
|
|
24
|
-
**updated_timestamp** | **Number** | The
|
|
25
|
-
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the
|
|
23
|
+
**created_timestamp** | **Number** | The creation time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
24
|
+
**updated_timestamp** | **Number** | The last update time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
25
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the pay-in process. | [optional]
|
|
26
|
+
**settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
26
27
|
|
|
27
28
|
|
|
28
29
|
|
|
@@ -45,6 +46,8 @@ Name | Type | Description | Notes
|
|
|
45
46
|
|
|
46
47
|
* `TokenListing` (value: `"TokenListing"`)
|
|
47
48
|
|
|
49
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
50
|
+
|
|
48
51
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
49
52
|
|
|
50
53
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
@@ -4,10 +4,10 @@
|
|
|
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. |
|
|
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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement 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
|
-
**order_id** | **String** | The order
|
|
10
|
+
**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional]
|
|
11
11
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
12
12
|
**token_id** | **String** | The ID of the cryptocurrency used for refund. |
|
|
13
13
|
**chain_id** | **String** | The ID of the blockchain network on which the refund transaction occurs. |
|
|
@@ -15,10 +15,13 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**to_address** | **String** | The recipient's wallet address where the refund will be sent. |
|
|
16
16
|
**status** | [**RefundStatus**](RefundStatus.md) | |
|
|
17
17
|
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
18
|
-
**created_timestamp** | **Number** | The
|
|
19
|
-
**updated_timestamp** | **Number** | The
|
|
20
|
-
**initiator** | **String** |
|
|
18
|
+
**created_timestamp** | **Number** | The creation time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
19
|
+
**updated_timestamp** | **Number** | The last update time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
20
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payment Management App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID. | [optional]
|
|
21
21
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional]
|
|
22
|
+
**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee. | [optional]
|
|
23
|
+
**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional]
|
|
24
|
+
**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional]
|
|
22
25
|
|
|
23
26
|
|
|
24
27
|
|
|
@@ -41,6 +44,8 @@ Name | Type | Description | Notes
|
|
|
41
44
|
|
|
42
45
|
* `TokenListing` (value: `"TokenListing"`)
|
|
43
46
|
|
|
47
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
48
|
+
|
|
44
49
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
45
50
|
|
|
46
51
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
@@ -4,14 +4,14 @@
|
|
|
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. |
|
|
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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
|
|
9
9
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
10
10
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
11
11
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
12
|
-
**created_timestamp** | **Number** | The
|
|
13
|
-
**updated_timestamp** | **Number** | The
|
|
14
|
-
**initiator** | **String** |
|
|
12
|
+
**created_timestamp** | **Number** | The creation time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
**updated_timestamp** | **Number** | The last update time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
14
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payment Management App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID. | [optional]
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
|
@@ -34,6 +34,8 @@ Name | Type | Description | Notes
|
|
|
34
34
|
|
|
35
35
|
* `TokenListing` (value: `"TokenListing"`)
|
|
36
36
|
|
|
37
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
38
|
+
|
|
37
39
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
38
40
|
|
|
39
41
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**type** | **String** | The quorum
|
|
8
|
-
**roles** | **[String]** |
|
|
9
|
-
**user_ids** | **[String]** |
|
|
10
|
-
**threshold** | **Number** | The number of
|
|
7
|
+
**type** | **String** | The quorum type. Possible values include: - `FULL_APPROVAL`: Requires approval from all participants. - `PART_APPROVAL`: Requires approval from a specified number of participants. |
|
|
8
|
+
**roles** | **[String]** | The roles included in the quorum. Possible values include `admin`, `spender`, `operator`, and `approver`. | [optional]
|
|
9
|
+
**user_ids** | **[String]** | The ID of the users included in the quorum. | [optional]
|
|
10
|
+
**threshold** | **Number** | The number of approvers required to meet the quorum. | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
|
package/docs/PolicyCondition.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**field** | **String** | The
|
|
7
|
+
**field** | **String** | The field name. |
|
|
8
8
|
**value_type** | [**PolicyFieldValueType**](PolicyFieldValueType.md) | |
|
|
9
|
-
**value** | **String** | The
|
|
9
|
+
**value** | **String** | The field value. |
|
|
10
10
|
**operator** | [**PolicyFieldOperator**](PolicyFieldOperator.md) | |
|
|
11
11
|
|
|
12
12
|
|
package/docs/Refund.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**request_id** | **String** | The request ID provided by you when creating the refund request. | [optional]
|
|
8
8
|
**refund_id** | **String** | The refund order ID. |
|
|
9
|
-
**order_id** | **String** | The order
|
|
9
|
+
**order_id** | **String** | The ID of the pay-in order corresponding to this refund. | [optional]
|
|
10
10
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
11
11
|
**token_id** | **String** | The ID of the cryptocurrency used for refund. |
|
|
12
12
|
**chain_id** | **String** | The ID of the blockchain network on which the refund transaction occurs. |
|
|
@@ -14,9 +14,12 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**to_address** | **String** | The recipient's wallet address where the refund will be sent. |
|
|
15
15
|
**status** | [**RefundStatus**](RefundStatus.md) | |
|
|
16
16
|
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
17
|
-
**created_timestamp** | **Number** | The
|
|
18
|
-
**updated_timestamp** | **Number** | The
|
|
19
|
-
**initiator** | **String** |
|
|
17
|
+
**created_timestamp** | **Number** | The creation time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
|
+
**updated_timestamp** | **Number** | The last update time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
19
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payment Management App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID. | [optional]
|
|
20
20
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional]
|
|
21
|
+
**charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee. | [optional]
|
|
22
|
+
**merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional]
|
|
23
|
+
**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional]
|
|
21
24
|
|
|
22
25
|
|