@cobo/cobo-waas2 1.30.0 → 1.31.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 +5 -36
- package/dist/ApiClient.js +1 -1
- package/dist/api/PaymentApi.js +39 -931
- package/dist/index.js +21 -105
- package/dist/model/Balance.js +14 -0
- package/dist/model/BridgingFee.js +9 -0
- package/dist/model/ContractCallParams.js +16 -0
- package/dist/model/CreatePaymentOrderRequest.js +4 -3
- package/dist/model/CreateTopUpAddresses.js +2 -2
- package/dist/model/CreateWalletAddress.js +2 -2
- package/dist/model/PaymentBridgeStatus.js +61 -0
- package/dist/model/PaymentBulkSendItem.js +9 -9
- package/dist/model/PaymentPayout.js +35 -4
- package/dist/model/PaymentPayoutDetail.js +49 -13
- package/dist/model/PaymentPayoutEvent.js +49 -13
- package/dist/model/PreCheck.js +89 -0
- package/dist/model/SkipCheckType.js +56 -0
- package/dist/model/SupportedToken.js +17 -17
- package/dist/model/TransferParams.js +16 -0
- package/dist/model/WebhookEventData.js +6 -0
- package/dist/model/WebhookEventType.js +15 -0
- package/docs/Balance.md +1 -0
- package/docs/BridgingFee.md +1 -0
- package/docs/ContractCallParams.md +1 -0
- package/docs/CreatePaymentOrderRequest.md +2 -2
- package/docs/CreateTopUpAddresses.md +1 -1
- package/docs/CreateWalletAddress.md +1 -1
- package/docs/PaymentApi.md +117 -1138
- package/docs/PaymentBridgeStatus.md +12 -0
- package/docs/PaymentBulkSendItem.md +5 -5
- package/docs/PaymentPayout.md +2 -1
- package/docs/PaymentPayoutDetail.md +2 -1
- package/docs/PaymentPayoutEvent.md +2 -1
- package/docs/PreCheck.md +9 -0
- package/docs/SkipCheckType.md +10 -0
- package/docs/SupportedToken.md +10 -10
- package/docs/TransferParams.md +1 -0
- package/docs/WebhookEventData.md +1 -0
- package/docs/WebhookEventType.md +6 -0
- package/package.json +1 -1
- package/dist/model/CreateCounterpartyWalletAddressRequest.js +0 -140
- package/dist/model/CreateDestinationBankAccountRequest.js +0 -272
- package/dist/model/CreateDestinationWalletAddressRequest.js +0 -140
- package/dist/model/DeleteCounterparty200Response.js +0 -110
- package/dist/model/DeleteCounterpartyWalletAddress200Response.js +0 -110
- package/dist/model/DeleteDestination200Response.js +0 -110
- package/dist/model/DeleteDestinationBankAccount200Response.js +0 -110
- package/dist/model/DeleteDestinationWalletAddress200Response.js +0 -110
- package/dist/model/EnableDestinationWhitelistRequest.js +0 -106
- package/dist/model/ListCounterpartyWalletAddress200Response.js +0 -123
- package/dist/model/ListDestinationBankAccounts200Response.js +0 -123
- package/dist/model/ListDestinationWalletAddresses200Response.js +0 -123
- package/dist/model/QueryDestinationWhitelistEnabled200Response.js +0 -106
- package/dist/model/UpdateCounterpartyByIdRequest.js +0 -160
- package/dist/model/UpdateDestinationByIdRequest.js +0 -173
- package/docs/CreateCounterpartyWalletAddressRequest.md +0 -11
- package/docs/CreateDestinationBankAccountRequest.md +0 -20
- package/docs/CreateDestinationWalletAddressRequest.md +0 -11
- package/docs/DeleteCounterparty200Response.md +0 -9
- package/docs/DeleteCounterpartyWalletAddress200Response.md +0 -9
- package/docs/DeleteDestination200Response.md +0 -9
- package/docs/DeleteDestinationBankAccount200Response.md +0 -9
- package/docs/DeleteDestinationWalletAddress200Response.md +0 -9
- package/docs/EnableDestinationWhitelistRequest.md +0 -9
- package/docs/ListCounterpartyWalletAddress200Response.md +0 -10
- package/docs/ListDestinationBankAccounts200Response.md +0 -10
- package/docs/ListDestinationWalletAddresses200Response.md +0 -10
- package/docs/QueryDestinationWhitelistEnabled200Response.md +0 -9
- package/docs/UpdateCounterpartyByIdRequest.md +0 -13
- package/docs/UpdateDestinationByIdRequest.md +0 -14
package/docs/PaymentApi.md
CHANGED
|
@@ -10,12 +10,9 @@ Method | HTTP request | Description
|
|
|
10
10
|
[**createBulkSend**](PaymentApi.md#createBulkSend) | **POST** /payments/bulk_sends | Create bulk send
|
|
11
11
|
[**createCounterparty**](PaymentApi.md#createCounterparty) | **POST** /payments/counterparty | Create counterparty
|
|
12
12
|
[**createCounterpartyEntry**](PaymentApi.md#createCounterpartyEntry) | **POST** /payments/counterparty_entry | Create counterparty entry
|
|
13
|
-
[**createCounterpartyWalletAddress**](PaymentApi.md#createCounterpartyWalletAddress) | **POST** /payments/counterparty/wallet_address | Create counterparty wallet address
|
|
14
13
|
[**createCryptoAddress**](PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
|
|
15
14
|
[**createDestination**](PaymentApi.md#createDestination) | **POST** /payments/destination | Create destination
|
|
16
|
-
[**createDestinationBankAccount**](PaymentApi.md#createDestinationBankAccount) | **POST** /payments/destination/bank_account | Create destination bank account
|
|
17
15
|
[**createDestinationEntry**](PaymentApi.md#createDestinationEntry) | **POST** /payments/destination_entry | Create destination entry
|
|
18
|
-
[**createDestinationWalletAddress**](PaymentApi.md#createDestinationWalletAddress) | **POST** /payments/destination/wallet_address | Create destination wallet address
|
|
19
16
|
[**createForcedSweepRequest**](PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
|
|
20
17
|
[**createMerchant**](PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
21
18
|
[**createOrderLink**](PaymentApi.md#createOrderLink) | **POST** /payments/links/orders | Create order link
|
|
@@ -26,26 +23,17 @@ Method | HTTP request | Description
|
|
|
26
23
|
[**createReport**](PaymentApi.md#createReport) | **POST** /payments/reports | Generate reports
|
|
27
24
|
[**createSettlementRequest**](PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
|
|
28
25
|
[**createTopUpAddresses**](PaymentApi.md#createTopUpAddresses) | **POST** /payments/topup/address | Batch create top-up addresses
|
|
29
|
-
[**deleteCounterparty**](PaymentApi.md#deleteCounterparty) | **PUT** /payments/counterparty/{counterparty_id}/delete | Delete counterparty (Deprecated)
|
|
30
26
|
[**deleteCounterpartyById**](PaymentApi.md#deleteCounterpartyById) | **DELETE** /payments/counterparty/{counterparty_id} | Delete counterparty
|
|
31
27
|
[**deleteCounterpartyEntry**](PaymentApi.md#deleteCounterpartyEntry) | **DELETE** /payments/counterparty_entry/{counterparty_entry_id} | Delete counterparty entry
|
|
32
|
-
[**deleteCounterpartyWalletAddress**](PaymentApi.md#deleteCounterpartyWalletAddress) | **PUT** /payments/counterparty/wallet_address/{wallet_address_id}/delete | Delete counterparty wallet address
|
|
33
28
|
[**deleteCryptoAddress**](PaymentApi.md#deleteCryptoAddress) | **POST** /payments/crypto_addresses/{crypto_address_id}/delete | Delete crypto address
|
|
34
|
-
[**deleteDestination**](PaymentApi.md#deleteDestination) | **PUT** /payments/destination/{destination_id}/delete | Delete destination (Deprecated)
|
|
35
|
-
[**deleteDestinationBankAccount**](PaymentApi.md#deleteDestinationBankAccount) | **PUT** /payments/destination/bank_account/{bank_account_id}/delete | Delete destination bank account
|
|
36
29
|
[**deleteDestinationById**](PaymentApi.md#deleteDestinationById) | **DELETE** /payments/destination/{destination_id} | Delete destination
|
|
37
30
|
[**deleteDestinationEntry**](PaymentApi.md#deleteDestinationEntry) | **DELETE** /payments/destination_entry/{destination_entry_id} | Delete destination entry
|
|
38
|
-
[**deleteDestinationWalletAddress**](PaymentApi.md#deleteDestinationWalletAddress) | **PUT** /payments/destination/wallet_address/{wallet_address_id}/delete | Delete destination wallet address
|
|
39
|
-
[**enableDestinationWhitelist**](PaymentApi.md#enableDestinationWhitelist) | **POST** /payments/destination/enable_whitelist | Enable or disable destination whitelist
|
|
40
31
|
[**getAvailableAllocationAmount**](PaymentApi.md#getAvailableAllocationAmount) | **GET** /payments/allocation_amount | Get available allocation amount
|
|
41
32
|
[**getBatchAllocationById**](PaymentApi.md#getBatchAllocationById) | **GET** /payments/batch_allocations/{batch_allocation_id} | Get batch allocation information
|
|
42
33
|
[**getBulkSendById**](PaymentApi.md#getBulkSendById) | **GET** /payments/bulk_sends/{bulk_send_id} | Get bulk send information
|
|
43
34
|
[**getCounterparty**](PaymentApi.md#getCounterparty) | **GET** /payments/counterparty/{counterparty_id} | Get counterparty information
|
|
44
|
-
[**getCounterpartyDetailById**](PaymentApi.md#getCounterpartyDetailById) | **GET** /payments/counterparty/{counterparty_id}/detail | Get counterparty information (Deprecated)
|
|
45
35
|
[**getCounterpartyEntry**](PaymentApi.md#getCounterpartyEntry) | **GET** /payments/counterparty_entry/{counterparty_entry_id} | Get counterparty entry information
|
|
46
36
|
[**getDestination**](PaymentApi.md#getDestination) | **GET** /payments/destination/{destination_id} | Get destination information
|
|
47
|
-
[**getDestinationBankAccountDetailById**](PaymentApi.md#getDestinationBankAccountDetailById) | **GET** /payments/destination/bank_account/{bank_account_id}/detail | Get destination bank account information
|
|
48
|
-
[**getDestinationDetailById**](PaymentApi.md#getDestinationDetailById) | **GET** /payments/destination/{destination_id}/detail | Get destination information (Deprecated)
|
|
49
37
|
[**getDestinationEntry**](PaymentApi.md#getDestinationEntry) | **GET** /payments/destination_entry/{destination_entry_id} | Get destination entry information
|
|
50
38
|
[**getExchangeRate**](PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
|
|
51
39
|
[**getPaymentOrderDetailById**](PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
|
|
@@ -63,17 +51,14 @@ Method | HTTP request | Description
|
|
|
63
51
|
[**listBulkSendItems**](PaymentApi.md#listBulkSendItems) | **GET** /payments/bulk_sends/{bulk_send_id}/items | List bulk send items
|
|
64
52
|
[**listCounterparties**](PaymentApi.md#listCounterparties) | **GET** /payments/counterparty | List all counterparties
|
|
65
53
|
[**listCounterpartyEntries**](PaymentApi.md#listCounterpartyEntries) | **GET** /payments/counterparty_entry | List counterparty entries
|
|
66
|
-
[**listCounterpartyWalletAddress**](PaymentApi.md#listCounterpartyWalletAddress) | **GET** /payments/counterparty/wallet_address | List counterparty wallet addresses
|
|
67
54
|
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
68
|
-
[**listDestinationBankAccounts**](PaymentApi.md#listDestinationBankAccounts) | **GET** /payments/destination/bank_account | List destination bank accounts
|
|
69
55
|
[**listDestinationEntries**](PaymentApi.md#listDestinationEntries) | **GET** /payments/destination_entry | List destination entries
|
|
70
|
-
[**listDestinationWalletAddresses**](PaymentApi.md#listDestinationWalletAddresses) | **GET** /payments/destination/wallet_address | List destination wallet addresses
|
|
71
56
|
[**listDestinations**](PaymentApi.md#listDestinations) | **GET** /payments/destination | List all destinations
|
|
72
57
|
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List forced sweeps
|
|
73
58
|
[**listMerchantBalances**](PaymentApi.md#listMerchantBalances) | **GET** /payments/balance/merchants | List merchant balances
|
|
74
59
|
[**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
|
|
75
60
|
[**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
|
|
76
|
-
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List
|
|
61
|
+
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List supported tokens
|
|
77
62
|
[**listPaymentWalletBalances**](PaymentApi.md#listPaymentWalletBalances) | **GET** /payments/balance/payment_wallets | List payment wallet balances
|
|
78
63
|
[**listPayouts**](PaymentApi.md#listPayouts) | **GET** /payments/payouts | List all payouts
|
|
79
64
|
[**listSettlementDetails**](PaymentApi.md#listSettlementDetails) | **GET** /payments/settlement_details | List all settlement details
|
|
@@ -81,13 +66,9 @@ Method | HTTP request | Description
|
|
|
81
66
|
[**listTopUpPayerAccounts**](PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
|
|
82
67
|
[**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
|
|
83
68
|
[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
|
|
84
|
-
[**queryDestinationWhitelistEnabled**](PaymentApi.md#queryDestinationWhitelistEnabled) | **GET** /payments/destination/enable_whitelist | Query destination whitelist enabled status
|
|
85
69
|
[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
86
70
|
[**updateCounterparty**](PaymentApi.md#updateCounterparty) | **PUT** /payments/counterparty/{counterparty_id} | Update counterparty
|
|
87
|
-
[**updateCounterpartyById**](PaymentApi.md#updateCounterpartyById) | **PUT** /payments/counterparty/{counterparty_id}/update | Update counterparty (Deprecated)
|
|
88
71
|
[**updateDestination**](PaymentApi.md#updateDestination) | **PUT** /payments/destination/{destination_id} | Update destination
|
|
89
|
-
[**updateDestinationBankAccountById**](PaymentApi.md#updateDestinationBankAccountById) | **PUT** /payments/destination/bank_account/{bank_account_id}/update | Update destination bank account
|
|
90
|
-
[**updateDestinationById**](PaymentApi.md#updateDestinationById) | **PUT** /payments/destination/{destination_id}/update | Update destination (Deprecated)
|
|
91
72
|
[**updateDestinationEntry**](PaymentApi.md#updateDestinationEntry) | **PUT** /payments/destination_entry/{destination_entry_id} | Update destination entry
|
|
92
73
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
93
74
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
@@ -406,65 +387,13 @@ Name | Type | Description | Notes
|
|
|
406
387
|
- **Accept**: application/json
|
|
407
388
|
|
|
408
389
|
|
|
409
|
-
## createCounterpartyWalletAddress
|
|
410
|
-
|
|
411
|
-
> WalletAddress createCounterpartyWalletAddress(opts)
|
|
412
|
-
|
|
413
|
-
Create counterparty wallet address
|
|
414
|
-
|
|
415
|
-
This operation creates a counterparty wallet address.
|
|
416
|
-
|
|
417
|
-
### Example
|
|
418
|
-
|
|
419
|
-
```javascript
|
|
420
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
421
|
-
// Initialize the API client
|
|
422
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
423
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
424
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
425
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
426
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
427
|
-
// Call the API
|
|
428
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
429
|
-
const opts = {
|
|
430
|
-
'CreateCounterpartyWalletAddressRequest': new CoboWaas2.CreateCounterpartyWalletAddressRequest()
|
|
431
|
-
};
|
|
432
|
-
apiInstance.createCounterpartyWalletAddress(opts).then((data) => {
|
|
433
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
434
|
-
}, (error) => {
|
|
435
|
-
console.error(error);
|
|
436
|
-
});
|
|
437
|
-
|
|
438
|
-
```
|
|
439
|
-
|
|
440
|
-
### Parameters
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
Name | Type | Description | Notes
|
|
444
|
-
------------- | ------------- | ------------- | -------------
|
|
445
|
-
**CreateCounterpartyWalletAddressRequest** | [**CreateCounterpartyWalletAddressRequest**](CreateCounterpartyWalletAddressRequest.md)| The request body to create a counterparty wallet address. | [optional]
|
|
446
|
-
|
|
447
|
-
### Return type
|
|
448
|
-
|
|
449
|
-
[**WalletAddress**](WalletAddress.md)
|
|
450
|
-
|
|
451
|
-
### Authorization
|
|
452
|
-
|
|
453
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
454
|
-
|
|
455
|
-
### HTTP request headers
|
|
456
|
-
|
|
457
|
-
- **Content-Type**: application/json
|
|
458
|
-
- **Accept**: application/json
|
|
459
|
-
|
|
460
|
-
|
|
461
390
|
## createCryptoAddress
|
|
462
391
|
|
|
463
392
|
> CryptoAddress createCryptoAddress(opts)
|
|
464
393
|
|
|
465
394
|
Create crypto address
|
|
466
395
|
|
|
467
|
-
This operation registers a crypto address for crypto payouts. The registered address can later be referenced by its ID when creating settlement requests.
|
|
396
|
+
<Note>This operation has been deprecated.</Note> This operation registers a crypto address for crypto payouts. The registered address can later be referenced by its ID when creating settlement requests.
|
|
468
397
|
|
|
469
398
|
### Example
|
|
470
399
|
|
|
@@ -562,58 +491,6 @@ Name | Type | Description | Notes
|
|
|
562
491
|
- **Accept**: application/json
|
|
563
492
|
|
|
564
493
|
|
|
565
|
-
## createDestinationBankAccount
|
|
566
|
-
|
|
567
|
-
> DestinationBankAccount createDestinationBankAccount(opts)
|
|
568
|
-
|
|
569
|
-
Create destination bank account
|
|
570
|
-
|
|
571
|
-
This operation creates a destination bank account.
|
|
572
|
-
|
|
573
|
-
### Example
|
|
574
|
-
|
|
575
|
-
```javascript
|
|
576
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
577
|
-
// Initialize the API client
|
|
578
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
579
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
580
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
581
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
582
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
583
|
-
// Call the API
|
|
584
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
585
|
-
const opts = {
|
|
586
|
-
'CreateDestinationBankAccountRequest': new CoboWaas2.CreateDestinationBankAccountRequest()
|
|
587
|
-
};
|
|
588
|
-
apiInstance.createDestinationBankAccount(opts).then((data) => {
|
|
589
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
590
|
-
}, (error) => {
|
|
591
|
-
console.error(error);
|
|
592
|
-
});
|
|
593
|
-
|
|
594
|
-
```
|
|
595
|
-
|
|
596
|
-
### Parameters
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
Name | Type | Description | Notes
|
|
600
|
-
------------- | ------------- | ------------- | -------------
|
|
601
|
-
**CreateDestinationBankAccountRequest** | [**CreateDestinationBankAccountRequest**](CreateDestinationBankAccountRequest.md)| The request body to create a destination bank account. | [optional]
|
|
602
|
-
|
|
603
|
-
### Return type
|
|
604
|
-
|
|
605
|
-
[**DestinationBankAccount**](DestinationBankAccount.md)
|
|
606
|
-
|
|
607
|
-
### Authorization
|
|
608
|
-
|
|
609
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
610
|
-
|
|
611
|
-
### HTTP request headers
|
|
612
|
-
|
|
613
|
-
- **Content-Type**: application/json
|
|
614
|
-
- **Accept**: application/json
|
|
615
|
-
|
|
616
|
-
|
|
617
494
|
## createDestinationEntry
|
|
618
495
|
|
|
619
496
|
> CreateDestinationEntry201Response createDestinationEntry(opts)
|
|
@@ -666,58 +543,6 @@ Name | Type | Description | Notes
|
|
|
666
543
|
- **Accept**: application/json
|
|
667
544
|
|
|
668
545
|
|
|
669
|
-
## createDestinationWalletAddress
|
|
670
|
-
|
|
671
|
-
> WalletAddress createDestinationWalletAddress(opts)
|
|
672
|
-
|
|
673
|
-
Create destination wallet address
|
|
674
|
-
|
|
675
|
-
This operation creates a destination wallet address.
|
|
676
|
-
|
|
677
|
-
### Example
|
|
678
|
-
|
|
679
|
-
```javascript
|
|
680
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
681
|
-
// Initialize the API client
|
|
682
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
683
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
684
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
685
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
686
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
687
|
-
// Call the API
|
|
688
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
689
|
-
const opts = {
|
|
690
|
-
'CreateDestinationWalletAddressRequest': new CoboWaas2.CreateDestinationWalletAddressRequest()
|
|
691
|
-
};
|
|
692
|
-
apiInstance.createDestinationWalletAddress(opts).then((data) => {
|
|
693
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
694
|
-
}, (error) => {
|
|
695
|
-
console.error(error);
|
|
696
|
-
});
|
|
697
|
-
|
|
698
|
-
```
|
|
699
|
-
|
|
700
|
-
### Parameters
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
Name | Type | Description | Notes
|
|
704
|
-
------------- | ------------- | ------------- | -------------
|
|
705
|
-
**CreateDestinationWalletAddressRequest** | [**CreateDestinationWalletAddressRequest**](CreateDestinationWalletAddressRequest.md)| The request body to create a destination wallet address. | [optional]
|
|
706
|
-
|
|
707
|
-
### Return type
|
|
708
|
-
|
|
709
|
-
[**WalletAddress**](WalletAddress.md)
|
|
710
|
-
|
|
711
|
-
### Authorization
|
|
712
|
-
|
|
713
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
714
|
-
|
|
715
|
-
### HTTP request headers
|
|
716
|
-
|
|
717
|
-
- **Content-Type**: application/json
|
|
718
|
-
- **Accept**: application/json
|
|
719
|
-
|
|
720
|
-
|
|
721
546
|
## createForcedSweepRequest
|
|
722
547
|
|
|
723
548
|
> ForcedSweep createForcedSweepRequest(opts)
|
|
@@ -1238,56 +1063,6 @@ Name | Type | Description | Notes
|
|
|
1238
1063
|
- **Accept**: application/json
|
|
1239
1064
|
|
|
1240
1065
|
|
|
1241
|
-
## deleteCounterparty
|
|
1242
|
-
|
|
1243
|
-
> DeleteCounterparty200Response deleteCounterparty(counterparty_id)
|
|
1244
|
-
|
|
1245
|
-
Delete counterparty (Deprecated)
|
|
1246
|
-
|
|
1247
|
-
This operation deletes a counterparty.
|
|
1248
|
-
|
|
1249
|
-
### Example
|
|
1250
|
-
|
|
1251
|
-
```javascript
|
|
1252
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1253
|
-
// Initialize the API client
|
|
1254
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1255
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1256
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1257
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1258
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1259
|
-
// Call the API
|
|
1260
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1261
|
-
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1262
|
-
apiInstance.deleteCounterparty(counterparty_id).then((data) => {
|
|
1263
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1264
|
-
}, (error) => {
|
|
1265
|
-
console.error(error);
|
|
1266
|
-
});
|
|
1267
|
-
|
|
1268
|
-
```
|
|
1269
|
-
|
|
1270
|
-
### Parameters
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
Name | Type | Description | Notes
|
|
1274
|
-
------------- | ------------- | ------------- | -------------
|
|
1275
|
-
**counterparty_id** | **String**| The counterparty ID. |
|
|
1276
|
-
|
|
1277
|
-
### Return type
|
|
1278
|
-
|
|
1279
|
-
[**DeleteCounterparty200Response**](DeleteCounterparty200Response.md)
|
|
1280
|
-
|
|
1281
|
-
### Authorization
|
|
1282
|
-
|
|
1283
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1284
|
-
|
|
1285
|
-
### HTTP request headers
|
|
1286
|
-
|
|
1287
|
-
- **Content-Type**: Not defined
|
|
1288
|
-
- **Accept**: application/json
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
1066
|
## deleteCounterpartyById
|
|
1292
1067
|
|
|
1293
1068
|
> DeleteCounterpartyById200Response deleteCounterpartyById(counterparty_id)
|
|
@@ -1394,63 +1169,13 @@ Name | Type | Description | Notes
|
|
|
1394
1169
|
- **Accept**: application/json
|
|
1395
1170
|
|
|
1396
1171
|
|
|
1397
|
-
## deleteCounterpartyWalletAddress
|
|
1398
|
-
|
|
1399
|
-
> DeleteCounterpartyWalletAddress200Response deleteCounterpartyWalletAddress(wallet_address_id)
|
|
1400
|
-
|
|
1401
|
-
Delete counterparty wallet address
|
|
1402
|
-
|
|
1403
|
-
This operation deletes a counterparty wallet address.
|
|
1404
|
-
|
|
1405
|
-
### Example
|
|
1406
|
-
|
|
1407
|
-
```javascript
|
|
1408
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1409
|
-
// Initialize the API client
|
|
1410
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1411
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1412
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1413
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1414
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1415
|
-
// Call the API
|
|
1416
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1417
|
-
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1418
|
-
apiInstance.deleteCounterpartyWalletAddress(wallet_address_id).then((data) => {
|
|
1419
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1420
|
-
}, (error) => {
|
|
1421
|
-
console.error(error);
|
|
1422
|
-
});
|
|
1423
|
-
|
|
1424
|
-
```
|
|
1425
|
-
|
|
1426
|
-
### Parameters
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
Name | Type | Description | Notes
|
|
1430
|
-
------------- | ------------- | ------------- | -------------
|
|
1431
|
-
**wallet_address_id** | **String**| The wallet address ID. |
|
|
1432
|
-
|
|
1433
|
-
### Return type
|
|
1434
|
-
|
|
1435
|
-
[**DeleteCounterpartyWalletAddress200Response**](DeleteCounterpartyWalletAddress200Response.md)
|
|
1436
|
-
|
|
1437
|
-
### Authorization
|
|
1438
|
-
|
|
1439
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1440
|
-
|
|
1441
|
-
### HTTP request headers
|
|
1442
|
-
|
|
1443
|
-
- **Content-Type**: Not defined
|
|
1444
|
-
- **Accept**: application/json
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
1172
|
## deleteCryptoAddress
|
|
1448
1173
|
|
|
1449
1174
|
> DeleteCryptoAddress201Response deleteCryptoAddress(crypto_address_id)
|
|
1450
1175
|
|
|
1451
1176
|
Delete crypto address
|
|
1452
1177
|
|
|
1453
|
-
This operation unregisters a crypto address from being used for crypto payouts.
|
|
1178
|
+
<Note>This operation has been deprecated.</Note> This operation unregisters a crypto address from being used for crypto payouts.
|
|
1454
1179
|
|
|
1455
1180
|
### Example
|
|
1456
1181
|
|
|
@@ -1494,13 +1219,13 @@ Name | Type | Description | Notes
|
|
|
1494
1219
|
- **Accept**: application/json
|
|
1495
1220
|
|
|
1496
1221
|
|
|
1497
|
-
##
|
|
1222
|
+
## deleteDestinationById
|
|
1498
1223
|
|
|
1499
|
-
>
|
|
1224
|
+
> DeleteDestinationById200Response deleteDestinationById(destination_id)
|
|
1500
1225
|
|
|
1501
|
-
Delete destination
|
|
1226
|
+
Delete destination
|
|
1502
1227
|
|
|
1503
|
-
This operation deletes a destination.
|
|
1228
|
+
This operation deletes a destination. Note that this operation will delete all entries under the destination, including bank accounts and addresses.
|
|
1504
1229
|
|
|
1505
1230
|
### Example
|
|
1506
1231
|
|
|
@@ -1515,7 +1240,7 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
1515
1240
|
// Call the API
|
|
1516
1241
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1517
1242
|
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1518
|
-
apiInstance.
|
|
1243
|
+
apiInstance.deleteDestinationById(destination_id).then((data) => {
|
|
1519
1244
|
console.log('API called successfully. Returned data: ' + data);
|
|
1520
1245
|
}, (error) => {
|
|
1521
1246
|
console.error(error);
|
|
@@ -1532,7 +1257,7 @@ Name | Type | Description | Notes
|
|
|
1532
1257
|
|
|
1533
1258
|
### Return type
|
|
1534
1259
|
|
|
1535
|
-
[**
|
|
1260
|
+
[**DeleteDestinationById200Response**](DeleteDestinationById200Response.md)
|
|
1536
1261
|
|
|
1537
1262
|
### Authorization
|
|
1538
1263
|
|
|
@@ -1544,13 +1269,13 @@ Name | Type | Description | Notes
|
|
|
1544
1269
|
- **Accept**: application/json
|
|
1545
1270
|
|
|
1546
1271
|
|
|
1547
|
-
##
|
|
1272
|
+
## deleteDestinationEntry
|
|
1548
1273
|
|
|
1549
|
-
>
|
|
1274
|
+
> DeleteDestinationEntry200Response deleteDestinationEntry(destination_entry_id, destination_id, entry_type)
|
|
1550
1275
|
|
|
1551
|
-
Delete destination
|
|
1276
|
+
Delete destination entry
|
|
1552
1277
|
|
|
1553
|
-
This operation deletes a destination
|
|
1278
|
+
This operation deletes a destination entry.
|
|
1554
1279
|
|
|
1555
1280
|
### Example
|
|
1556
1281
|
|
|
@@ -1564,8 +1289,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1564
1289
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1565
1290
|
// Call the API
|
|
1566
1291
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1567
|
-
const
|
|
1568
|
-
|
|
1292
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1293
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1294
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
1295
|
+
apiInstance.deleteDestinationEntry(destination_entry_id, destination_id, entry_type).then((data) => {
|
|
1569
1296
|
console.log('API called successfully. Returned data: ' + data);
|
|
1570
1297
|
}, (error) => {
|
|
1571
1298
|
console.error(error);
|
|
@@ -1578,11 +1305,13 @@ apiInstance.deleteDestinationBankAccount(bank_account_id).then((data) => {
|
|
|
1578
1305
|
|
|
1579
1306
|
Name | Type | Description | Notes
|
|
1580
1307
|
------------- | ------------- | ------------- | -------------
|
|
1581
|
-
**
|
|
1308
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
1309
|
+
**destination_id** | **String**| The destination ID. |
|
|
1310
|
+
**entry_type** | [**EntryType**](.md)| EntryType defines the type of the counterparty entry: - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. |
|
|
1582
1311
|
|
|
1583
1312
|
### Return type
|
|
1584
1313
|
|
|
1585
|
-
[**
|
|
1314
|
+
[**DeleteDestinationEntry200Response**](DeleteDestinationEntry200Response.md)
|
|
1586
1315
|
|
|
1587
1316
|
### Authorization
|
|
1588
1317
|
|
|
@@ -1594,373 +1323,13 @@ Name | Type | Description | Notes
|
|
|
1594
1323
|
- **Accept**: application/json
|
|
1595
1324
|
|
|
1596
1325
|
|
|
1597
|
-
##
|
|
1598
|
-
|
|
1599
|
-
> DeleteDestinationById200Response deleteDestinationById(destination_id)
|
|
1600
|
-
|
|
1601
|
-
Delete destination
|
|
1602
|
-
|
|
1603
|
-
This operation deletes a destination. Note that this operation will delete all entries under the destination, including bank accounts and addresses.
|
|
1326
|
+
## getAvailableAllocationAmount
|
|
1604
1327
|
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
```javascript
|
|
1608
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1609
|
-
// Initialize the API client
|
|
1610
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1611
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1612
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1613
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1614
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1615
|
-
// Call the API
|
|
1616
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1617
|
-
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1618
|
-
apiInstance.deleteDestinationById(destination_id).then((data) => {
|
|
1619
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1620
|
-
}, (error) => {
|
|
1621
|
-
console.error(error);
|
|
1622
|
-
});
|
|
1623
|
-
|
|
1624
|
-
```
|
|
1625
|
-
|
|
1626
|
-
### Parameters
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
Name | Type | Description | Notes
|
|
1630
|
-
------------- | ------------- | ------------- | -------------
|
|
1631
|
-
**destination_id** | **String**| The destination ID. |
|
|
1632
|
-
|
|
1633
|
-
### Return type
|
|
1634
|
-
|
|
1635
|
-
[**DeleteDestinationById200Response**](DeleteDestinationById200Response.md)
|
|
1636
|
-
|
|
1637
|
-
### Authorization
|
|
1638
|
-
|
|
1639
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1640
|
-
|
|
1641
|
-
### HTTP request headers
|
|
1642
|
-
|
|
1643
|
-
- **Content-Type**: Not defined
|
|
1644
|
-
- **Accept**: application/json
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
## deleteDestinationEntry
|
|
1648
|
-
|
|
1649
|
-
> DeleteDestinationEntry200Response deleteDestinationEntry(destination_entry_id, destination_id, entry_type)
|
|
1650
|
-
|
|
1651
|
-
Delete destination entry
|
|
1652
|
-
|
|
1653
|
-
This operation deletes a destination entry.
|
|
1654
|
-
|
|
1655
|
-
### Example
|
|
1656
|
-
|
|
1657
|
-
```javascript
|
|
1658
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1659
|
-
// Initialize the API client
|
|
1660
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1661
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1662
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1663
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1664
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1665
|
-
// Call the API
|
|
1666
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1667
|
-
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1668
|
-
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1669
|
-
const entry_type = new CoboWaas2.EntryType();
|
|
1670
|
-
apiInstance.deleteDestinationEntry(destination_entry_id, destination_id, entry_type).then((data) => {
|
|
1671
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1672
|
-
}, (error) => {
|
|
1673
|
-
console.error(error);
|
|
1674
|
-
});
|
|
1675
|
-
|
|
1676
|
-
```
|
|
1677
|
-
|
|
1678
|
-
### Parameters
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
Name | Type | Description | Notes
|
|
1682
|
-
------------- | ------------- | ------------- | -------------
|
|
1683
|
-
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
1684
|
-
**destination_id** | **String**| The destination ID. |
|
|
1685
|
-
**entry_type** | [**EntryType**](.md)| EntryType defines the type of the counterparty entry: - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. |
|
|
1686
|
-
|
|
1687
|
-
### Return type
|
|
1688
|
-
|
|
1689
|
-
[**DeleteDestinationEntry200Response**](DeleteDestinationEntry200Response.md)
|
|
1690
|
-
|
|
1691
|
-
### Authorization
|
|
1692
|
-
|
|
1693
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1694
|
-
|
|
1695
|
-
### HTTP request headers
|
|
1696
|
-
|
|
1697
|
-
- **Content-Type**: Not defined
|
|
1698
|
-
- **Accept**: application/json
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
## deleteDestinationWalletAddress
|
|
1702
|
-
|
|
1703
|
-
> DeleteDestinationWalletAddress200Response deleteDestinationWalletAddress(wallet_address_id)
|
|
1704
|
-
|
|
1705
|
-
Delete destination wallet address
|
|
1706
|
-
|
|
1707
|
-
This operation deletes a destination wallet address.
|
|
1708
|
-
|
|
1709
|
-
### Example
|
|
1710
|
-
|
|
1711
|
-
```javascript
|
|
1712
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1713
|
-
// Initialize the API client
|
|
1714
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1715
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1716
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1717
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1718
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1719
|
-
// Call the API
|
|
1720
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1721
|
-
const wallet_address_id = "445bac57-7428-4d25-bce1-b3cd017f47a1";
|
|
1722
|
-
apiInstance.deleteDestinationWalletAddress(wallet_address_id).then((data) => {
|
|
1723
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1724
|
-
}, (error) => {
|
|
1725
|
-
console.error(error);
|
|
1726
|
-
});
|
|
1727
|
-
|
|
1728
|
-
```
|
|
1729
|
-
|
|
1730
|
-
### Parameters
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
Name | Type | Description | Notes
|
|
1734
|
-
------------- | ------------- | ------------- | -------------
|
|
1735
|
-
**wallet_address_id** | **String**| The wallet address ID. |
|
|
1736
|
-
|
|
1737
|
-
### Return type
|
|
1738
|
-
|
|
1739
|
-
[**DeleteDestinationWalletAddress200Response**](DeleteDestinationWalletAddress200Response.md)
|
|
1740
|
-
|
|
1741
|
-
### Authorization
|
|
1742
|
-
|
|
1743
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1744
|
-
|
|
1745
|
-
### HTTP request headers
|
|
1746
|
-
|
|
1747
|
-
- **Content-Type**: Not defined
|
|
1748
|
-
- **Accept**: application/json
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
## enableDestinationWhitelist
|
|
1752
|
-
|
|
1753
|
-
> QueryDestinationWhitelistEnabled200Response enableDestinationWhitelist(opts)
|
|
1754
|
-
|
|
1755
|
-
Enable or disable destination whitelist
|
|
1756
|
-
|
|
1757
|
-
This operation enables or disables the whitelist for a destination.
|
|
1758
|
-
|
|
1759
|
-
### Example
|
|
1760
|
-
|
|
1761
|
-
```javascript
|
|
1762
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1763
|
-
// Initialize the API client
|
|
1764
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1765
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1766
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1767
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1768
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1769
|
-
// Call the API
|
|
1770
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1771
|
-
const opts = {
|
|
1772
|
-
'EnableDestinationWhitelistRequest': new CoboWaas2.EnableDestinationWhitelistRequest()
|
|
1773
|
-
};
|
|
1774
|
-
apiInstance.enableDestinationWhitelist(opts).then((data) => {
|
|
1775
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1776
|
-
}, (error) => {
|
|
1777
|
-
console.error(error);
|
|
1778
|
-
});
|
|
1779
|
-
|
|
1780
|
-
```
|
|
1781
|
-
|
|
1782
|
-
### Parameters
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
Name | Type | Description | Notes
|
|
1786
|
-
------------- | ------------- | ------------- | -------------
|
|
1787
|
-
**EnableDestinationWhitelistRequest** | [**EnableDestinationWhitelistRequest**](EnableDestinationWhitelistRequest.md)| The request body to enable or disable the destination whitelist. | [optional]
|
|
1788
|
-
|
|
1789
|
-
### Return type
|
|
1790
|
-
|
|
1791
|
-
[**QueryDestinationWhitelistEnabled200Response**](QueryDestinationWhitelistEnabled200Response.md)
|
|
1792
|
-
|
|
1793
|
-
### Authorization
|
|
1794
|
-
|
|
1795
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1796
|
-
|
|
1797
|
-
### HTTP request headers
|
|
1798
|
-
|
|
1799
|
-
- **Content-Type**: application/json
|
|
1800
|
-
- **Accept**: application/json
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
## getAvailableAllocationAmount
|
|
1804
|
-
|
|
1805
|
-
> PaymentAllocationAmount getAvailableAllocationAmount(token_id, source_account, destination_account)
|
|
1328
|
+
> PaymentAllocationAmount getAvailableAllocationAmount(token_id, source_account, destination_account)
|
|
1806
1329
|
|
|
1807
1330
|
Get available allocation amount
|
|
1808
1331
|
|
|
1809
|
-
This operation retrieves the available amount that can be allocated from a source account to a destination account.
|
|
1810
|
-
|
|
1811
|
-
### Example
|
|
1812
|
-
|
|
1813
|
-
```javascript
|
|
1814
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1815
|
-
// Initialize the API client
|
|
1816
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1817
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1818
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1819
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1820
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1821
|
-
// Call the API
|
|
1822
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1823
|
-
const token_id = "ETH_USDT";
|
|
1824
|
-
const source_account = "source_account_example";
|
|
1825
|
-
const destination_account = "destination_account_example";
|
|
1826
|
-
apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_account).then((data) => {
|
|
1827
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1828
|
-
}, (error) => {
|
|
1829
|
-
console.error(error);
|
|
1830
|
-
});
|
|
1831
|
-
|
|
1832
|
-
```
|
|
1833
|
-
|
|
1834
|
-
### Parameters
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
Name | Type | Description | Notes
|
|
1838
|
-
------------- | ------------- | ------------- | -------------
|
|
1839
|
-
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
1840
|
-
**source_account** | **String**| The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. |
|
|
1841
|
-
**destination_account** | **String**| The destination account. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. |
|
|
1842
|
-
|
|
1843
|
-
### Return type
|
|
1844
|
-
|
|
1845
|
-
[**PaymentAllocationAmount**](PaymentAllocationAmount.md)
|
|
1846
|
-
|
|
1847
|
-
### Authorization
|
|
1848
|
-
|
|
1849
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1850
|
-
|
|
1851
|
-
### HTTP request headers
|
|
1852
|
-
|
|
1853
|
-
- **Content-Type**: Not defined
|
|
1854
|
-
- **Accept**: application/json
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
## getBatchAllocationById
|
|
1858
|
-
|
|
1859
|
-
> BatchAllocationDetail getBatchAllocationById(batch_allocation_id)
|
|
1860
|
-
|
|
1861
|
-
Get batch allocation information
|
|
1862
|
-
|
|
1863
|
-
This operation retrieves the information of a batch allocation.
|
|
1864
|
-
|
|
1865
|
-
### Example
|
|
1866
|
-
|
|
1867
|
-
```javascript
|
|
1868
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1869
|
-
// Initialize the API client
|
|
1870
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1871
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1872
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1873
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1874
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1875
|
-
// Call the API
|
|
1876
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1877
|
-
const batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1878
|
-
apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
1879
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1880
|
-
}, (error) => {
|
|
1881
|
-
console.error(error);
|
|
1882
|
-
});
|
|
1883
|
-
|
|
1884
|
-
```
|
|
1885
|
-
|
|
1886
|
-
### Parameters
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
Name | Type | Description | Notes
|
|
1890
|
-
------------- | ------------- | ------------- | -------------
|
|
1891
|
-
**batch_allocation_id** | **String**| The batch allocation ID. |
|
|
1892
|
-
|
|
1893
|
-
### Return type
|
|
1894
|
-
|
|
1895
|
-
[**BatchAllocationDetail**](BatchAllocationDetail.md)
|
|
1896
|
-
|
|
1897
|
-
### Authorization
|
|
1898
|
-
|
|
1899
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1900
|
-
|
|
1901
|
-
### HTTP request headers
|
|
1902
|
-
|
|
1903
|
-
- **Content-Type**: Not defined
|
|
1904
|
-
- **Accept**: application/json
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
## getBulkSendById
|
|
1908
|
-
|
|
1909
|
-
> PaymentBulkSend getBulkSendById(bulk_send_id)
|
|
1910
|
-
|
|
1911
|
-
Get bulk send information
|
|
1912
|
-
|
|
1913
|
-
This operation retrieves the information of a specific bulk send.
|
|
1914
|
-
|
|
1915
|
-
### Example
|
|
1916
|
-
|
|
1917
|
-
```javascript
|
|
1918
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1919
|
-
// Initialize the API client
|
|
1920
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1921
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1922
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1923
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1924
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1925
|
-
// Call the API
|
|
1926
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1927
|
-
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1928
|
-
apiInstance.getBulkSendById(bulk_send_id).then((data) => {
|
|
1929
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1930
|
-
}, (error) => {
|
|
1931
|
-
console.error(error);
|
|
1932
|
-
});
|
|
1933
|
-
|
|
1934
|
-
```
|
|
1935
|
-
|
|
1936
|
-
### Parameters
|
|
1937
|
-
|
|
1938
|
-
|
|
1939
|
-
Name | Type | Description | Notes
|
|
1940
|
-
------------- | ------------- | ------------- | -------------
|
|
1941
|
-
**bulk_send_id** | **String**| The bulk send ID. |
|
|
1942
|
-
|
|
1943
|
-
### Return type
|
|
1944
|
-
|
|
1945
|
-
[**PaymentBulkSend**](PaymentBulkSend.md)
|
|
1946
|
-
|
|
1947
|
-
### Authorization
|
|
1948
|
-
|
|
1949
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1950
|
-
|
|
1951
|
-
### HTTP request headers
|
|
1952
|
-
|
|
1953
|
-
- **Content-Type**: Not defined
|
|
1954
|
-
- **Accept**: application/json
|
|
1955
|
-
|
|
1956
|
-
|
|
1957
|
-
## getCounterparty
|
|
1958
|
-
|
|
1959
|
-
> CounterpartyDetail getCounterparty(counterparty_id)
|
|
1960
|
-
|
|
1961
|
-
Get counterparty information
|
|
1962
|
-
|
|
1963
|
-
This operation retrieves the detailed information about a specified counterparty.
|
|
1332
|
+
This operation retrieves the available amount that can be allocated from a source account to a destination account.
|
|
1964
1333
|
|
|
1965
1334
|
### Example
|
|
1966
1335
|
|
|
@@ -1974,8 +1343,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1974
1343
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1975
1344
|
// Call the API
|
|
1976
1345
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1977
|
-
const
|
|
1978
|
-
|
|
1346
|
+
const token_id = "ETH_USDT";
|
|
1347
|
+
const source_account = "source_account_example";
|
|
1348
|
+
const destination_account = "destination_account_example";
|
|
1349
|
+
apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_account).then((data) => {
|
|
1979
1350
|
console.log('API called successfully. Returned data: ' + data);
|
|
1980
1351
|
}, (error) => {
|
|
1981
1352
|
console.error(error);
|
|
@@ -1988,11 +1359,13 @@ apiInstance.getCounterparty(counterparty_id).then((data) => {
|
|
|
1988
1359
|
|
|
1989
1360
|
Name | Type | Description | Notes
|
|
1990
1361
|
------------- | ------------- | ------------- | -------------
|
|
1991
|
-
**
|
|
1362
|
+
**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` |
|
|
1363
|
+
**source_account** | **String**| The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. |
|
|
1364
|
+
**destination_account** | **String**| The destination account. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. |
|
|
1992
1365
|
|
|
1993
1366
|
### Return type
|
|
1994
1367
|
|
|
1995
|
-
[**
|
|
1368
|
+
[**PaymentAllocationAmount**](PaymentAllocationAmount.md)
|
|
1996
1369
|
|
|
1997
1370
|
### Authorization
|
|
1998
1371
|
|
|
@@ -2004,13 +1377,13 @@ Name | Type | Description | Notes
|
|
|
2004
1377
|
- **Accept**: application/json
|
|
2005
1378
|
|
|
2006
1379
|
|
|
2007
|
-
##
|
|
1380
|
+
## getBatchAllocationById
|
|
2008
1381
|
|
|
2009
|
-
>
|
|
1382
|
+
> BatchAllocationDetail getBatchAllocationById(batch_allocation_id)
|
|
2010
1383
|
|
|
2011
|
-
Get
|
|
1384
|
+
Get batch allocation information
|
|
2012
1385
|
|
|
2013
|
-
This operation retrieves the
|
|
1386
|
+
This operation retrieves the information of a batch allocation.
|
|
2014
1387
|
|
|
2015
1388
|
### Example
|
|
2016
1389
|
|
|
@@ -2024,8 +1397,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2024
1397
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2025
1398
|
// Call the API
|
|
2026
1399
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2027
|
-
const
|
|
2028
|
-
apiInstance.
|
|
1400
|
+
const batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1401
|
+
apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
2029
1402
|
console.log('API called successfully. Returned data: ' + data);
|
|
2030
1403
|
}, (error) => {
|
|
2031
1404
|
console.error(error);
|
|
@@ -2038,11 +1411,11 @@ apiInstance.getCounterpartyDetailById(counterparty_id).then((data) => {
|
|
|
2038
1411
|
|
|
2039
1412
|
Name | Type | Description | Notes
|
|
2040
1413
|
------------- | ------------- | ------------- | -------------
|
|
2041
|
-
**
|
|
1414
|
+
**batch_allocation_id** | **String**| The batch allocation ID. |
|
|
2042
1415
|
|
|
2043
1416
|
### Return type
|
|
2044
1417
|
|
|
2045
|
-
[**
|
|
1418
|
+
[**BatchAllocationDetail**](BatchAllocationDetail.md)
|
|
2046
1419
|
|
|
2047
1420
|
### Authorization
|
|
2048
1421
|
|
|
@@ -2054,13 +1427,13 @@ Name | Type | Description | Notes
|
|
|
2054
1427
|
- **Accept**: application/json
|
|
2055
1428
|
|
|
2056
1429
|
|
|
2057
|
-
##
|
|
1430
|
+
## getBulkSendById
|
|
2058
1431
|
|
|
2059
|
-
>
|
|
1432
|
+
> PaymentBulkSend getBulkSendById(bulk_send_id)
|
|
2060
1433
|
|
|
2061
|
-
Get
|
|
1434
|
+
Get bulk send information
|
|
2062
1435
|
|
|
2063
|
-
This operation retrieves the
|
|
1436
|
+
This operation retrieves the information of a specific bulk send.
|
|
2064
1437
|
|
|
2065
1438
|
### Example
|
|
2066
1439
|
|
|
@@ -2074,11 +1447,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2074
1447
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2075
1448
|
// Call the API
|
|
2076
1449
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2077
|
-
const
|
|
2078
|
-
|
|
2079
|
-
'entry_type': new CoboWaas2.EntryType()
|
|
2080
|
-
};
|
|
2081
|
-
apiInstance.getCounterpartyEntry(counterparty_entry_id, opts).then((data) => {
|
|
1450
|
+
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1451
|
+
apiInstance.getBulkSendById(bulk_send_id).then((data) => {
|
|
2082
1452
|
console.log('API called successfully. Returned data: ' + data);
|
|
2083
1453
|
}, (error) => {
|
|
2084
1454
|
console.error(error);
|
|
@@ -2091,12 +1461,11 @@ apiInstance.getCounterpartyEntry(counterparty_entry_id, opts).then((data) => {
|
|
|
2091
1461
|
|
|
2092
1462
|
Name | Type | Description | Notes
|
|
2093
1463
|
------------- | ------------- | ------------- | -------------
|
|
2094
|
-
**
|
|
2095
|
-
**entry_type** | [**EntryType**](.md)| The type of the counterparty entry. - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. | [optional]
|
|
1464
|
+
**bulk_send_id** | **String**| The bulk send ID. |
|
|
2096
1465
|
|
|
2097
1466
|
### Return type
|
|
2098
1467
|
|
|
2099
|
-
[**
|
|
1468
|
+
[**PaymentBulkSend**](PaymentBulkSend.md)
|
|
2100
1469
|
|
|
2101
1470
|
### Authorization
|
|
2102
1471
|
|
|
@@ -2108,13 +1477,13 @@ Name | Type | Description | Notes
|
|
|
2108
1477
|
- **Accept**: application/json
|
|
2109
1478
|
|
|
2110
1479
|
|
|
2111
|
-
##
|
|
1480
|
+
## getCounterparty
|
|
2112
1481
|
|
|
2113
|
-
>
|
|
1482
|
+
> CounterpartyDetail getCounterparty(counterparty_id)
|
|
2114
1483
|
|
|
2115
|
-
Get
|
|
1484
|
+
Get counterparty information
|
|
2116
1485
|
|
|
2117
|
-
This operation retrieves the detailed information about a specified
|
|
1486
|
+
This operation retrieves the detailed information about a specified counterparty.
|
|
2118
1487
|
|
|
2119
1488
|
### Example
|
|
2120
1489
|
|
|
@@ -2128,8 +1497,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2128
1497
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2129
1498
|
// Call the API
|
|
2130
1499
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2131
|
-
const
|
|
2132
|
-
apiInstance.
|
|
1500
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1501
|
+
apiInstance.getCounterparty(counterparty_id).then((data) => {
|
|
2133
1502
|
console.log('API called successfully. Returned data: ' + data);
|
|
2134
1503
|
}, (error) => {
|
|
2135
1504
|
console.error(error);
|
|
@@ -2142,11 +1511,11 @@ apiInstance.getDestination(destination_id).then((data) => {
|
|
|
2142
1511
|
|
|
2143
1512
|
Name | Type | Description | Notes
|
|
2144
1513
|
------------- | ------------- | ------------- | -------------
|
|
2145
|
-
**
|
|
1514
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
2146
1515
|
|
|
2147
1516
|
### Return type
|
|
2148
1517
|
|
|
2149
|
-
[**
|
|
1518
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
2150
1519
|
|
|
2151
1520
|
### Authorization
|
|
2152
1521
|
|
|
@@ -2158,13 +1527,13 @@ Name | Type | Description | Notes
|
|
|
2158
1527
|
- **Accept**: application/json
|
|
2159
1528
|
|
|
2160
1529
|
|
|
2161
|
-
##
|
|
1530
|
+
## getCounterpartyEntry
|
|
2162
1531
|
|
|
2163
|
-
>
|
|
1532
|
+
> GetCounterpartyEntry200Response getCounterpartyEntry(counterparty_entry_id, opts)
|
|
2164
1533
|
|
|
2165
|
-
Get
|
|
1534
|
+
Get counterparty entry information
|
|
2166
1535
|
|
|
2167
|
-
This operation retrieves the detailed information about a specified
|
|
1536
|
+
This operation retrieves the detailed information about a specified counterparty entry.
|
|
2168
1537
|
|
|
2169
1538
|
### Example
|
|
2170
1539
|
|
|
@@ -2178,8 +1547,11 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2178
1547
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2179
1548
|
// Call the API
|
|
2180
1549
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2181
|
-
const
|
|
2182
|
-
|
|
1550
|
+
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1551
|
+
const opts = {
|
|
1552
|
+
'entry_type': new CoboWaas2.EntryType()
|
|
1553
|
+
};
|
|
1554
|
+
apiInstance.getCounterpartyEntry(counterparty_entry_id, opts).then((data) => {
|
|
2183
1555
|
console.log('API called successfully. Returned data: ' + data);
|
|
2184
1556
|
}, (error) => {
|
|
2185
1557
|
console.error(error);
|
|
@@ -2192,11 +1564,12 @@ apiInstance.getDestinationBankAccountDetailById(bank_account_id).then((data) =>
|
|
|
2192
1564
|
|
|
2193
1565
|
Name | Type | Description | Notes
|
|
2194
1566
|
------------- | ------------- | ------------- | -------------
|
|
2195
|
-
**
|
|
1567
|
+
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
1568
|
+
**entry_type** | [**EntryType**](.md)| The type of the counterparty entry. - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. | [optional]
|
|
2196
1569
|
|
|
2197
1570
|
### Return type
|
|
2198
1571
|
|
|
2199
|
-
[**
|
|
1572
|
+
[**GetCounterpartyEntry200Response**](GetCounterpartyEntry200Response.md)
|
|
2200
1573
|
|
|
2201
1574
|
### Authorization
|
|
2202
1575
|
|
|
@@ -2208,11 +1581,11 @@ Name | Type | Description | Notes
|
|
|
2208
1581
|
- **Accept**: application/json
|
|
2209
1582
|
|
|
2210
1583
|
|
|
2211
|
-
##
|
|
1584
|
+
## getDestination
|
|
2212
1585
|
|
|
2213
|
-
> DestinationDetail
|
|
1586
|
+
> DestinationDetail getDestination(destination_id)
|
|
2214
1587
|
|
|
2215
|
-
Get destination information
|
|
1588
|
+
Get destination information
|
|
2216
1589
|
|
|
2217
1590
|
This operation retrieves the detailed information about a specified destination.
|
|
2218
1591
|
|
|
@@ -2229,7 +1602,7 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
2229
1602
|
// Call the API
|
|
2230
1603
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2231
1604
|
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
2232
|
-
apiInstance.
|
|
1605
|
+
apiInstance.getDestination(destination_id).then((data) => {
|
|
2233
1606
|
console.log('API called successfully. Returned data: ' + data);
|
|
2234
1607
|
}, (error) => {
|
|
2235
1608
|
console.error(error);
|
|
@@ -3113,194 +2486,16 @@ apiInstance.listCounterparties(opts).then((data) => {
|
|
|
3113
2486
|
|
|
3114
2487
|
Name | Type | Description | Notes
|
|
3115
2488
|
------------- | ------------- | ------------- | -------------
|
|
3116
|
-
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3117
|
-
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
3118
|
-
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
3119
|
-
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
3120
|
-
**counterparty_type** | [**CounterpartyType**](.md)| The type of the counterparty. - `Individual`: The counterparty is an individual. - `Organization`: The counterparty is an organization. | [optional]
|
|
3121
|
-
**country** | **String**| Country code, in ISO 3166-1 alpha-3 format. | [optional]
|
|
3122
|
-
|
|
3123
|
-
### Return type
|
|
3124
|
-
|
|
3125
|
-
[**ListCounterparties200Response**](ListCounterparties200Response.md)
|
|
3126
|
-
|
|
3127
|
-
### Authorization
|
|
3128
|
-
|
|
3129
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3130
|
-
|
|
3131
|
-
### HTTP request headers
|
|
3132
|
-
|
|
3133
|
-
- **Content-Type**: Not defined
|
|
3134
|
-
- **Accept**: application/json
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
## listCounterpartyEntries
|
|
3138
|
-
|
|
3139
|
-
> ListCounterpartyEntries200Response listCounterpartyEntries(opts)
|
|
3140
|
-
|
|
3141
|
-
List counterparty entries
|
|
3142
|
-
|
|
3143
|
-
This operation retrieves the information of counterparty entries.
|
|
3144
|
-
|
|
3145
|
-
### Example
|
|
3146
|
-
|
|
3147
|
-
```javascript
|
|
3148
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3149
|
-
// Initialize the API client
|
|
3150
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
3151
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3152
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3153
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3154
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3155
|
-
// Call the API
|
|
3156
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3157
|
-
const opts = {
|
|
3158
|
-
'limit': 10,
|
|
3159
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3160
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3161
|
-
'entry_type': new CoboWaas2.EntryType(),
|
|
3162
|
-
'counterparty_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384",
|
|
3163
|
-
'chain_ids': "ETH",
|
|
3164
|
-
'wallet_address': "0x1234567890abcdef..."
|
|
3165
|
-
};
|
|
3166
|
-
apiInstance.listCounterpartyEntries(opts).then((data) => {
|
|
3167
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
3168
|
-
}, (error) => {
|
|
3169
|
-
console.error(error);
|
|
3170
|
-
});
|
|
3171
|
-
|
|
3172
|
-
```
|
|
3173
|
-
|
|
3174
|
-
### Parameters
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
Name | Type | Description | Notes
|
|
3178
|
-
------------- | ------------- | ------------- | -------------
|
|
3179
|
-
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3180
|
-
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
3181
|
-
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
3182
|
-
**entry_type** | [**EntryType**](.md)| The type of the counterparty entry. - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. | [optional]
|
|
3183
|
-
**counterparty_id** | **String**| The counterparty ID. | [optional]
|
|
3184
|
-
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3185
|
-
**wallet_address** | **String**| The wallet address. | [optional]
|
|
3186
|
-
|
|
3187
|
-
### Return type
|
|
3188
|
-
|
|
3189
|
-
[**ListCounterpartyEntries200Response**](ListCounterpartyEntries200Response.md)
|
|
3190
|
-
|
|
3191
|
-
### Authorization
|
|
3192
|
-
|
|
3193
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3194
|
-
|
|
3195
|
-
### HTTP request headers
|
|
3196
|
-
|
|
3197
|
-
- **Content-Type**: Not defined
|
|
3198
|
-
- **Accept**: application/json
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
## listCounterpartyWalletAddress
|
|
3202
|
-
|
|
3203
|
-
> ListCounterpartyWalletAddress200Response listCounterpartyWalletAddress(opts)
|
|
3204
|
-
|
|
3205
|
-
List counterparty wallet addresses
|
|
3206
|
-
|
|
3207
|
-
This operation retrieves the information of counterparty wallet addresses.
|
|
3208
|
-
|
|
3209
|
-
### Example
|
|
3210
|
-
|
|
3211
|
-
```javascript
|
|
3212
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3213
|
-
// Initialize the API client
|
|
3214
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
3215
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3216
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3217
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3218
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3219
|
-
// Call the API
|
|
3220
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3221
|
-
const opts = {
|
|
3222
|
-
'limit': 10,
|
|
3223
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3224
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3225
|
-
'counterparty_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384",
|
|
3226
|
-
'chain_ids': "ETH",
|
|
3227
|
-
'wallet_address': "0x1234567890abcdef..."
|
|
3228
|
-
};
|
|
3229
|
-
apiInstance.listCounterpartyWalletAddress(opts).then((data) => {
|
|
3230
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
3231
|
-
}, (error) => {
|
|
3232
|
-
console.error(error);
|
|
3233
|
-
});
|
|
3234
|
-
|
|
3235
|
-
```
|
|
3236
|
-
|
|
3237
|
-
### Parameters
|
|
3238
|
-
|
|
3239
|
-
|
|
3240
|
-
Name | Type | Description | Notes
|
|
3241
|
-
------------- | ------------- | ------------- | -------------
|
|
3242
|
-
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3243
|
-
**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]
|
|
3244
|
-
**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]
|
|
3245
|
-
**counterparty_id** | **String**| The counterparty ID. | [optional]
|
|
3246
|
-
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3247
|
-
**wallet_address** | **String**| The wallet address. | [optional]
|
|
3248
|
-
|
|
3249
|
-
### Return type
|
|
3250
|
-
|
|
3251
|
-
[**ListCounterpartyWalletAddress200Response**](ListCounterpartyWalletAddress200Response.md)
|
|
3252
|
-
|
|
3253
|
-
### Authorization
|
|
3254
|
-
|
|
3255
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3256
|
-
|
|
3257
|
-
### HTTP request headers
|
|
3258
|
-
|
|
3259
|
-
- **Content-Type**: Not defined
|
|
3260
|
-
- **Accept**: application/json
|
|
3261
|
-
|
|
3262
|
-
|
|
3263
|
-
## listCryptoAddresses
|
|
3264
|
-
|
|
3265
|
-
> [CryptoAddress] listCryptoAddresses(opts)
|
|
3266
|
-
|
|
3267
|
-
List crypto addresses
|
|
3268
|
-
|
|
3269
|
-
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.
|
|
3270
|
-
|
|
3271
|
-
### Example
|
|
3272
|
-
|
|
3273
|
-
```javascript
|
|
3274
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3275
|
-
// Initialize the API client
|
|
3276
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
3277
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3278
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3279
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3280
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3281
|
-
// Call the API
|
|
3282
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3283
|
-
const opts = {
|
|
3284
|
-
'token_id': "ETH_USDT"
|
|
3285
|
-
};
|
|
3286
|
-
apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
3287
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
3288
|
-
}, (error) => {
|
|
3289
|
-
console.error(error);
|
|
3290
|
-
});
|
|
3291
|
-
|
|
3292
|
-
```
|
|
3293
|
-
|
|
3294
|
-
### Parameters
|
|
3295
|
-
|
|
3296
|
-
|
|
3297
|
-
Name | Type | Description | Notes
|
|
3298
|
-
------------- | ------------- | ------------- | -------------
|
|
3299
|
-
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
2489
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2490
|
+
**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]
|
|
2491
|
+
**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]
|
|
2492
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2493
|
+
**counterparty_type** | [**CounterpartyType**](.md)| The type of the counterparty. - `Individual`: The counterparty is an individual. - `Organization`: The counterparty is an organization. | [optional]
|
|
2494
|
+
**country** | **String**| Country code, in ISO 3166-1 alpha-3 format. | [optional]
|
|
3300
2495
|
|
|
3301
2496
|
### Return type
|
|
3302
2497
|
|
|
3303
|
-
[**
|
|
2498
|
+
[**ListCounterparties200Response**](ListCounterparties200Response.md)
|
|
3304
2499
|
|
|
3305
2500
|
### Authorization
|
|
3306
2501
|
|
|
@@ -3312,13 +2507,13 @@ Name | Type | Description | Notes
|
|
|
3312
2507
|
- **Accept**: application/json
|
|
3313
2508
|
|
|
3314
2509
|
|
|
3315
|
-
##
|
|
2510
|
+
## listCounterpartyEntries
|
|
3316
2511
|
|
|
3317
|
-
>
|
|
2512
|
+
> ListCounterpartyEntries200Response listCounterpartyEntries(opts)
|
|
3318
2513
|
|
|
3319
|
-
List
|
|
2514
|
+
List counterparty entries
|
|
3320
2515
|
|
|
3321
|
-
This operation retrieves the information of
|
|
2516
|
+
This operation retrieves the information of counterparty entries.
|
|
3322
2517
|
|
|
3323
2518
|
### Example
|
|
3324
2519
|
|
|
@@ -3336,11 +2531,12 @@ const opts = {
|
|
|
3336
2531
|
'limit': 10,
|
|
3337
2532
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3338
2533
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3339
|
-
'
|
|
3340
|
-
'
|
|
3341
|
-
'
|
|
2534
|
+
'entry_type': new CoboWaas2.EntryType(),
|
|
2535
|
+
'counterparty_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384",
|
|
2536
|
+
'chain_ids': "ETH",
|
|
2537
|
+
'wallet_address': "0x1234567890abcdef..."
|
|
3342
2538
|
};
|
|
3343
|
-
apiInstance.
|
|
2539
|
+
apiInstance.listCounterpartyEntries(opts).then((data) => {
|
|
3344
2540
|
console.log('API called successfully. Returned data: ' + data);
|
|
3345
2541
|
}, (error) => {
|
|
3346
2542
|
console.error(error);
|
|
@@ -3356,13 +2552,14 @@ Name | Type | Description | Notes
|
|
|
3356
2552
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3357
2553
|
**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]
|
|
3358
2554
|
**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]
|
|
3359
|
-
**
|
|
3360
|
-
**
|
|
3361
|
-
**
|
|
2555
|
+
**entry_type** | [**EntryType**](.md)| The type of the counterparty entry. - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. | [optional]
|
|
2556
|
+
**counterparty_id** | **String**| The counterparty ID. | [optional]
|
|
2557
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
2558
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
3362
2559
|
|
|
3363
2560
|
### Return type
|
|
3364
2561
|
|
|
3365
|
-
[**
|
|
2562
|
+
[**ListCounterpartyEntries200Response**](ListCounterpartyEntries200Response.md)
|
|
3366
2563
|
|
|
3367
2564
|
### Authorization
|
|
3368
2565
|
|
|
@@ -3374,13 +2571,13 @@ Name | Type | Description | Notes
|
|
|
3374
2571
|
- **Accept**: application/json
|
|
3375
2572
|
|
|
3376
2573
|
|
|
3377
|
-
##
|
|
2574
|
+
## listCryptoAddresses
|
|
3378
2575
|
|
|
3379
|
-
>
|
|
2576
|
+
> [CryptoAddress] listCryptoAddresses(opts)
|
|
3380
2577
|
|
|
3381
|
-
List
|
|
2578
|
+
List crypto addresses
|
|
3382
2579
|
|
|
3383
|
-
This operation retrieves
|
|
2580
|
+
<Note>This operation has been deprecated.</Note> 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.
|
|
3384
2581
|
|
|
3385
2582
|
### Example
|
|
3386
2583
|
|
|
@@ -3394,18 +2591,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
3394
2591
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3395
2592
|
// Call the API
|
|
3396
2593
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3397
|
-
const entry_type = new CoboWaas2.EntryType();
|
|
3398
2594
|
const opts = {
|
|
3399
|
-
'
|
|
3400
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3401
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3402
|
-
'destination_id': "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
|
|
3403
|
-
'chain_ids': "ETH",
|
|
3404
|
-
'wallet_address': "0x1234567890abcdef...",
|
|
3405
|
-
'keyword': "keyword",
|
|
3406
|
-
'bank_account_status': new CoboWaas2.BankAccountStatus()
|
|
2595
|
+
'token_id': "ETH_USDT"
|
|
3407
2596
|
};
|
|
3408
|
-
apiInstance.
|
|
2597
|
+
apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
3409
2598
|
console.log('API called successfully. Returned data: ' + data);
|
|
3410
2599
|
}, (error) => {
|
|
3411
2600
|
console.error(error);
|
|
@@ -3418,19 +2607,11 @@ apiInstance.listDestinationEntries(entry_type, opts).then((data) => {
|
|
|
3418
2607
|
|
|
3419
2608
|
Name | Type | Description | Notes
|
|
3420
2609
|
------------- | ------------- | ------------- | -------------
|
|
3421
|
-
**
|
|
3422
|
-
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3423
|
-
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
3424
|
-
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
3425
|
-
**destination_id** | **String**| The destination ID. | [optional]
|
|
3426
|
-
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3427
|
-
**wallet_address** | **String**| The wallet address. | [optional]
|
|
3428
|
-
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
3429
|
-
**bank_account_status** | [**BankAccountStatus**](.md)| BankAccountStatus defines the status of the bank account: - `Pending`: The bank account is pending verification by Cobo. - `Approved`: The bank account has been approved by Cobo. - `Rejected`: The bank account has been rejected by Cobo. | [optional]
|
|
2610
|
+
**token_id** | **String**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional]
|
|
3430
2611
|
|
|
3431
2612
|
### Return type
|
|
3432
2613
|
|
|
3433
|
-
[**
|
|
2614
|
+
[**[CryptoAddress]**](CryptoAddress.md)
|
|
3434
2615
|
|
|
3435
2616
|
### Authorization
|
|
3436
2617
|
|
|
@@ -3442,13 +2623,13 @@ Name | Type | Description | Notes
|
|
|
3442
2623
|
- **Accept**: application/json
|
|
3443
2624
|
|
|
3444
2625
|
|
|
3445
|
-
##
|
|
2626
|
+
## listDestinationEntries
|
|
3446
2627
|
|
|
3447
|
-
>
|
|
2628
|
+
> ListDestinationEntries200Response listDestinationEntries(entry_type, opts)
|
|
3448
2629
|
|
|
3449
|
-
List destination
|
|
2630
|
+
List destination entries
|
|
3450
2631
|
|
|
3451
|
-
This operation retrieves the information of destination
|
|
2632
|
+
This operation retrieves the information of destination entries.
|
|
3452
2633
|
|
|
3453
2634
|
### Example
|
|
3454
2635
|
|
|
@@ -3462,15 +2643,18 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
3462
2643
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3463
2644
|
// Call the API
|
|
3464
2645
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2646
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
3465
2647
|
const opts = {
|
|
3466
2648
|
'limit': 10,
|
|
3467
2649
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3468
2650
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3469
2651
|
'destination_id': "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
|
|
3470
2652
|
'chain_ids': "ETH",
|
|
3471
|
-
'wallet_address': "0x1234567890abcdef..."
|
|
2653
|
+
'wallet_address': "0x1234567890abcdef...",
|
|
2654
|
+
'keyword': "keyword",
|
|
2655
|
+
'bank_account_status': new CoboWaas2.BankAccountStatus()
|
|
3472
2656
|
};
|
|
3473
|
-
apiInstance.
|
|
2657
|
+
apiInstance.listDestinationEntries(entry_type, opts).then((data) => {
|
|
3474
2658
|
console.log('API called successfully. Returned data: ' + data);
|
|
3475
2659
|
}, (error) => {
|
|
3476
2660
|
console.error(error);
|
|
@@ -3483,16 +2667,19 @@ apiInstance.listDestinationWalletAddresses(opts).then((data) => {
|
|
|
3483
2667
|
|
|
3484
2668
|
Name | Type | Description | Notes
|
|
3485
2669
|
------------- | ------------- | ------------- | -------------
|
|
2670
|
+
**entry_type** | [**EntryType**](.md)| EntryType defines the type of the counterparty entry: - `Address`: The counterparty entry is an address. - `BankAccount`: The counterparty entry is a bank account. |
|
|
3486
2671
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3487
2672
|
**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]
|
|
3488
2673
|
**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]
|
|
3489
2674
|
**destination_id** | **String**| The destination ID. | [optional]
|
|
3490
2675
|
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3491
2676
|
**wallet_address** | **String**| The wallet address. | [optional]
|
|
2677
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2678
|
+
**bank_account_status** | [**BankAccountStatus**](.md)| BankAccountStatus defines the status of the bank account: - `Pending`: The bank account is pending verification by Cobo. - `Approved`: The bank account has been approved by Cobo. - `Rejected`: The bank account has been rejected by Cobo. | [optional]
|
|
3492
2679
|
|
|
3493
2680
|
### Return type
|
|
3494
2681
|
|
|
3495
|
-
[**
|
|
2682
|
+
[**ListDestinationEntries200Response**](ListDestinationEntries200Response.md)
|
|
3496
2683
|
|
|
3497
2684
|
### Authorization
|
|
3498
2685
|
|
|
@@ -3810,9 +2997,9 @@ Name | Type | Description | Notes
|
|
|
3810
2997
|
|
|
3811
2998
|
> [SupportedToken] listPaymentSupportedTokens()
|
|
3812
2999
|
|
|
3813
|
-
List
|
|
3000
|
+
List supported tokens
|
|
3814
3001
|
|
|
3815
|
-
This operation retrieves
|
|
3002
|
+
This operation retrieves all tokens supported by Cobo Payments. Use this operation to get token details such as token ID, symbol, decimal precision, contract address, and chain information before creating payment orders. For more information about Cobo Payments, see [Cobo Payments Overview](https://www.cobo.com/payments/en/guides/overview).
|
|
3816
3003
|
|
|
3817
3004
|
### Example
|
|
3818
3005
|
|
|
@@ -4254,59 +3441,13 @@ Name | Type | Description | Notes
|
|
|
4254
3441
|
- **Accept**: application/json
|
|
4255
3442
|
|
|
4256
3443
|
|
|
4257
|
-
## queryDestinationWhitelistEnabled
|
|
4258
|
-
|
|
4259
|
-
> QueryDestinationWhitelistEnabled200Response queryDestinationWhitelistEnabled()
|
|
4260
|
-
|
|
4261
|
-
Query destination whitelist enabled status
|
|
4262
|
-
|
|
4263
|
-
This operation retrieves the information of whether the destination whitelist is enabled.
|
|
4264
|
-
|
|
4265
|
-
### Example
|
|
4266
|
-
|
|
4267
|
-
```javascript
|
|
4268
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4269
|
-
// Initialize the API client
|
|
4270
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
4271
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4272
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4273
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4274
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4275
|
-
// Call the API
|
|
4276
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4277
|
-
apiInstance.queryDestinationWhitelistEnabled().then((data) => {
|
|
4278
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
4279
|
-
}, (error) => {
|
|
4280
|
-
console.error(error);
|
|
4281
|
-
});
|
|
4282
|
-
|
|
4283
|
-
```
|
|
4284
|
-
|
|
4285
|
-
### Parameters
|
|
4286
|
-
|
|
4287
|
-
This endpoint does not need any parameter.
|
|
4288
|
-
|
|
4289
|
-
### Return type
|
|
4290
|
-
|
|
4291
|
-
[**QueryDestinationWhitelistEnabled200Response**](QueryDestinationWhitelistEnabled200Response.md)
|
|
4292
|
-
|
|
4293
|
-
### Authorization
|
|
4294
|
-
|
|
4295
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4296
|
-
|
|
4297
|
-
### HTTP request headers
|
|
4298
|
-
|
|
4299
|
-
- **Content-Type**: Not defined
|
|
4300
|
-
- **Accept**: application/json
|
|
4301
|
-
|
|
4302
|
-
|
|
4303
3444
|
## updateBankAccountById
|
|
4304
3445
|
|
|
4305
3446
|
> BankAccount updateBankAccountById(bank_account_id, opts)
|
|
4306
3447
|
|
|
4307
3448
|
Update bank account
|
|
4308
3449
|
|
|
4309
|
-
This operation updates the information of an existing bank account.
|
|
3450
|
+
<Note>This operation has been deprecated.</Note> This operation updates the information of an existing bank account.
|
|
4310
3451
|
|
|
4311
3452
|
### Example
|
|
4312
3453
|
|
|
@@ -4408,60 +3549,6 @@ Name | Type | Description | Notes
|
|
|
4408
3549
|
- **Accept**: application/json
|
|
4409
3550
|
|
|
4410
3551
|
|
|
4411
|
-
## updateCounterpartyById
|
|
4412
|
-
|
|
4413
|
-
> Counterparty updateCounterpartyById(counterparty_id, opts)
|
|
4414
|
-
|
|
4415
|
-
Update counterparty (Deprecated)
|
|
4416
|
-
|
|
4417
|
-
This operation updates the information of a specified counterparty.
|
|
4418
|
-
|
|
4419
|
-
### Example
|
|
4420
|
-
|
|
4421
|
-
```javascript
|
|
4422
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4423
|
-
// Initialize the API client
|
|
4424
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
4425
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4426
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4427
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4428
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4429
|
-
// Call the API
|
|
4430
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4431
|
-
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
4432
|
-
const opts = {
|
|
4433
|
-
'UpdateCounterpartyByIdRequest': new CoboWaas2.UpdateCounterpartyByIdRequest()
|
|
4434
|
-
};
|
|
4435
|
-
apiInstance.updateCounterpartyById(counterparty_id, opts).then((data) => {
|
|
4436
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
4437
|
-
}, (error) => {
|
|
4438
|
-
console.error(error);
|
|
4439
|
-
});
|
|
4440
|
-
|
|
4441
|
-
```
|
|
4442
|
-
|
|
4443
|
-
### Parameters
|
|
4444
|
-
|
|
4445
|
-
|
|
4446
|
-
Name | Type | Description | Notes
|
|
4447
|
-
------------- | ------------- | ------------- | -------------
|
|
4448
|
-
**counterparty_id** | **String**| The counterparty ID. |
|
|
4449
|
-
**UpdateCounterpartyByIdRequest** | [**UpdateCounterpartyByIdRequest**](UpdateCounterpartyByIdRequest.md)| The request body to update a counterparty. | [optional]
|
|
4450
|
-
|
|
4451
|
-
### Return type
|
|
4452
|
-
|
|
4453
|
-
[**Counterparty**](Counterparty.md)
|
|
4454
|
-
|
|
4455
|
-
### Authorization
|
|
4456
|
-
|
|
4457
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4458
|
-
|
|
4459
|
-
### HTTP request headers
|
|
4460
|
-
|
|
4461
|
-
- **Content-Type**: application/json
|
|
4462
|
-
- **Accept**: application/json
|
|
4463
|
-
|
|
4464
|
-
|
|
4465
3552
|
## updateDestination
|
|
4466
3553
|
|
|
4467
3554
|
> Destination updateDestination(destination_id, opts)
|
|
@@ -4516,114 +3603,6 @@ Name | Type | Description | Notes
|
|
|
4516
3603
|
- **Accept**: application/json
|
|
4517
3604
|
|
|
4518
3605
|
|
|
4519
|
-
## updateDestinationBankAccountById
|
|
4520
|
-
|
|
4521
|
-
> DestinationBankAccount updateDestinationBankAccountById(bank_account_id, opts)
|
|
4522
|
-
|
|
4523
|
-
Update destination bank account
|
|
4524
|
-
|
|
4525
|
-
This operation updates the information of a specified destination bank account.
|
|
4526
|
-
|
|
4527
|
-
### Example
|
|
4528
|
-
|
|
4529
|
-
```javascript
|
|
4530
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4531
|
-
// Initialize the API client
|
|
4532
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
4533
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4534
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4535
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4536
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4537
|
-
// Call the API
|
|
4538
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4539
|
-
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
4540
|
-
const opts = {
|
|
4541
|
-
'UpdateDestinationBankAccount': new CoboWaas2.UpdateDestinationBankAccount()
|
|
4542
|
-
};
|
|
4543
|
-
apiInstance.updateDestinationBankAccountById(bank_account_id, opts).then((data) => {
|
|
4544
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
4545
|
-
}, (error) => {
|
|
4546
|
-
console.error(error);
|
|
4547
|
-
});
|
|
4548
|
-
|
|
4549
|
-
```
|
|
4550
|
-
|
|
4551
|
-
### Parameters
|
|
4552
|
-
|
|
4553
|
-
|
|
4554
|
-
Name | Type | Description | Notes
|
|
4555
|
-
------------- | ------------- | ------------- | -------------
|
|
4556
|
-
**bank_account_id** | **String**| The bank account ID. |
|
|
4557
|
-
**UpdateDestinationBankAccount** | [**UpdateDestinationBankAccount**](UpdateDestinationBankAccount.md)| The request body to update a destination bank account. | [optional]
|
|
4558
|
-
|
|
4559
|
-
### Return type
|
|
4560
|
-
|
|
4561
|
-
[**DestinationBankAccount**](DestinationBankAccount.md)
|
|
4562
|
-
|
|
4563
|
-
### Authorization
|
|
4564
|
-
|
|
4565
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4566
|
-
|
|
4567
|
-
### HTTP request headers
|
|
4568
|
-
|
|
4569
|
-
- **Content-Type**: application/json
|
|
4570
|
-
- **Accept**: application/json
|
|
4571
|
-
|
|
4572
|
-
|
|
4573
|
-
## updateDestinationById
|
|
4574
|
-
|
|
4575
|
-
> Destination updateDestinationById(destination_id, opts)
|
|
4576
|
-
|
|
4577
|
-
Update destination (Deprecated)
|
|
4578
|
-
|
|
4579
|
-
This operation updates the information of a specified destination.
|
|
4580
|
-
|
|
4581
|
-
### Example
|
|
4582
|
-
|
|
4583
|
-
```javascript
|
|
4584
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
4585
|
-
// Initialize the API client
|
|
4586
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
4587
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
4588
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
4589
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
4590
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4591
|
-
// Call the API
|
|
4592
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4593
|
-
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
4594
|
-
const opts = {
|
|
4595
|
-
'UpdateDestinationByIdRequest': new CoboWaas2.UpdateDestinationByIdRequest()
|
|
4596
|
-
};
|
|
4597
|
-
apiInstance.updateDestinationById(destination_id, opts).then((data) => {
|
|
4598
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
4599
|
-
}, (error) => {
|
|
4600
|
-
console.error(error);
|
|
4601
|
-
});
|
|
4602
|
-
|
|
4603
|
-
```
|
|
4604
|
-
|
|
4605
|
-
### Parameters
|
|
4606
|
-
|
|
4607
|
-
|
|
4608
|
-
Name | Type | Description | Notes
|
|
4609
|
-
------------- | ------------- | ------------- | -------------
|
|
4610
|
-
**destination_id** | **String**| The destination ID. |
|
|
4611
|
-
**UpdateDestinationByIdRequest** | [**UpdateDestinationByIdRequest**](UpdateDestinationByIdRequest.md)| The request body to update a destination. | [optional]
|
|
4612
|
-
|
|
4613
|
-
### Return type
|
|
4614
|
-
|
|
4615
|
-
[**Destination**](Destination.md)
|
|
4616
|
-
|
|
4617
|
-
### Authorization
|
|
4618
|
-
|
|
4619
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
4620
|
-
|
|
4621
|
-
### HTTP request headers
|
|
4622
|
-
|
|
4623
|
-
- **Content-Type**: application/json
|
|
4624
|
-
- **Accept**: application/json
|
|
4625
|
-
|
|
4626
|
-
|
|
4627
3606
|
## updateDestinationEntry
|
|
4628
3607
|
|
|
4629
3608
|
> UpdateDestinationEntry200Response updateDestinationEntry(destination_entry_id, opts)
|