@cobo/cobo-waas2 1.23.0 → 1.24.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 +45 -6
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +6 -6
- package/dist/api/FeeStationApi.js +47 -4
- package/dist/api/PaymentApi.js +194 -47
- package/dist/api/SwapsApi.js +374 -0
- package/dist/api/TransactionsApi.js +4 -4
- package/dist/index.js +224 -14
- package/dist/model/AddressInfo.js +13 -0
- package/dist/model/AddressesEventDataAllOfAddresses.js +18 -0
- package/dist/model/BridgingFee.js +136 -0
- package/dist/model/CommissionFee.js +110 -0
- package/dist/model/ContractCallDestination.js +48 -8
- package/dist/model/ContractCallDestinationType.js +5 -0
- package/dist/model/CreateMerchantRequest.js +13 -6
- package/dist/model/CreatePaymentOrderRequest.js +14 -1
- package/dist/model/CreateSettlement.js +2 -2
- package/dist/model/CreateSettlementRequestRequest.js +39 -0
- package/dist/model/CreateSwapActivityRequest.js +193 -0
- package/dist/model/CustodialTransferDestination.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +1 -1
- package/dist/model/EstimateFeeParams.js +1 -1
- package/dist/model/EstimateTransferFeeParams.js +1 -1
- package/dist/model/EstimatedEvmEip1559Fee.js +1 -1
- package/dist/model/EstimatedEvmLegacyFee.js +1 -1
- package/dist/model/EstimatedFILFee.js +1 -1
- package/dist/model/EstimatedFixedFee.js +1 -1
- package/dist/model/EstimatedSOLFee.js +1 -1
- package/dist/model/EstimatedUtxoFee.js +1 -1
- package/dist/model/FeeStationCheckFeeStationUsage.js +186 -0
- package/dist/model/FeeStationCheckFeeStationUsageResponse.js +200 -0
- package/dist/model/FeeStationGasStationType.js +61 -0
- package/dist/model/ListSwapActivities200Response.js +123 -0
- package/dist/model/ListSwapEnabledTokens200Response.js +123 -0
- package/dist/model/ListTopUpPayerAccounts200Response.js +123 -0
- package/dist/model/Merchant.js +9 -0
- package/dist/model/MerchantBalance.js +3 -3
- package/dist/model/MessageSignDestination.js +8 -70
- package/dist/model/OtcFee.js +123 -0
- package/dist/model/PaymentEstimateFee.js +125 -0
- package/dist/model/PaymentEstimateFee201Response.js +107 -0
- package/dist/model/{RawMessageSignDestination.js → PaymentEstimateFeeRequest.js} +51 -37
- package/dist/model/PaymentEstimatedFee.js +173 -0
- package/dist/model/PaymentFeeType.js +71 -0
- package/dist/model/PaymentRefundEventData.js +22 -2
- package/dist/model/PaymentSettlementEvent.js +62 -6
- package/dist/model/PspBalance.js +3 -3
- package/dist/model/Refund.js +17 -1
- package/dist/model/SettleRequestStatus.js +5 -0
- package/dist/model/Settlement.js +45 -3
- package/dist/model/SettlementDetail.js +33 -1
- package/dist/model/SettlementInfo.js +7 -7
- package/dist/model/SolContractCallAddressLookupTableAccount.js +126 -0
- package/dist/model/SolContractCallDestination.js +30 -0
- package/dist/model/StellarContractCallContractParam.js +164 -0
- package/dist/model/StellarContractCallContractType.js +56 -0
- package/dist/model/StellarContractCallDestination.js +125 -0
- package/dist/model/StellarContractCallTrustLineOperationType.js +56 -0
- package/dist/model/StellarContractCallTrustLineParam.js +133 -0
- package/dist/model/SupportedToken.js +9 -0
- package/dist/model/SwapActivity.js +9 -9
- package/dist/model/SwapActivityApprovers.js +1 -1
- package/dist/model/SwapActivityDetail.js +34 -18
- package/dist/model/SwapActivitySigners.js +2 -2
- package/dist/model/SwapActivityTimeline.js +5 -5
- package/dist/model/SwapEstimateFee.js +147 -0
- package/dist/model/SwapQuote.js +18 -31
- package/dist/model/SwapReceivingTransaction.js +133 -0
- package/dist/model/SwapToken.js +9 -9
- package/dist/model/TransactionCoboCategory.js +5 -0
- package/dist/model/TransactionDestination.js +48 -8
- package/dist/model/TransactionDestinationType.js +5 -0
- package/dist/model/TransactionEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionEvmLegacyFee.js +1 -1
- package/dist/model/TransactionFILFee.js +1 -1
- package/dist/model/TransactionFixedFee.js +1 -1
- package/dist/model/TransactionFuelingInfo.js +13 -0
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFILFee.js +1 -1
- package/dist/model/TransactionRequestSOLFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionSOLFee.js +1 -1
- package/dist/model/TransactionSolContractAddressLookupTableAccount.js +126 -0
- package/dist/model/TransactionSolContractDestination.js +30 -0
- package/dist/model/TransactionStellarContractParam.js +164 -0
- package/dist/model/TransactionStellarContractType.js +56 -0
- package/dist/model/{BTCEIP191MessageSignDestination.js → TransactionStellarDestination.js} +38 -35
- package/dist/model/TransactionStellarTrustLineOperationType.js +56 -0
- package/dist/model/TransactionStellarTrustLineParam.js +133 -0
- package/dist/model/TransactionUtxoFee.js +1 -1
- package/dist/model/UpdateBankAccountByIdRequest.js +108 -0
- package/dist/model/UpdateTopUpAddress.js +4 -6
- package/dist/model/WalletSetup.js +66 -0
- package/dist/model/WebhookEventData.js +19 -1
- package/docs/AddressBooksApi.md +3 -3
- package/docs/AddressInfo.md +1 -0
- package/docs/AddressesEventDataAllOfAddresses.md +1 -0
- package/docs/BridgingFee.md +11 -0
- package/docs/CommissionFee.md +9 -0
- package/docs/ContractCallDestination.md +2 -0
- package/docs/ContractCallDestinationType.md +2 -0
- package/docs/CreateMerchantRequest.md +2 -1
- package/docs/CreatePaymentOrderRequest.md +2 -1
- package/docs/CreateSettlement.md +2 -2
- package/docs/CreateSettlementRequestRequest.md +3 -0
- package/docs/CreateSwapActivityRequest.md +15 -0
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +1 -1
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/FeeStationApi.md +53 -0
- package/docs/FeeStationCheckFeeStationUsage.md +14 -0
- package/docs/FeeStationCheckFeeStationUsageResponse.md +16 -0
- package/docs/FeeStationGasStationType.md +12 -0
- package/docs/ListSwapActivities200Response.md +10 -0
- package/docs/ListSwapEnabledTokens200Response.md +10 -0
- package/docs/ListTopUpPayerAccounts200Response.md +10 -0
- package/docs/Merchant.md +1 -0
- package/docs/MerchantBalance.md +3 -3
- package/docs/MessageSignDestination.md +0 -1
- package/docs/OtcFee.md +10 -0
- package/docs/PaymentApi.md +196 -21
- package/docs/PaymentEstimateFee.md +10 -0
- package/docs/PaymentEstimateFee201Response.md +9 -0
- package/docs/PaymentEstimateFeeRequest.md +10 -0
- package/docs/PaymentEstimatedFee.md +13 -0
- package/docs/PaymentFeeType.md +16 -0
- package/docs/PaymentRefundEventData.md +2 -1
- package/docs/PaymentSettlementEvent.md +6 -3
- package/docs/PspBalance.md +3 -3
- package/docs/Refund.md +2 -1
- package/docs/SettleRequestStatus.md +2 -0
- package/docs/Settlement.md +6 -3
- package/docs/SettlementDetail.md +3 -1
- package/docs/SettlementInfo.md +6 -6
- package/docs/SolContractCallAddressLookupTableAccount.md +10 -0
- package/docs/SolContractCallDestination.md +1 -0
- package/docs/StellarContractCallContractParam.md +11 -0
- package/docs/StellarContractCallContractType.md +10 -0
- package/docs/StellarContractCallDestination.md +10 -0
- package/docs/StellarContractCallTrustLineOperationType.md +10 -0
- package/docs/StellarContractCallTrustLineParam.md +11 -0
- package/docs/SupportedToken.md +1 -0
- package/docs/SwapActivity.md +9 -9
- package/docs/SwapActivityDetail.md +10 -9
- package/docs/SwapActivitySigners.md +1 -1
- package/docs/SwapActivityTimeline.md +3 -3
- package/docs/SwapEstimateFee.md +12 -0
- package/docs/SwapQuote.md +10 -11
- package/docs/SwapReceivingTransaction.md +11 -0
- package/docs/SwapToken.md +6 -6
- package/docs/SwapsApi.md +356 -0
- package/docs/TransactionCoboCategory.md +2 -0
- package/docs/TransactionDestination.md +2 -0
- package/docs/TransactionDestinationType.md +2 -0
- package/docs/TransactionFuelingInfo.md +1 -0
- package/docs/TransactionSolContractAddressLookupTableAccount.md +10 -0
- package/docs/TransactionSolContractDestination.md +1 -0
- package/docs/TransactionStellarContractParam.md +11 -0
- package/docs/TransactionStellarContractType.md +10 -0
- package/docs/TransactionStellarDestination.md +10 -0
- package/docs/TransactionStellarTrustLineOperationType.md +10 -0
- package/docs/TransactionStellarTrustLineParam.md +11 -0
- package/docs/TransactionsApi.md +2 -2
- package/docs/UpdateBankAccountByIdRequest.md +9 -0
- package/docs/UpdateTopUpAddress.md +1 -1
- package/docs/WalletSetup.md +14 -0
- package/docs/WebhookEventData.md +4 -1
- package/package.json +1 -1
- package/docs/BTCEIP191MessageSignDestination.md +0 -10
- package/docs/RawMessageSignDestination.md +0 -10
package/docs/PaymentApi.md
CHANGED
|
@@ -31,7 +31,10 @@ Method | HTTP request | Description
|
|
|
31
31
|
[**listPaymentWalletBalances**](PaymentApi.md#listPaymentWalletBalances) | **GET** /payments/balance/payment_wallets | List payment wallet balances
|
|
32
32
|
[**listSettlementDetails**](PaymentApi.md#listSettlementDetails) | **GET** /payments/settlement_details | List all settlement details
|
|
33
33
|
[**listSettlementRequests**](PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
|
|
34
|
+
[**listTopUpPayerAccounts**](PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
|
|
34
35
|
[**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
|
|
36
|
+
[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Payment estimate fee
|
|
37
|
+
[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
35
38
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
36
39
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
37
40
|
[**updateRefundById**](PaymentApi.md#updateRefundById) | **PUT** /payments/refunds/{refund_id} | Update refund order
|
|
@@ -95,7 +98,7 @@ Name | Type | Description | Notes
|
|
|
95
98
|
|
|
96
99
|
Create crypto address
|
|
97
100
|
|
|
98
|
-
This operation registers a crypto address for crypto
|
|
101
|
+
This operation registers a crypto address for crypto payouts. The registered address can later be referenced by its ID when creating settlement requests.
|
|
99
102
|
|
|
100
103
|
### Example
|
|
101
104
|
|
|
@@ -147,7 +150,7 @@ Name | Type | Description | Notes
|
|
|
147
150
|
|
|
148
151
|
Create forced sweep
|
|
149
152
|
|
|
150
|
-
This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address.
|
|
153
|
+
<Warning>This operation has been deprecated.</Warning> This operation creates a forced sweep to transfer funds from addresses within a specified wallet to its designated sweep-to address.
|
|
151
154
|
|
|
152
155
|
### Example
|
|
153
156
|
|
|
@@ -505,7 +508,7 @@ Name | Type | Description | Notes
|
|
|
505
508
|
|
|
506
509
|
## getPayerBalanceByAddress
|
|
507
510
|
|
|
508
|
-
> [ReceivedAmountPerAddress] getPayerBalanceByAddress(
|
|
511
|
+
> [ReceivedAmountPerAddress] getPayerBalanceByAddress(payer_id, token_id, opts)
|
|
509
512
|
|
|
510
513
|
Get payer balance
|
|
511
514
|
|
|
@@ -523,10 +526,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
523
526
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
524
527
|
// Call the API
|
|
525
528
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
526
|
-
const merchant_id = "M1001";
|
|
527
529
|
const payer_id = "P20250619T0310056d7aa";
|
|
528
530
|
const token_id = "ETH_USDT";
|
|
529
|
-
|
|
531
|
+
const opts = {
|
|
532
|
+
'merchant_id': "M1001"
|
|
533
|
+
};
|
|
534
|
+
apiInstance.getPayerBalanceByAddress(payer_id, token_id, opts).then((data) => {
|
|
530
535
|
console.log('API called successfully. Returned data: ' + data);
|
|
531
536
|
}, (error) => {
|
|
532
537
|
console.error(error);
|
|
@@ -539,9 +544,9 @@ apiInstance.getPayerBalanceByAddress(merchant_id, payer_id, token_id).then((data
|
|
|
539
544
|
|
|
540
545
|
Name | Type | Description | Notes
|
|
541
546
|
------------- | ------------- | ------------- | -------------
|
|
542
|
-
**merchant_id** | **String**| The merchant ID. |
|
|
543
547
|
**payer_id** | **String**| Unique payer identifier on the Cobo side, auto-generated by the system. |
|
|
544
548
|
**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` |
|
|
549
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
545
550
|
|
|
546
551
|
### Return type
|
|
547
552
|
|
|
@@ -613,7 +618,7 @@ Name | Type | Description | Notes
|
|
|
613
618
|
|
|
614
619
|
Get developer balance
|
|
615
620
|
|
|
616
|
-
This operation retrieves the balance information for you as the developer. The balance information is grouped by token.
|
|
621
|
+
This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [Amounts and Balances](/v2/payments/amounts-and-balances)
|
|
617
622
|
|
|
618
623
|
### Example
|
|
619
624
|
|
|
@@ -825,7 +830,7 @@ Name | Type | Description | Notes
|
|
|
825
830
|
|
|
826
831
|
Get withdrawable balances
|
|
827
832
|
|
|
828
|
-
This operation retrieves the balances of specified merchants or the developer.
|
|
833
|
+
<Warning>This operation has been deprecated.</Warning> This operation retrieves the balances of specified merchants or the developer.
|
|
829
834
|
|
|
830
835
|
### Example
|
|
831
836
|
|
|
@@ -877,7 +882,7 @@ Name | Type | Description | Notes
|
|
|
877
882
|
|
|
878
883
|
## getTopUpAddress
|
|
879
884
|
|
|
880
|
-
> TopUpAddress getTopUpAddress(
|
|
885
|
+
> TopUpAddress getTopUpAddress(token_id, custom_payer_id, opts)
|
|
881
886
|
|
|
882
887
|
Get top-up address
|
|
883
888
|
|
|
@@ -895,10 +900,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
895
900
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
896
901
|
// Call the API
|
|
897
902
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
898
|
-
const merchant_id = "M1001";
|
|
899
903
|
const token_id = "ETH_USDT";
|
|
900
904
|
const custom_payer_id = "payer_0001";
|
|
901
|
-
|
|
905
|
+
const opts = {
|
|
906
|
+
'merchant_id': "M1001"
|
|
907
|
+
};
|
|
908
|
+
apiInstance.getTopUpAddress(token_id, custom_payer_id, opts).then((data) => {
|
|
902
909
|
console.log('API called successfully. Returned data: ' + data);
|
|
903
910
|
}, (error) => {
|
|
904
911
|
console.error(error);
|
|
@@ -911,9 +918,9 @@ apiInstance.getTopUpAddress(merchant_id, token_id, custom_payer_id).then((data)
|
|
|
911
918
|
|
|
912
919
|
Name | Type | Description | Notes
|
|
913
920
|
------------- | ------------- | ------------- | -------------
|
|
914
|
-
**merchant_id** | **String**| The merchant ID. |
|
|
915
921
|
**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` |
|
|
916
922
|
**custom_payer_id** | **String**| A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
923
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
917
924
|
|
|
918
925
|
### Return type
|
|
919
926
|
|
|
@@ -981,7 +988,7 @@ This endpoint does not need any parameter.
|
|
|
981
988
|
|
|
982
989
|
List crypto addresses
|
|
983
990
|
|
|
984
|
-
This operation retrieves a list of crypto addresses registered for crypto
|
|
991
|
+
This operation retrieves a list of crypto addresses registered for crypto payouts. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new crypto address.
|
|
985
992
|
|
|
986
993
|
### Example
|
|
987
994
|
|
|
@@ -1033,7 +1040,7 @@ Name | Type | Description | Notes
|
|
|
1033
1040
|
|
|
1034
1041
|
List forced sweeps
|
|
1035
1042
|
|
|
1036
|
-
This operation retrieves the information of all forced sweeps.
|
|
1043
|
+
<Warning>This operation has been deprecated.</Warning> This operation retrieves the information of all forced sweeps.
|
|
1037
1044
|
|
|
1038
1045
|
### Example
|
|
1039
1046
|
|
|
@@ -1091,7 +1098,7 @@ Name | Type | Description | Notes
|
|
|
1091
1098
|
|
|
1092
1099
|
List merchant balances
|
|
1093
1100
|
|
|
1094
|
-
This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned.
|
|
1101
|
+
This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned. For more information, please refer to [Amounts and Balances](/v2/payments/amounts-and-balances)
|
|
1095
1102
|
|
|
1096
1103
|
### Example
|
|
1097
1104
|
|
|
@@ -1166,7 +1173,8 @@ const opts = {
|
|
|
1166
1173
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1167
1174
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1168
1175
|
'keyword': "keyword",
|
|
1169
|
-
'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479"
|
|
1176
|
+
'wallet_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
1177
|
+
'wallet_setup': new CoboWaas2.WalletSetup()
|
|
1170
1178
|
};
|
|
1171
1179
|
apiInstance.listMerchants(opts).then((data) => {
|
|
1172
1180
|
console.log('API called successfully. Returned data: ' + data);
|
|
@@ -1186,6 +1194,7 @@ Name | Type | Description | Notes
|
|
|
1186
1194
|
**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]
|
|
1187
1195
|
**keyword** | **String**| A search term used for fuzzy matching of merchant names. | [optional]
|
|
1188
1196
|
**wallet_id** | **String**| The wallet ID. | [optional]
|
|
1197
|
+
**wallet_setup** | [**WalletSetup**](.md)| WalletSetup defines the type of funds used in the merchant account, either \"Shared\" or \"Separate\" is allowed when creating a merchant: - `Default`: Wallet of psp owned default merchant. - `Shared`: Shared wallet of non-psp owned merchants. - `Separate`: Separate wallet of non-psp owned merchants. | [optional]
|
|
1189
1198
|
|
|
1190
1199
|
### Return type
|
|
1191
1200
|
|
|
@@ -1315,7 +1324,7 @@ This endpoint does not need any parameter.
|
|
|
1315
1324
|
|
|
1316
1325
|
List payment wallet balances
|
|
1317
1326
|
|
|
1318
|
-
This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the `wallet_ids` parameter, the balance information for all payment wallets will be returned.
|
|
1327
|
+
<Warning>This operation has been deprecated.</Warning> This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the `wallet_ids` parameter, the balance information for all payment wallets will be returned.
|
|
1319
1328
|
|
|
1320
1329
|
### Example
|
|
1321
1330
|
|
|
@@ -1481,9 +1490,69 @@ Name | Type | Description | Notes
|
|
|
1481
1490
|
- **Accept**: application/json
|
|
1482
1491
|
|
|
1483
1492
|
|
|
1493
|
+
## listTopUpPayerAccounts
|
|
1494
|
+
|
|
1495
|
+
> ListTopUpPayerAccounts200Response listTopUpPayerAccounts(opts)
|
|
1496
|
+
|
|
1497
|
+
List top-up payer accounts
|
|
1498
|
+
|
|
1499
|
+
This operation retrieves the accounts of all payers. You can filter the result by merchant ID and payer_id.
|
|
1500
|
+
|
|
1501
|
+
### Example
|
|
1502
|
+
|
|
1503
|
+
```javascript
|
|
1504
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1505
|
+
// Initialize the API client
|
|
1506
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1507
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1508
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1509
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1510
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1511
|
+
// Call the API
|
|
1512
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1513
|
+
const opts = {
|
|
1514
|
+
'limit': 10,
|
|
1515
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1516
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1517
|
+
'merchant_id': "M1001",
|
|
1518
|
+
'payer_id': "P20250619T0310056d7aa"
|
|
1519
|
+
};
|
|
1520
|
+
apiInstance.listTopUpPayerAccounts(opts).then((data) => {
|
|
1521
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1522
|
+
}, (error) => {
|
|
1523
|
+
console.error(error);
|
|
1524
|
+
});
|
|
1525
|
+
|
|
1526
|
+
```
|
|
1527
|
+
|
|
1528
|
+
### Parameters
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
Name | Type | Description | Notes
|
|
1532
|
+
------------- | ------------- | ------------- | -------------
|
|
1533
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1534
|
+
**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]
|
|
1535
|
+
**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]
|
|
1536
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1537
|
+
**payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
1538
|
+
|
|
1539
|
+
### Return type
|
|
1540
|
+
|
|
1541
|
+
[**ListTopUpPayerAccounts200Response**](ListTopUpPayerAccounts200Response.md)
|
|
1542
|
+
|
|
1543
|
+
### Authorization
|
|
1544
|
+
|
|
1545
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1546
|
+
|
|
1547
|
+
### HTTP request headers
|
|
1548
|
+
|
|
1549
|
+
- **Content-Type**: Not defined
|
|
1550
|
+
- **Accept**: application/json
|
|
1551
|
+
|
|
1552
|
+
|
|
1484
1553
|
## listTopUpPayers
|
|
1485
1554
|
|
|
1486
|
-
> ListTopUpPayers200Response listTopUpPayers(
|
|
1555
|
+
> ListTopUpPayers200Response listTopUpPayers(opts)
|
|
1487
1556
|
|
|
1488
1557
|
List payers
|
|
1489
1558
|
|
|
@@ -1501,14 +1570,14 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1501
1570
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1502
1571
|
// Call the API
|
|
1503
1572
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1504
|
-
const merchant_id = "M1001";
|
|
1505
1573
|
const opts = {
|
|
1506
1574
|
'limit': 10,
|
|
1507
1575
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1508
1576
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
1577
|
+
'merchant_id': "M1001",
|
|
1509
1578
|
'payer_id': "P20250619T0310056d7aa"
|
|
1510
1579
|
};
|
|
1511
|
-
apiInstance.listTopUpPayers(
|
|
1580
|
+
apiInstance.listTopUpPayers(opts).then((data) => {
|
|
1512
1581
|
console.log('API called successfully. Returned data: ' + data);
|
|
1513
1582
|
}, (error) => {
|
|
1514
1583
|
console.error(error);
|
|
@@ -1521,10 +1590,10 @@ apiInstance.listTopUpPayers(merchant_id, opts).then((data) => {
|
|
|
1521
1590
|
|
|
1522
1591
|
Name | Type | Description | Notes
|
|
1523
1592
|
------------- | ------------- | ------------- | -------------
|
|
1524
|
-
**merchant_id** | **String**| The merchant ID. |
|
|
1525
1593
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1526
1594
|
**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]
|
|
1527
1595
|
**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]
|
|
1596
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
1528
1597
|
**payer_id** | **String**| A unique identifier assigned by Cobo to track and identify individual payers. | [optional]
|
|
1529
1598
|
|
|
1530
1599
|
### Return type
|
|
@@ -1541,6 +1610,112 @@ Name | Type | Description | Notes
|
|
|
1541
1610
|
- **Accept**: application/json
|
|
1542
1611
|
|
|
1543
1612
|
|
|
1613
|
+
## paymentEstimateFee
|
|
1614
|
+
|
|
1615
|
+
> PaymentEstimateFee201Response paymentEstimateFee(opts)
|
|
1616
|
+
|
|
1617
|
+
Payment estimate fee
|
|
1618
|
+
|
|
1619
|
+
This operation to payment estimate fee.
|
|
1620
|
+
|
|
1621
|
+
### Example
|
|
1622
|
+
|
|
1623
|
+
```javascript
|
|
1624
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1625
|
+
// Initialize the API client
|
|
1626
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1627
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1628
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1629
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1630
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1631
|
+
// Call the API
|
|
1632
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1633
|
+
const opts = {
|
|
1634
|
+
'PaymentEstimateFeeRequest': new CoboWaas2.PaymentEstimateFeeRequest()
|
|
1635
|
+
};
|
|
1636
|
+
apiInstance.paymentEstimateFee(opts).then((data) => {
|
|
1637
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1638
|
+
}, (error) => {
|
|
1639
|
+
console.error(error);
|
|
1640
|
+
});
|
|
1641
|
+
|
|
1642
|
+
```
|
|
1643
|
+
|
|
1644
|
+
### Parameters
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
Name | Type | Description | Notes
|
|
1648
|
+
------------- | ------------- | ------------- | -------------
|
|
1649
|
+
**PaymentEstimateFeeRequest** | [**PaymentEstimateFeeRequest**](PaymentEstimateFeeRequest.md)| The request body to create a estimated fee request. | [optional]
|
|
1650
|
+
|
|
1651
|
+
### Return type
|
|
1652
|
+
|
|
1653
|
+
[**PaymentEstimateFee201Response**](PaymentEstimateFee201Response.md)
|
|
1654
|
+
|
|
1655
|
+
### Authorization
|
|
1656
|
+
|
|
1657
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1658
|
+
|
|
1659
|
+
### HTTP request headers
|
|
1660
|
+
|
|
1661
|
+
- **Content-Type**: application/json
|
|
1662
|
+
- **Accept**: application/json
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
## updateBankAccountById
|
|
1666
|
+
|
|
1667
|
+
> BankAccount updateBankAccountById(bank_account_id, opts)
|
|
1668
|
+
|
|
1669
|
+
Update bank account
|
|
1670
|
+
|
|
1671
|
+
This operation updates the information of an existing bank account.
|
|
1672
|
+
|
|
1673
|
+
### Example
|
|
1674
|
+
|
|
1675
|
+
```javascript
|
|
1676
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1677
|
+
// Initialize the API client
|
|
1678
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1679
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1680
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1681
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1682
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1683
|
+
// Call the API
|
|
1684
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1685
|
+
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
1686
|
+
const opts = {
|
|
1687
|
+
'UpdateBankAccountByIdRequest': new CoboWaas2.UpdateBankAccountByIdRequest()
|
|
1688
|
+
};
|
|
1689
|
+
apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
|
|
1690
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1691
|
+
}, (error) => {
|
|
1692
|
+
console.error(error);
|
|
1693
|
+
});
|
|
1694
|
+
|
|
1695
|
+
```
|
|
1696
|
+
|
|
1697
|
+
### Parameters
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
Name | Type | Description | Notes
|
|
1701
|
+
------------- | ------------- | ------------- | -------------
|
|
1702
|
+
**bank_account_id** | **String**| The bank account ID. |
|
|
1703
|
+
**UpdateBankAccountByIdRequest** | [**UpdateBankAccountByIdRequest**](UpdateBankAccountByIdRequest.md)| The request body for updating an existing bank account. | [optional]
|
|
1704
|
+
|
|
1705
|
+
### Return type
|
|
1706
|
+
|
|
1707
|
+
[**BankAccount**](BankAccount.md)
|
|
1708
|
+
|
|
1709
|
+
### Authorization
|
|
1710
|
+
|
|
1711
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1712
|
+
|
|
1713
|
+
### HTTP request headers
|
|
1714
|
+
|
|
1715
|
+
- **Content-Type**: application/json
|
|
1716
|
+
- **Accept**: application/json
|
|
1717
|
+
|
|
1718
|
+
|
|
1544
1719
|
## updateMerchantById
|
|
1545
1720
|
|
|
1546
1721
|
> Merchant updateMerchantById(merchant_id, opts)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.PaymentEstimateFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**token_id** | **String** | The ID of the cryptocurrency you want to OffRamp settle. |
|
|
8
|
+
**amount** | **String** | The OffRamp settlement amount. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.PaymentEstimateFeeRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**fee_type** | [**PaymentFeeType**](PaymentFeeType.md) | | [optional]
|
|
8
|
+
**estimate_fees** | [**[PaymentEstimateFee]**](PaymentEstimateFee.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.PaymentEstimatedFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**token_id** | **String** | The ID of the cryptocurrency you want to payment. |
|
|
8
|
+
**amount** | **String** | The payment amount. |
|
|
9
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
|
|
10
|
+
**bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional]
|
|
11
|
+
**otc_fee** | [**OtcFee**](OtcFee.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.PaymentFeeType
|
|
2
|
+
|
|
3
|
+
## Enum
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
* `Order` (value: `"Order"`)
|
|
7
|
+
|
|
8
|
+
* `Refund` (value: `"Refund"`)
|
|
9
|
+
|
|
10
|
+
* `CryptoSettlement` (value: `"CryptoSettlement"`)
|
|
11
|
+
|
|
12
|
+
* `OffRampSettlement` (value: `"OffRampSettlement"`)
|
|
13
|
+
|
|
14
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
15
|
+
|
|
16
|
+
|
|
@@ -17,11 +17,12 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
18
18
|
**created_timestamp** | **Number** | The creation time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
19
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
|
|
20
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payments App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments 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
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
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
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]
|
|
25
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
|
|
25
26
|
|
|
26
27
|
|
|
27
28
|
|
|
@@ -9,12 +9,15 @@ Name | Type | Description | Notes
|
|
|
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** | The initiator of this settlement request. Can return either an API key or the
|
|
12
|
+
**created_timestamp** | **Number** | The created time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
**updated_timestamp** | **Number** | The updated 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 Payments App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. | [optional]
|
|
15
15
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
16
16
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
17
17
|
**settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
|
|
18
|
+
**currency** | **String** | The fiat currency for the settlement request. | [optional]
|
|
19
|
+
**received_amount_fiat** | **String** | The received fiat amount of this settlement request. | [optional]
|
|
20
|
+
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
18
21
|
|
|
19
22
|
|
|
20
23
|
|
package/docs/PspBalance.md
CHANGED
|
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**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}`. |
|
|
8
8
|
**developer_fee_amount** | **String** | The total amount of the token that has been received as developer fee. | [optional]
|
|
9
|
-
**settled_amount** | **String** | The total amount of the token that has been
|
|
9
|
+
**settled_amount** | **String** | The total amount of the token that has been paid out from the developer's balance. | [optional]
|
|
10
10
|
**refunded_amount** | **String** | The total amount of the token that has been refunded from the developer's balance. | [optional]
|
|
11
|
-
**total_balance** | **String** |
|
|
12
|
-
**available_balance** | **String** |
|
|
11
|
+
**total_balance** | **String** | The total balance of the token available for payout or refund for the developer. `total_balance` = `developer_fee_amount` - `settled_amount` - `refunded_amount` For more information, please refer to [Amounts and Balances](/v2_cn/payments/amounts-and-balances) | [optional]
|
|
12
|
+
**available_balance** | **String** | This field has been deprecated. | [optional]
|
|
13
13
|
|
|
14
14
|
|
package/docs/Refund.md
CHANGED
|
@@ -16,10 +16,11 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
17
17
|
**created_timestamp** | **Number** | The creation time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
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
|
|
19
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payments App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments 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
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
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
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]
|
|
24
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
|
|
24
25
|
|
|
25
26
|
|
package/docs/Settlement.md
CHANGED
|
@@ -8,11 +8,14 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
9
9
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
10
10
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
11
|
-
**created_timestamp** | **Number** | The
|
|
12
|
-
**updated_timestamp** | **Number** | The
|
|
13
|
-
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the
|
|
11
|
+
**created_timestamp** | **Number** | The created time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
12
|
+
**updated_timestamp** | **Number** | The updated time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payments App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. | [optional]
|
|
14
14
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
15
15
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
16
16
|
**settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
|
|
17
|
+
**currency** | **String** | The fiat currency for the settlement request. | [optional]
|
|
18
|
+
**received_amount_fiat** | **String** | The received fiat amount of this settlement request. | [optional]
|
|
19
|
+
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
17
20
|
|
|
18
21
|
|
package/docs/SettlementDetail.md
CHANGED
|
@@ -15,10 +15,12 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this settlement request. Each transaction represents a separate blockchain operation related to the settlement process. | [optional]
|
|
16
16
|
**created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
17
17
|
**updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
|
-
**crypto_address_id** | **String** | The ID of the crypto address used for crypto
|
|
18
|
+
**crypto_address_id** | **String** | The ID of the crypto address used for crypto payouts. | [optional]
|
|
19
19
|
**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
|
|
20
20
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
21
21
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. | [optional]
|
|
22
22
|
**order_ids** | **[String]** | A list of unique order IDs to be included in this settlement. - This field is only applicable when `settlement_type` is set to `Merchant`. - If provided, the settlement will only apply to the specified orders. | [optional]
|
|
23
|
+
**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
|
|
24
|
+
**bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional]
|
|
23
25
|
|
|
24
26
|
|
package/docs/SettlementInfo.md
CHANGED
|
@@ -6,13 +6,13 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. For developer balance, this field will be empty. | [optional]
|
|
8
8
|
**token_id** | **String** | The ID of the cryptocurrency. | [optional]
|
|
9
|
-
**available_amount** | **String** | This field
|
|
10
|
-
**available_currency_balance** | **String** | This field
|
|
11
|
-
**pending_amount** | **String** | This field
|
|
12
|
-
**pending_currency_balance** | **String** | This field
|
|
9
|
+
**available_amount** | **String** | This field has been deprecated. |
|
|
10
|
+
**available_currency_balance** | **String** | This field has been deprecated. | [optional]
|
|
11
|
+
**pending_amount** | **String** | This field has been deprecated. | [optional]
|
|
12
|
+
**pending_currency_balance** | **String** | This field has been deprecated. | [optional]
|
|
13
13
|
**settled_amount** | **String** | The amount already settled, in the specified cryptocurrency. | [optional]
|
|
14
|
-
**available_balance** | **String** |
|
|
15
|
-
**total_balance** | **String** |
|
|
14
|
+
**available_balance** | **String** | This field has been deprecated. | [optional]
|
|
15
|
+
**total_balance** | **String** | The total balance in the specified cryptocurrency. | [optional]
|
|
16
16
|
**acquiring_type** | [**AcquiringType**](AcquiringType.md) | | [optional]
|
|
17
17
|
**created_timestamp** | **Number** | The creation time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
18
|
**updated_timestamp** | **Number** | The last update time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SolContractCallAddressLookupTableAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**alt_account_key** | **String** | The on-chain public key of the Address Lookup Table (ALT) account, identifying the specific lookup table. |
|
|
8
|
+
**addresses** | **[String]** | An array of stored account addresses within the lookup table, which can be referenced in transactions by index. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
8
|
**instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
|
|
9
|
+
**address_lookup_table_accounts** | [**[SolContractCallAddressLookupTableAccount]**](SolContractCallAddressLookupTableAccount.md) | | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.StellarContractCallContractParam
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**contract_type** | [**StellarContractCallContractType**](StellarContractCallContractType.md) | |
|
|
8
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. |
|
|
9
|
+
**operation_type** | [**StellarContractCallTrustLineOperationType**](StellarContractCallTrustLineOperationType.md) | |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.StellarContractCallDestination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) | |
|
|
8
|
+
**contract_param** | [**StellarContractCallContractParam**](StellarContractCallContractParam.md) | |
|
|
9
|
+
|
|
10
|
+
|