@cobo/cobo-waas2 1.30.0 → 1.32.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 +9 -36
- package/dist/ApiClient.js +1 -1
- package/dist/api/AutoSweepApi.js +4 -4
- package/dist/api/FeeStationApi.js +4 -4
- package/dist/api/PaymentApi.js +76 -929
- package/dist/api/TransactionsApi.js +4 -4
- package/dist/api/WalletsApi.js +83 -0
- package/dist/index.js +35 -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/CreateDestinationBankAccount.js +26 -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/DestinationBankAccount.js +26 -0
- package/dist/model/DestinationBankAccountDetail.js +26 -0
- package/dist/model/IntermediaryBankInfo.js +4 -6
- package/dist/model/MerchantBalance.js +4 -6
- 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/ReportType.js +5 -0
- package/dist/model/SkipCheckType.js +56 -0
- package/dist/model/SupportedToken.js +17 -17
- package/dist/model/TransactionDepositToAddressDestinationTxInfo.js +26 -0
- package/dist/model/TransactionRawTxInfo.js +32 -1
- package/dist/model/TransactionSelectedUtxo.js +39 -0
- package/dist/model/TransactionUtxoChange.js +13 -0
- package/dist/model/TransferParams.js +16 -0
- package/dist/model/TriggerTestPaymentWebhookEventResponse.js +83 -0
- package/dist/model/{QueryDestinationWhitelistEnabled200Response.js → TriggerTestPaymentsWebhookEventRequest.js} +35 -26
- package/dist/model/UTXO.js +48 -0
- package/dist/model/UpdateDestinationBankAccount.js +26 -0
- package/dist/model/WebhookEventData.js +6 -0
- package/dist/model/WebhookEventType.js +25 -0
- package/docs/AutoSweepApi.md +2 -2
- package/docs/Balance.md +1 -0
- package/docs/BridgingFee.md +1 -0
- package/docs/ContractCallParams.md +1 -0
- package/docs/CreateDestinationBankAccount.md +2 -0
- package/docs/CreatePaymentOrderRequest.md +2 -2
- package/docs/CreateTopUpAddresses.md +1 -1
- package/docs/CreateWalletAddress.md +1 -1
- package/docs/DestinationBankAccount.md +2 -0
- package/docs/DestinationBankAccountDetail.md +2 -0
- package/docs/FeeStationApi.md +2 -2
- package/docs/IntermediaryBankInfo.md +1 -1
- package/docs/MerchantBalance.md +1 -1
- package/docs/PaymentApi.md +185 -1153
- 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/ReportType.md +2 -0
- package/docs/SkipCheckType.md +10 -0
- package/docs/SupportedToken.md +10 -10
- package/docs/TransactionDepositToAddressDestinationTxInfo.md +2 -0
- package/docs/TransactionRawTxInfo.md +2 -1
- package/docs/TransactionSelectedUtxo.md +3 -0
- package/docs/TransactionUtxoChange.md +1 -0
- package/docs/TransactionsApi.md +2 -2
- package/docs/TransferParams.md +1 -0
- package/docs/TriggerTestPaymentWebhookEventResponse.md +9 -0
- package/docs/TriggerTestPaymentsWebhookEventRequest.md +10 -0
- package/docs/UTXO.md +4 -0
- package/docs/UpdateDestinationBankAccount.md +2 -0
- package/docs/WalletsApi.md +71 -0
- package/docs/WebhookEventData.md +1 -0
- package/docs/WebhookEventType.md +10 -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/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,10 @@ 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
|
-
[**
|
|
69
|
+
[**triggerTestPaymentsWebhookEvent**](PaymentApi.md#triggerTestPaymentsWebhookEvent) | **POST** /payments/webhooks/trigger | Trigger test webhook event
|
|
85
70
|
[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
86
71
|
[**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
72
|
[**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
73
|
[**updateDestinationEntry**](PaymentApi.md#updateDestinationEntry) | **PUT** /payments/destination_entry/{destination_entry_id} | Update destination entry
|
|
92
74
|
[**updateMerchantById**](PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
93
75
|
[**updatePaymentOrder**](PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
@@ -406,65 +388,13 @@ Name | Type | Description | Notes
|
|
|
406
388
|
- **Accept**: application/json
|
|
407
389
|
|
|
408
390
|
|
|
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
391
|
## createCryptoAddress
|
|
462
392
|
|
|
463
393
|
> CryptoAddress createCryptoAddress(opts)
|
|
464
394
|
|
|
465
395
|
Create crypto address
|
|
466
396
|
|
|
467
|
-
This operation registers a crypto address for crypto payouts. The registered address can later be referenced by its ID when creating settlement requests.
|
|
397
|
+
<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
398
|
|
|
469
399
|
### Example
|
|
470
400
|
|
|
@@ -562,58 +492,6 @@ Name | Type | Description | Notes
|
|
|
562
492
|
- **Accept**: application/json
|
|
563
493
|
|
|
564
494
|
|
|
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
495
|
## createDestinationEntry
|
|
618
496
|
|
|
619
497
|
> CreateDestinationEntry201Response createDestinationEntry(opts)
|
|
@@ -666,58 +544,6 @@ Name | Type | Description | Notes
|
|
|
666
544
|
- **Accept**: application/json
|
|
667
545
|
|
|
668
546
|
|
|
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
547
|
## createForcedSweepRequest
|
|
722
548
|
|
|
723
549
|
> ForcedSweep createForcedSweepRequest(opts)
|
|
@@ -1238,13 +1064,13 @@ Name | Type | Description | Notes
|
|
|
1238
1064
|
- **Accept**: application/json
|
|
1239
1065
|
|
|
1240
1066
|
|
|
1241
|
-
##
|
|
1067
|
+
## deleteCounterpartyById
|
|
1242
1068
|
|
|
1243
|
-
>
|
|
1069
|
+
> DeleteCounterpartyById200Response deleteCounterpartyById(counterparty_id)
|
|
1244
1070
|
|
|
1245
|
-
Delete counterparty
|
|
1071
|
+
Delete counterparty
|
|
1246
1072
|
|
|
1247
|
-
This operation deletes a counterparty.
|
|
1073
|
+
This operation deletes a counterparty. Note that this operation will delete all entries under the counterparty.
|
|
1248
1074
|
|
|
1249
1075
|
### Example
|
|
1250
1076
|
|
|
@@ -1259,7 +1085,7 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
1259
1085
|
// Call the API
|
|
1260
1086
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1261
1087
|
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1262
|
-
apiInstance.
|
|
1088
|
+
apiInstance.deleteCounterpartyById(counterparty_id).then((data) => {
|
|
1263
1089
|
console.log('API called successfully. Returned data: ' + data);
|
|
1264
1090
|
}, (error) => {
|
|
1265
1091
|
console.error(error);
|
|
@@ -1276,7 +1102,7 @@ Name | Type | Description | Notes
|
|
|
1276
1102
|
|
|
1277
1103
|
### Return type
|
|
1278
1104
|
|
|
1279
|
-
[**
|
|
1105
|
+
[**DeleteCounterpartyById200Response**](DeleteCounterpartyById200Response.md)
|
|
1280
1106
|
|
|
1281
1107
|
### Authorization
|
|
1282
1108
|
|
|
@@ -1288,13 +1114,13 @@ Name | Type | Description | Notes
|
|
|
1288
1114
|
- **Accept**: application/json
|
|
1289
1115
|
|
|
1290
1116
|
|
|
1291
|
-
##
|
|
1117
|
+
## deleteCounterpartyEntry
|
|
1292
1118
|
|
|
1293
|
-
>
|
|
1119
|
+
> DeleteCounterpartyEntry200Response deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts)
|
|
1294
1120
|
|
|
1295
|
-
Delete counterparty
|
|
1121
|
+
Delete counterparty entry
|
|
1296
1122
|
|
|
1297
|
-
This operation deletes a counterparty
|
|
1123
|
+
This operation deletes a counterparty entry.
|
|
1298
1124
|
|
|
1299
1125
|
### Example
|
|
1300
1126
|
|
|
@@ -1308,8 +1134,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1308
1134
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1309
1135
|
// Call the API
|
|
1310
1136
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1137
|
+
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1311
1138
|
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1312
|
-
|
|
1139
|
+
const opts = {
|
|
1140
|
+
'entry_type': new CoboWaas2.EntryType()
|
|
1141
|
+
};
|
|
1142
|
+
apiInstance.deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts).then((data) => {
|
|
1313
1143
|
console.log('API called successfully. Returned data: ' + data);
|
|
1314
1144
|
}, (error) => {
|
|
1315
1145
|
console.error(error);
|
|
@@ -1322,11 +1152,13 @@ apiInstance.deleteCounterpartyById(counterparty_id).then((data) => {
|
|
|
1322
1152
|
|
|
1323
1153
|
Name | Type | Description | Notes
|
|
1324
1154
|
------------- | ------------- | ------------- | -------------
|
|
1155
|
+
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
1325
1156
|
**counterparty_id** | **String**| The counterparty ID. |
|
|
1157
|
+
**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]
|
|
1326
1158
|
|
|
1327
1159
|
### Return type
|
|
1328
1160
|
|
|
1329
|
-
[**
|
|
1161
|
+
[**DeleteCounterpartyEntry200Response**](DeleteCounterpartyEntry200Response.md)
|
|
1330
1162
|
|
|
1331
1163
|
### Authorization
|
|
1332
1164
|
|
|
@@ -1338,13 +1170,13 @@ Name | Type | Description | Notes
|
|
|
1338
1170
|
- **Accept**: application/json
|
|
1339
1171
|
|
|
1340
1172
|
|
|
1341
|
-
##
|
|
1173
|
+
## deleteCryptoAddress
|
|
1342
1174
|
|
|
1343
|
-
>
|
|
1175
|
+
> DeleteCryptoAddress201Response deleteCryptoAddress(crypto_address_id)
|
|
1344
1176
|
|
|
1345
|
-
Delete
|
|
1177
|
+
Delete crypto address
|
|
1346
1178
|
|
|
1347
|
-
This operation
|
|
1179
|
+
<Note>This operation has been deprecated.</Note> This operation unregisters a crypto address from being used for crypto payouts.
|
|
1348
1180
|
|
|
1349
1181
|
### Example
|
|
1350
1182
|
|
|
@@ -1358,12 +1190,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1358
1190
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1359
1191
|
// Call the API
|
|
1360
1192
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1361
|
-
const
|
|
1362
|
-
|
|
1363
|
-
const opts = {
|
|
1364
|
-
'entry_type': new CoboWaas2.EntryType()
|
|
1365
|
-
};
|
|
1366
|
-
apiInstance.deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts).then((data) => {
|
|
1193
|
+
const crypto_address_id = "addr_ethusdt_20250506T123456_ab12cd";
|
|
1194
|
+
apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
1367
1195
|
console.log('API called successfully. Returned data: ' + data);
|
|
1368
1196
|
}, (error) => {
|
|
1369
1197
|
console.error(error);
|
|
@@ -1376,13 +1204,11 @@ apiInstance.deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts
|
|
|
1376
1204
|
|
|
1377
1205
|
Name | Type | Description | Notes
|
|
1378
1206
|
------------- | ------------- | ------------- | -------------
|
|
1379
|
-
**
|
|
1380
|
-
**counterparty_id** | **String**| The counterparty ID. |
|
|
1381
|
-
**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]
|
|
1207
|
+
**crypto_address_id** | **String**| The crypto address ID. |
|
|
1382
1208
|
|
|
1383
1209
|
### Return type
|
|
1384
1210
|
|
|
1385
|
-
[**
|
|
1211
|
+
[**DeleteCryptoAddress201Response**](DeleteCryptoAddress201Response.md)
|
|
1386
1212
|
|
|
1387
1213
|
### Authorization
|
|
1388
1214
|
|
|
@@ -1394,13 +1220,13 @@ Name | Type | Description | Notes
|
|
|
1394
1220
|
- **Accept**: application/json
|
|
1395
1221
|
|
|
1396
1222
|
|
|
1397
|
-
##
|
|
1223
|
+
## deleteDestinationById
|
|
1398
1224
|
|
|
1399
|
-
>
|
|
1225
|
+
> DeleteDestinationById200Response deleteDestinationById(destination_id)
|
|
1400
1226
|
|
|
1401
|
-
Delete
|
|
1227
|
+
Delete destination
|
|
1402
1228
|
|
|
1403
|
-
This operation deletes a
|
|
1229
|
+
This operation deletes a destination. Note that this operation will delete all entries under the destination, including bank accounts and addresses.
|
|
1404
1230
|
|
|
1405
1231
|
### Example
|
|
1406
1232
|
|
|
@@ -1414,8 +1240,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1414
1240
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1415
1241
|
// Call the API
|
|
1416
1242
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1417
|
-
const
|
|
1418
|
-
apiInstance.
|
|
1243
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1244
|
+
apiInstance.deleteDestinationById(destination_id).then((data) => {
|
|
1419
1245
|
console.log('API called successfully. Returned data: ' + data);
|
|
1420
1246
|
}, (error) => {
|
|
1421
1247
|
console.error(error);
|
|
@@ -1428,11 +1254,11 @@ apiInstance.deleteCounterpartyWalletAddress(wallet_address_id).then((data) => {
|
|
|
1428
1254
|
|
|
1429
1255
|
Name | Type | Description | Notes
|
|
1430
1256
|
------------- | ------------- | ------------- | -------------
|
|
1431
|
-
**
|
|
1257
|
+
**destination_id** | **String**| The destination ID. |
|
|
1432
1258
|
|
|
1433
1259
|
### Return type
|
|
1434
1260
|
|
|
1435
|
-
[**
|
|
1261
|
+
[**DeleteDestinationById200Response**](DeleteDestinationById200Response.md)
|
|
1436
1262
|
|
|
1437
1263
|
### Authorization
|
|
1438
1264
|
|
|
@@ -1444,13 +1270,13 @@ Name | Type | Description | Notes
|
|
|
1444
1270
|
- **Accept**: application/json
|
|
1445
1271
|
|
|
1446
1272
|
|
|
1447
|
-
##
|
|
1273
|
+
## deleteDestinationEntry
|
|
1448
1274
|
|
|
1449
|
-
>
|
|
1275
|
+
> DeleteDestinationEntry200Response deleteDestinationEntry(destination_entry_id, destination_id, entry_type)
|
|
1450
1276
|
|
|
1451
|
-
Delete
|
|
1277
|
+
Delete destination entry
|
|
1452
1278
|
|
|
1453
|
-
This operation
|
|
1279
|
+
This operation deletes a destination entry.
|
|
1454
1280
|
|
|
1455
1281
|
### Example
|
|
1456
1282
|
|
|
@@ -1464,8 +1290,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1464
1290
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1465
1291
|
// Call the API
|
|
1466
1292
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1467
|
-
const
|
|
1468
|
-
|
|
1293
|
+
const destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1294
|
+
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
1295
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
1296
|
+
apiInstance.deleteDestinationEntry(destination_entry_id, destination_id, entry_type).then((data) => {
|
|
1469
1297
|
console.log('API called successfully. Returned data: ' + data);
|
|
1470
1298
|
}, (error) => {
|
|
1471
1299
|
console.error(error);
|
|
@@ -1478,11 +1306,13 @@ apiInstance.deleteCryptoAddress(crypto_address_id).then((data) => {
|
|
|
1478
1306
|
|
|
1479
1307
|
Name | Type | Description | Notes
|
|
1480
1308
|
------------- | ------------- | ------------- | -------------
|
|
1481
|
-
**
|
|
1309
|
+
**destination_entry_id** | **String**| The destination entry ID. For example, the wallet address ID or the bank account ID. |
|
|
1310
|
+
**destination_id** | **String**| The destination ID. |
|
|
1311
|
+
**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. |
|
|
1482
1312
|
|
|
1483
1313
|
### Return type
|
|
1484
1314
|
|
|
1485
|
-
[**
|
|
1315
|
+
[**DeleteDestinationEntry200Response**](DeleteDestinationEntry200Response.md)
|
|
1486
1316
|
|
|
1487
1317
|
### Authorization
|
|
1488
1318
|
|
|
@@ -1494,13 +1324,13 @@ Name | Type | Description | Notes
|
|
|
1494
1324
|
- **Accept**: application/json
|
|
1495
1325
|
|
|
1496
1326
|
|
|
1497
|
-
##
|
|
1327
|
+
## getAvailableAllocationAmount
|
|
1498
1328
|
|
|
1499
|
-
>
|
|
1329
|
+
> PaymentAllocationAmount getAvailableAllocationAmount(token_id, source_account, destination_account)
|
|
1500
1330
|
|
|
1501
|
-
|
|
1331
|
+
Get available allocation amount
|
|
1502
1332
|
|
|
1503
|
-
This operation
|
|
1333
|
+
This operation retrieves the available amount that can be allocated from a source account to a destination account.
|
|
1504
1334
|
|
|
1505
1335
|
### Example
|
|
1506
1336
|
|
|
@@ -1514,8 +1344,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1514
1344
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1515
1345
|
// Call the API
|
|
1516
1346
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1517
|
-
const
|
|
1518
|
-
|
|
1347
|
+
const token_id = "ETH_USDT";
|
|
1348
|
+
const source_account = "source_account_example";
|
|
1349
|
+
const destination_account = "destination_account_example";
|
|
1350
|
+
apiInstance.getAvailableAllocationAmount(token_id, source_account, destination_account).then((data) => {
|
|
1519
1351
|
console.log('API called successfully. Returned data: ' + data);
|
|
1520
1352
|
}, (error) => {
|
|
1521
1353
|
console.error(error);
|
|
@@ -1528,11 +1360,13 @@ apiInstance.deleteDestination(destination_id).then((data) => {
|
|
|
1528
1360
|
|
|
1529
1361
|
Name | Type | Description | Notes
|
|
1530
1362
|
------------- | ------------- | ------------- | -------------
|
|
1531
|
-
**
|
|
1363
|
+
**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` |
|
|
1364
|
+
**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\"`. |
|
|
1365
|
+
**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\"`. |
|
|
1532
1366
|
|
|
1533
1367
|
### Return type
|
|
1534
1368
|
|
|
1535
|
-
[**
|
|
1369
|
+
[**PaymentAllocationAmount**](PaymentAllocationAmount.md)
|
|
1536
1370
|
|
|
1537
1371
|
### Authorization
|
|
1538
1372
|
|
|
@@ -1544,13 +1378,13 @@ Name | Type | Description | Notes
|
|
|
1544
1378
|
- **Accept**: application/json
|
|
1545
1379
|
|
|
1546
1380
|
|
|
1547
|
-
##
|
|
1381
|
+
## getBatchAllocationById
|
|
1548
1382
|
|
|
1549
|
-
>
|
|
1383
|
+
> BatchAllocationDetail getBatchAllocationById(batch_allocation_id)
|
|
1550
1384
|
|
|
1551
|
-
|
|
1385
|
+
Get batch allocation information
|
|
1552
1386
|
|
|
1553
|
-
This operation
|
|
1387
|
+
This operation retrieves the information of a batch allocation.
|
|
1554
1388
|
|
|
1555
1389
|
### Example
|
|
1556
1390
|
|
|
@@ -1564,8 +1398,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1564
1398
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1565
1399
|
// Call the API
|
|
1566
1400
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1567
|
-
const
|
|
1568
|
-
apiInstance.
|
|
1401
|
+
const batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1402
|
+
apiInstance.getBatchAllocationById(batch_allocation_id).then((data) => {
|
|
1569
1403
|
console.log('API called successfully. Returned data: ' + data);
|
|
1570
1404
|
}, (error) => {
|
|
1571
1405
|
console.error(error);
|
|
@@ -1578,11 +1412,11 @@ apiInstance.deleteDestinationBankAccount(bank_account_id).then((data) => {
|
|
|
1578
1412
|
|
|
1579
1413
|
Name | Type | Description | Notes
|
|
1580
1414
|
------------- | ------------- | ------------- | -------------
|
|
1581
|
-
**
|
|
1415
|
+
**batch_allocation_id** | **String**| The batch allocation ID. |
|
|
1582
1416
|
|
|
1583
1417
|
### Return type
|
|
1584
1418
|
|
|
1585
|
-
[**
|
|
1419
|
+
[**BatchAllocationDetail**](BatchAllocationDetail.md)
|
|
1586
1420
|
|
|
1587
1421
|
### Authorization
|
|
1588
1422
|
|
|
@@ -1594,13 +1428,13 @@ Name | Type | Description | Notes
|
|
|
1594
1428
|
- **Accept**: application/json
|
|
1595
1429
|
|
|
1596
1430
|
|
|
1597
|
-
##
|
|
1431
|
+
## getBulkSendById
|
|
1598
1432
|
|
|
1599
|
-
>
|
|
1433
|
+
> PaymentBulkSend getBulkSendById(bulk_send_id)
|
|
1600
1434
|
|
|
1601
|
-
|
|
1435
|
+
Get bulk send information
|
|
1602
1436
|
|
|
1603
|
-
This operation
|
|
1437
|
+
This operation retrieves the information of a specific bulk send.
|
|
1604
1438
|
|
|
1605
1439
|
### Example
|
|
1606
1440
|
|
|
@@ -1614,8 +1448,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1614
1448
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1615
1449
|
// Call the API
|
|
1616
1450
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1617
|
-
const
|
|
1618
|
-
apiInstance.
|
|
1451
|
+
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1452
|
+
apiInstance.getBulkSendById(bulk_send_id).then((data) => {
|
|
1619
1453
|
console.log('API called successfully. Returned data: ' + data);
|
|
1620
1454
|
}, (error) => {
|
|
1621
1455
|
console.error(error);
|
|
@@ -1628,11 +1462,11 @@ apiInstance.deleteDestinationById(destination_id).then((data) => {
|
|
|
1628
1462
|
|
|
1629
1463
|
Name | Type | Description | Notes
|
|
1630
1464
|
------------- | ------------- | ------------- | -------------
|
|
1631
|
-
**
|
|
1465
|
+
**bulk_send_id** | **String**| The bulk send ID. |
|
|
1632
1466
|
|
|
1633
1467
|
### Return type
|
|
1634
1468
|
|
|
1635
|
-
[**
|
|
1469
|
+
[**PaymentBulkSend**](PaymentBulkSend.md)
|
|
1636
1470
|
|
|
1637
1471
|
### Authorization
|
|
1638
1472
|
|
|
@@ -1644,13 +1478,13 @@ Name | Type | Description | Notes
|
|
|
1644
1478
|
- **Accept**: application/json
|
|
1645
1479
|
|
|
1646
1480
|
|
|
1647
|
-
##
|
|
1481
|
+
## getCounterparty
|
|
1648
1482
|
|
|
1649
|
-
>
|
|
1483
|
+
> CounterpartyDetail getCounterparty(counterparty_id)
|
|
1650
1484
|
|
|
1651
|
-
|
|
1485
|
+
Get counterparty information
|
|
1652
1486
|
|
|
1653
|
-
This operation
|
|
1487
|
+
This operation retrieves the detailed information about a specified counterparty.
|
|
1654
1488
|
|
|
1655
1489
|
### Example
|
|
1656
1490
|
|
|
@@ -1664,472 +1498,8 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
1664
1498
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1665
1499
|
// Call the API
|
|
1666
1500
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1667
|
-
const
|
|
1668
|
-
|
|
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)
|
|
1806
|
-
|
|
1807
|
-
Get available allocation amount
|
|
1808
|
-
|
|
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.
|
|
1964
|
-
|
|
1965
|
-
### Example
|
|
1966
|
-
|
|
1967
|
-
```javascript
|
|
1968
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1969
|
-
// Initialize the API client
|
|
1970
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
1971
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
1972
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1973
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
1974
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
1975
|
-
// Call the API
|
|
1976
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
1977
|
-
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1978
|
-
apiInstance.getCounterparty(counterparty_id).then((data) => {
|
|
1979
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
1980
|
-
}, (error) => {
|
|
1981
|
-
console.error(error);
|
|
1982
|
-
});
|
|
1983
|
-
|
|
1984
|
-
```
|
|
1985
|
-
|
|
1986
|
-
### Parameters
|
|
1987
|
-
|
|
1988
|
-
|
|
1989
|
-
Name | Type | Description | Notes
|
|
1990
|
-
------------- | ------------- | ------------- | -------------
|
|
1991
|
-
**counterparty_id** | **String**| The counterparty ID. |
|
|
1992
|
-
|
|
1993
|
-
### Return type
|
|
1994
|
-
|
|
1995
|
-
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
1996
|
-
|
|
1997
|
-
### Authorization
|
|
1998
|
-
|
|
1999
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2000
|
-
|
|
2001
|
-
### HTTP request headers
|
|
2002
|
-
|
|
2003
|
-
- **Content-Type**: Not defined
|
|
2004
|
-
- **Accept**: application/json
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
## getCounterpartyDetailById
|
|
2008
|
-
|
|
2009
|
-
> CounterpartyDetail getCounterpartyDetailById(counterparty_id)
|
|
2010
|
-
|
|
2011
|
-
Get counterparty information (Deprecated)
|
|
2012
|
-
|
|
2013
|
-
This operation retrieves the detailed information about a specified counterparty.
|
|
2014
|
-
|
|
2015
|
-
### Example
|
|
2016
|
-
|
|
2017
|
-
```javascript
|
|
2018
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2019
|
-
// Initialize the API client
|
|
2020
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
2021
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2022
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2023
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2024
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2025
|
-
// Call the API
|
|
2026
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2027
|
-
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
2028
|
-
apiInstance.getCounterpartyDetailById(counterparty_id).then((data) => {
|
|
2029
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
2030
|
-
}, (error) => {
|
|
2031
|
-
console.error(error);
|
|
2032
|
-
});
|
|
2033
|
-
|
|
2034
|
-
```
|
|
2035
|
-
|
|
2036
|
-
### Parameters
|
|
2037
|
-
|
|
2038
|
-
|
|
2039
|
-
Name | Type | Description | Notes
|
|
2040
|
-
------------- | ------------- | ------------- | -------------
|
|
2041
|
-
**counterparty_id** | **String**| The counterparty ID. |
|
|
2042
|
-
|
|
2043
|
-
### Return type
|
|
2044
|
-
|
|
2045
|
-
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
2046
|
-
|
|
2047
|
-
### Authorization
|
|
2048
|
-
|
|
2049
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2050
|
-
|
|
2051
|
-
### HTTP request headers
|
|
2052
|
-
|
|
2053
|
-
- **Content-Type**: Not defined
|
|
2054
|
-
- **Accept**: application/json
|
|
2055
|
-
|
|
2056
|
-
|
|
2057
|
-
## getCounterpartyEntry
|
|
2058
|
-
|
|
2059
|
-
> GetCounterpartyEntry200Response getCounterpartyEntry(counterparty_entry_id, opts)
|
|
2060
|
-
|
|
2061
|
-
Get counterparty entry information
|
|
2062
|
-
|
|
2063
|
-
This operation retrieves the detailed information about a specified counterparty entry.
|
|
2064
|
-
|
|
2065
|
-
### Example
|
|
2066
|
-
|
|
2067
|
-
```javascript
|
|
2068
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2069
|
-
// Initialize the API client
|
|
2070
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
2071
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2072
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2073
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2074
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2075
|
-
// Call the API
|
|
2076
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2077
|
-
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
2078
|
-
const opts = {
|
|
2079
|
-
'entry_type': new CoboWaas2.EntryType()
|
|
2080
|
-
};
|
|
2081
|
-
apiInstance.getCounterpartyEntry(counterparty_entry_id, opts).then((data) => {
|
|
2082
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
2083
|
-
}, (error) => {
|
|
2084
|
-
console.error(error);
|
|
2085
|
-
});
|
|
2086
|
-
|
|
2087
|
-
```
|
|
2088
|
-
|
|
2089
|
-
### Parameters
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
Name | Type | Description | Notes
|
|
2093
|
-
------------- | ------------- | ------------- | -------------
|
|
2094
|
-
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
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]
|
|
2096
|
-
|
|
2097
|
-
### Return type
|
|
2098
|
-
|
|
2099
|
-
[**GetCounterpartyEntry200Response**](GetCounterpartyEntry200Response.md)
|
|
2100
|
-
|
|
2101
|
-
### Authorization
|
|
2102
|
-
|
|
2103
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
2104
|
-
|
|
2105
|
-
### HTTP request headers
|
|
2106
|
-
|
|
2107
|
-
- **Content-Type**: Not defined
|
|
2108
|
-
- **Accept**: application/json
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
## getDestination
|
|
2112
|
-
|
|
2113
|
-
> DestinationDetail getDestination(destination_id)
|
|
2114
|
-
|
|
2115
|
-
Get destination information
|
|
2116
|
-
|
|
2117
|
-
This operation retrieves the detailed information about a specified destination.
|
|
2118
|
-
|
|
2119
|
-
### Example
|
|
2120
|
-
|
|
2121
|
-
```javascript
|
|
2122
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
2123
|
-
// Initialize the API client
|
|
2124
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
2125
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
2126
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
2127
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
2128
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2129
|
-
// Call the API
|
|
2130
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2131
|
-
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
2132
|
-
apiInstance.getDestination(destination_id).then((data) => {
|
|
1501
|
+
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
|
|
1502
|
+
apiInstance.getCounterparty(counterparty_id).then((data) => {
|
|
2133
1503
|
console.log('API called successfully. Returned data: ' + data);
|
|
2134
1504
|
}, (error) => {
|
|
2135
1505
|
console.error(error);
|
|
@@ -2142,11 +1512,11 @@ apiInstance.getDestination(destination_id).then((data) => {
|
|
|
2142
1512
|
|
|
2143
1513
|
Name | Type | Description | Notes
|
|
2144
1514
|
------------- | ------------- | ------------- | -------------
|
|
2145
|
-
**
|
|
1515
|
+
**counterparty_id** | **String**| The counterparty ID. |
|
|
2146
1516
|
|
|
2147
1517
|
### Return type
|
|
2148
1518
|
|
|
2149
|
-
[**
|
|
1519
|
+
[**CounterpartyDetail**](CounterpartyDetail.md)
|
|
2150
1520
|
|
|
2151
1521
|
### Authorization
|
|
2152
1522
|
|
|
@@ -2158,13 +1528,13 @@ Name | Type | Description | Notes
|
|
|
2158
1528
|
- **Accept**: application/json
|
|
2159
1529
|
|
|
2160
1530
|
|
|
2161
|
-
##
|
|
1531
|
+
## getCounterpartyEntry
|
|
2162
1532
|
|
|
2163
|
-
>
|
|
1533
|
+
> GetCounterpartyEntry200Response getCounterpartyEntry(counterparty_entry_id, opts)
|
|
2164
1534
|
|
|
2165
|
-
Get
|
|
1535
|
+
Get counterparty entry information
|
|
2166
1536
|
|
|
2167
|
-
This operation retrieves the detailed information about a specified
|
|
1537
|
+
This operation retrieves the detailed information about a specified counterparty entry.
|
|
2168
1538
|
|
|
2169
1539
|
### Example
|
|
2170
1540
|
|
|
@@ -2178,8 +1548,11 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2178
1548
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2179
1549
|
// Call the API
|
|
2180
1550
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2181
|
-
const
|
|
2182
|
-
|
|
1551
|
+
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
1552
|
+
const opts = {
|
|
1553
|
+
'entry_type': new CoboWaas2.EntryType()
|
|
1554
|
+
};
|
|
1555
|
+
apiInstance.getCounterpartyEntry(counterparty_entry_id, opts).then((data) => {
|
|
2183
1556
|
console.log('API called successfully. Returned data: ' + data);
|
|
2184
1557
|
}, (error) => {
|
|
2185
1558
|
console.error(error);
|
|
@@ -2192,11 +1565,12 @@ apiInstance.getDestinationBankAccountDetailById(bank_account_id).then((data) =>
|
|
|
2192
1565
|
|
|
2193
1566
|
Name | Type | Description | Notes
|
|
2194
1567
|
------------- | ------------- | ------------- | -------------
|
|
2195
|
-
**
|
|
1568
|
+
**counterparty_entry_id** | **String**| The counterparty entry ID. For example, the wallet address ID. |
|
|
1569
|
+
**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
1570
|
|
|
2197
1571
|
### Return type
|
|
2198
1572
|
|
|
2199
|
-
[**
|
|
1573
|
+
[**GetCounterpartyEntry200Response**](GetCounterpartyEntry200Response.md)
|
|
2200
1574
|
|
|
2201
1575
|
### Authorization
|
|
2202
1576
|
|
|
@@ -2208,11 +1582,11 @@ Name | Type | Description | Notes
|
|
|
2208
1582
|
- **Accept**: application/json
|
|
2209
1583
|
|
|
2210
1584
|
|
|
2211
|
-
##
|
|
1585
|
+
## getDestination
|
|
2212
1586
|
|
|
2213
|
-
> DestinationDetail
|
|
1587
|
+
> DestinationDetail getDestination(destination_id)
|
|
2214
1588
|
|
|
2215
|
-
Get destination information
|
|
1589
|
+
Get destination information
|
|
2216
1590
|
|
|
2217
1591
|
This operation retrieves the detailed information about a specified destination.
|
|
2218
1592
|
|
|
@@ -2229,7 +1603,7 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
2229
1603
|
// Call the API
|
|
2230
1604
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2231
1605
|
const destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f";
|
|
2232
|
-
apiInstance.
|
|
1606
|
+
apiInstance.getDestination(destination_id).then((data) => {
|
|
2233
1607
|
console.log('API called successfully. Returned data: ' + data);
|
|
2234
1608
|
}, (error) => {
|
|
2235
1609
|
console.error(error);
|
|
@@ -3035,198 +2409,12 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
3035
2409
|
// Call the API
|
|
3036
2410
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3037
2411
|
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
3038
|
-
const opts = {
|
|
3039
|
-
'limit': 10,
|
|
3040
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3041
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
3042
|
-
};
|
|
3043
|
-
apiInstance.listBulkSendItems(bulk_send_id, opts).then((data) => {
|
|
3044
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
3045
|
-
}, (error) => {
|
|
3046
|
-
console.error(error);
|
|
3047
|
-
});
|
|
3048
|
-
|
|
3049
|
-
```
|
|
3050
|
-
|
|
3051
|
-
### Parameters
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
Name | Type | Description | Notes
|
|
3055
|
-
------------- | ------------- | ------------- | -------------
|
|
3056
|
-
**bulk_send_id** | **String**| The bulk send ID. |
|
|
3057
|
-
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3058
|
-
**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]
|
|
3059
|
-
**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]
|
|
3060
|
-
|
|
3061
|
-
### Return type
|
|
3062
|
-
|
|
3063
|
-
[**ListBulkSendItems200Response**](ListBulkSendItems200Response.md)
|
|
3064
|
-
|
|
3065
|
-
### Authorization
|
|
3066
|
-
|
|
3067
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3068
|
-
|
|
3069
|
-
### HTTP request headers
|
|
3070
|
-
|
|
3071
|
-
- **Content-Type**: Not defined
|
|
3072
|
-
- **Accept**: application/json
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
## listCounterparties
|
|
3076
|
-
|
|
3077
|
-
> ListCounterparties200Response listCounterparties(opts)
|
|
3078
|
-
|
|
3079
|
-
List all counterparties
|
|
3080
|
-
|
|
3081
|
-
This operation retrieves the information of all counterparties. You can filter the results by using a keyword for fuzzy search on counterparty names.
|
|
3082
|
-
|
|
3083
|
-
### Example
|
|
3084
|
-
|
|
3085
|
-
```javascript
|
|
3086
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3087
|
-
// Initialize the API client
|
|
3088
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
3089
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3090
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3091
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3092
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3093
|
-
// Call the API
|
|
3094
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3095
|
-
const opts = {
|
|
3096
|
-
'limit': 10,
|
|
3097
|
-
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3098
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3099
|
-
'keyword': "keyword",
|
|
3100
|
-
'counterparty_type': new CoboWaas2.CounterpartyType(),
|
|
3101
|
-
'country': "USA"
|
|
3102
|
-
};
|
|
3103
|
-
apiInstance.listCounterparties(opts).then((data) => {
|
|
3104
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
3105
|
-
}, (error) => {
|
|
3106
|
-
console.error(error);
|
|
3107
|
-
});
|
|
3108
|
-
|
|
3109
|
-
```
|
|
3110
|
-
|
|
3111
|
-
### Parameters
|
|
3112
|
-
|
|
3113
|
-
|
|
3114
|
-
Name | Type | Description | Notes
|
|
3115
|
-
------------- | ------------- | ------------- | -------------
|
|
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..."
|
|
2412
|
+
const opts = {
|
|
2413
|
+
'limit': 10,
|
|
2414
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2415
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
3228
2416
|
};
|
|
3229
|
-
apiInstance.
|
|
2417
|
+
apiInstance.listBulkSendItems(bulk_send_id, opts).then((data) => {
|
|
3230
2418
|
console.log('API called successfully. Returned data: ' + data);
|
|
3231
2419
|
}, (error) => {
|
|
3232
2420
|
console.error(error);
|
|
@@ -3239,16 +2427,14 @@ apiInstance.listCounterpartyWalletAddress(opts).then((data) => {
|
|
|
3239
2427
|
|
|
3240
2428
|
Name | Type | Description | Notes
|
|
3241
2429
|
------------- | ------------- | ------------- | -------------
|
|
2430
|
+
**bulk_send_id** | **String**| The bulk send ID. |
|
|
3242
2431
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3243
2432
|
**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
2433
|
**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
2434
|
|
|
3249
2435
|
### Return type
|
|
3250
2436
|
|
|
3251
|
-
[**
|
|
2437
|
+
[**ListBulkSendItems200Response**](ListBulkSendItems200Response.md)
|
|
3252
2438
|
|
|
3253
2439
|
### Authorization
|
|
3254
2440
|
|
|
@@ -3260,13 +2446,13 @@ Name | Type | Description | Notes
|
|
|
3260
2446
|
- **Accept**: application/json
|
|
3261
2447
|
|
|
3262
2448
|
|
|
3263
|
-
##
|
|
2449
|
+
## listCounterparties
|
|
3264
2450
|
|
|
3265
|
-
>
|
|
2451
|
+
> ListCounterparties200Response listCounterparties(opts)
|
|
3266
2452
|
|
|
3267
|
-
List
|
|
2453
|
+
List all counterparties
|
|
3268
2454
|
|
|
3269
|
-
This operation retrieves
|
|
2455
|
+
This operation retrieves the information of all counterparties. You can filter the results by using a keyword for fuzzy search on counterparty names.
|
|
3270
2456
|
|
|
3271
2457
|
### Example
|
|
3272
2458
|
|
|
@@ -3281,9 +2467,14 @@ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
|
3281
2467
|
// Call the API
|
|
3282
2468
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3283
2469
|
const opts = {
|
|
3284
|
-
'
|
|
2470
|
+
'limit': 10,
|
|
2471
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2472
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2473
|
+
'keyword': "keyword",
|
|
2474
|
+
'counterparty_type': new CoboWaas2.CounterpartyType(),
|
|
2475
|
+
'country': "USA"
|
|
3285
2476
|
};
|
|
3286
|
-
apiInstance.
|
|
2477
|
+
apiInstance.listCounterparties(opts).then((data) => {
|
|
3287
2478
|
console.log('API called successfully. Returned data: ' + data);
|
|
3288
2479
|
}, (error) => {
|
|
3289
2480
|
console.error(error);
|
|
@@ -3296,11 +2487,16 @@ apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
|
3296
2487
|
|
|
3297
2488
|
Name | Type | Description | Notes
|
|
3298
2489
|
------------- | ------------- | ------------- | -------------
|
|
3299
|
-
**
|
|
2490
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2491
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
2492
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
2493
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2494
|
+
**counterparty_type** | [**CounterpartyType**](.md)| The type of the counterparty. - `Individual`: The counterparty is an individual. - `Organization`: The counterparty is an organization. | [optional]
|
|
2495
|
+
**country** | **String**| Country code, in ISO 3166-1 alpha-3 format. | [optional]
|
|
3300
2496
|
|
|
3301
2497
|
### Return type
|
|
3302
2498
|
|
|
3303
|
-
[**
|
|
2499
|
+
[**ListCounterparties200Response**](ListCounterparties200Response.md)
|
|
3304
2500
|
|
|
3305
2501
|
### Authorization
|
|
3306
2502
|
|
|
@@ -3312,13 +2508,13 @@ Name | Type | Description | Notes
|
|
|
3312
2508
|
- **Accept**: application/json
|
|
3313
2509
|
|
|
3314
2510
|
|
|
3315
|
-
##
|
|
2511
|
+
## listCounterpartyEntries
|
|
3316
2512
|
|
|
3317
|
-
>
|
|
2513
|
+
> ListCounterpartyEntries200Response listCounterpartyEntries(opts)
|
|
3318
2514
|
|
|
3319
|
-
List
|
|
2515
|
+
List counterparty entries
|
|
3320
2516
|
|
|
3321
|
-
This operation retrieves the information of
|
|
2517
|
+
This operation retrieves the information of counterparty entries.
|
|
3322
2518
|
|
|
3323
2519
|
### Example
|
|
3324
2520
|
|
|
@@ -3336,11 +2532,12 @@ const opts = {
|
|
|
3336
2532
|
'limit': 10,
|
|
3337
2533
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3338
2534
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3339
|
-
'
|
|
3340
|
-
'
|
|
3341
|
-
'
|
|
2535
|
+
'entry_type': new CoboWaas2.EntryType(),
|
|
2536
|
+
'counterparty_id': "5b0ed293-f728-40b4-b1f6-86b88cd51384",
|
|
2537
|
+
'chain_ids': "ETH",
|
|
2538
|
+
'wallet_address': "0x1234567890abcdef..."
|
|
3342
2539
|
};
|
|
3343
|
-
apiInstance.
|
|
2540
|
+
apiInstance.listCounterpartyEntries(opts).then((data) => {
|
|
3344
2541
|
console.log('API called successfully. Returned data: ' + data);
|
|
3345
2542
|
}, (error) => {
|
|
3346
2543
|
console.error(error);
|
|
@@ -3356,13 +2553,14 @@ Name | Type | Description | Notes
|
|
|
3356
2553
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3357
2554
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
3358
2555
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
3359
|
-
**
|
|
3360
|
-
**
|
|
3361
|
-
**
|
|
2556
|
+
**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]
|
|
2557
|
+
**counterparty_id** | **String**| The counterparty ID. | [optional]
|
|
2558
|
+
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
2559
|
+
**wallet_address** | **String**| The wallet address. | [optional]
|
|
3362
2560
|
|
|
3363
2561
|
### Return type
|
|
3364
2562
|
|
|
3365
|
-
[**
|
|
2563
|
+
[**ListCounterpartyEntries200Response**](ListCounterpartyEntries200Response.md)
|
|
3366
2564
|
|
|
3367
2565
|
### Authorization
|
|
3368
2566
|
|
|
@@ -3374,13 +2572,13 @@ Name | Type | Description | Notes
|
|
|
3374
2572
|
- **Accept**: application/json
|
|
3375
2573
|
|
|
3376
2574
|
|
|
3377
|
-
##
|
|
2575
|
+
## listCryptoAddresses
|
|
3378
2576
|
|
|
3379
|
-
>
|
|
2577
|
+
> [CryptoAddress] listCryptoAddresses(opts)
|
|
3380
2578
|
|
|
3381
|
-
List
|
|
2579
|
+
List crypto addresses
|
|
3382
2580
|
|
|
3383
|
-
This operation retrieves
|
|
2581
|
+
<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
2582
|
|
|
3385
2583
|
### Example
|
|
3386
2584
|
|
|
@@ -3394,18 +2592,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
3394
2592
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3395
2593
|
// Call the API
|
|
3396
2594
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3397
|
-
const entry_type = new CoboWaas2.EntryType();
|
|
3398
2595
|
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()
|
|
2596
|
+
'token_id': "ETH_USDT"
|
|
3407
2597
|
};
|
|
3408
|
-
apiInstance.
|
|
2598
|
+
apiInstance.listCryptoAddresses(opts).then((data) => {
|
|
3409
2599
|
console.log('API called successfully. Returned data: ' + data);
|
|
3410
2600
|
}, (error) => {
|
|
3411
2601
|
console.error(error);
|
|
@@ -3418,19 +2608,11 @@ apiInstance.listDestinationEntries(entry_type, opts).then((data) => {
|
|
|
3418
2608
|
|
|
3419
2609
|
Name | Type | Description | Notes
|
|
3420
2610
|
------------- | ------------- | ------------- | -------------
|
|
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]
|
|
2611
|
+
**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
2612
|
|
|
3431
2613
|
### Return type
|
|
3432
2614
|
|
|
3433
|
-
[**
|
|
2615
|
+
[**[CryptoAddress]**](CryptoAddress.md)
|
|
3434
2616
|
|
|
3435
2617
|
### Authorization
|
|
3436
2618
|
|
|
@@ -3442,13 +2624,13 @@ Name | Type | Description | Notes
|
|
|
3442
2624
|
- **Accept**: application/json
|
|
3443
2625
|
|
|
3444
2626
|
|
|
3445
|
-
##
|
|
2627
|
+
## listDestinationEntries
|
|
3446
2628
|
|
|
3447
|
-
>
|
|
2629
|
+
> ListDestinationEntries200Response listDestinationEntries(entry_type, opts)
|
|
3448
2630
|
|
|
3449
|
-
List destination
|
|
2631
|
+
List destination entries
|
|
3450
2632
|
|
|
3451
|
-
This operation retrieves the information of destination
|
|
2633
|
+
This operation retrieves the information of destination entries.
|
|
3452
2634
|
|
|
3453
2635
|
### Example
|
|
3454
2636
|
|
|
@@ -3462,15 +2644,18 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
3462
2644
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3463
2645
|
// Call the API
|
|
3464
2646
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2647
|
+
const entry_type = new CoboWaas2.EntryType();
|
|
3465
2648
|
const opts = {
|
|
3466
2649
|
'limit': 10,
|
|
3467
2650
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3468
2651
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3469
2652
|
'destination_id': "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
|
|
3470
2653
|
'chain_ids': "ETH",
|
|
3471
|
-
'wallet_address': "0x1234567890abcdef..."
|
|
2654
|
+
'wallet_address': "0x1234567890abcdef...",
|
|
2655
|
+
'keyword': "keyword",
|
|
2656
|
+
'bank_account_status': new CoboWaas2.BankAccountStatus()
|
|
3472
2657
|
};
|
|
3473
|
-
apiInstance.
|
|
2658
|
+
apiInstance.listDestinationEntries(entry_type, opts).then((data) => {
|
|
3474
2659
|
console.log('API called successfully. Returned data: ' + data);
|
|
3475
2660
|
}, (error) => {
|
|
3476
2661
|
console.error(error);
|
|
@@ -3483,16 +2668,19 @@ apiInstance.listDestinationWalletAddresses(opts).then((data) => {
|
|
|
3483
2668
|
|
|
3484
2669
|
Name | Type | Description | Notes
|
|
3485
2670
|
------------- | ------------- | ------------- | -------------
|
|
2671
|
+
**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
2672
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3487
2673
|
**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
2674
|
**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
2675
|
**destination_id** | **String**| The destination ID. | [optional]
|
|
3490
2676
|
**chain_ids** | **String**| The chain ID, which is the unique identifier of a blockchain. | [optional]
|
|
3491
2677
|
**wallet_address** | **String**| The wallet address. | [optional]
|
|
2678
|
+
**keyword** | **String**| A search term for performing fuzzy matches in the search query. | [optional]
|
|
2679
|
+
**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
2680
|
|
|
3493
2681
|
### Return type
|
|
3494
2682
|
|
|
3495
|
-
[**
|
|
2683
|
+
[**ListDestinationEntries200Response**](ListDestinationEntries200Response.md)
|
|
3496
2684
|
|
|
3497
2685
|
### Authorization
|
|
3498
2686
|
|
|
@@ -3628,11 +2816,11 @@ Name | Type | Description | Notes
|
|
|
3628
2816
|
|
|
3629
2817
|
## listMerchantBalances
|
|
3630
2818
|
|
|
3631
|
-
> ListMerchantBalances200Response listMerchantBalances(
|
|
2819
|
+
> ListMerchantBalances200Response listMerchantBalances(opts)
|
|
3632
2820
|
|
|
3633
2821
|
List merchant balances
|
|
3634
2822
|
|
|
3635
|
-
|
|
2823
|
+
This operation retrieves merchant balance information. You need to specify at least one of `merchant_ids` or `token_id` to filter the results. <Note>Do not pass `acquiring_type` for this operation.</Note> For more information, refer to [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview).
|
|
3636
2824
|
|
|
3637
2825
|
### Example
|
|
3638
2826
|
|
|
@@ -3646,12 +2834,12 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
3646
2834
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3647
2835
|
// Call the API
|
|
3648
2836
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3649
|
-
const token_id = "ETH_USDT";
|
|
3650
2837
|
const opts = {
|
|
3651
2838
|
'merchant_ids': "M1001,M1002,M1003",
|
|
2839
|
+
'token_id': "ETH_USDT",
|
|
3652
2840
|
'acquiring_type': new CoboWaas2.AcquiringType()
|
|
3653
2841
|
};
|
|
3654
|
-
apiInstance.listMerchantBalances(
|
|
2842
|
+
apiInstance.listMerchantBalances(opts).then((data) => {
|
|
3655
2843
|
console.log('API called successfully. Returned data: ' + data);
|
|
3656
2844
|
}, (error) => {
|
|
3657
2845
|
console.error(error);
|
|
@@ -3664,8 +2852,8 @@ apiInstance.listMerchantBalances(token_id, opts).then((data) => {
|
|
|
3664
2852
|
|
|
3665
2853
|
Name | Type | Description | Notes
|
|
3666
2854
|
------------- | ------------- | ------------- | -------------
|
|
3667
|
-
**
|
|
3668
|
-
**
|
|
2855
|
+
**merchant_ids** | **String**| The comma-separated list of merchant IDs to filter by. At least one of `merchant_ids` or `token_id` must be provided. For more information about merchants, refer to [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). | [optional]
|
|
2856
|
+
**token_id** | **String**| The token ID that identifies the cryptocurrency. At least one of `merchant_ids` or `token_id` must be provided. For a complete list of supported tokens, refer to [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). | [optional]
|
|
3669
2857
|
**acquiring_type** | [**AcquiringType**](.md)| This parameter has been deprecated | [optional]
|
|
3670
2858
|
|
|
3671
2859
|
### Return type
|
|
@@ -3810,9 +2998,9 @@ Name | Type | Description | Notes
|
|
|
3810
2998
|
|
|
3811
2999
|
> [SupportedToken] listPaymentSupportedTokens()
|
|
3812
3000
|
|
|
3813
|
-
List
|
|
3001
|
+
List supported tokens
|
|
3814
3002
|
|
|
3815
|
-
This operation retrieves
|
|
3003
|
+
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
3004
|
|
|
3817
3005
|
### Example
|
|
3818
3006
|
|
|
@@ -4254,13 +3442,13 @@ Name | Type | Description | Notes
|
|
|
4254
3442
|
- **Accept**: application/json
|
|
4255
3443
|
|
|
4256
3444
|
|
|
4257
|
-
##
|
|
3445
|
+
## triggerTestPaymentsWebhookEvent
|
|
4258
3446
|
|
|
4259
|
-
>
|
|
3447
|
+
> TriggerTestPaymentWebhookEventResponse triggerTestPaymentsWebhookEvent(opts)
|
|
4260
3448
|
|
|
4261
|
-
|
|
3449
|
+
Trigger test webhook event
|
|
4262
3450
|
|
|
4263
|
-
This operation
|
|
3451
|
+
This operation tests the functionality of your Payments webhook endpoint by triggering a test webhook event. The test event is sent to all endpoints you have registered on Cobo Portal. You need to specify the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload. For more information about Payments webhooks, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). For webhook event types and payload structure, refer to [List all webhook events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-webhook-events).
|
|
4264
3452
|
|
|
4265
3453
|
### Example
|
|
4266
3454
|
|
|
@@ -4274,7 +3462,10 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
4274
3462
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
4275
3463
|
// Call the API
|
|
4276
3464
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
4277
|
-
|
|
3465
|
+
const opts = {
|
|
3466
|
+
'TriggerTestPaymentsWebhookEventRequest': new CoboWaas2.TriggerTestPaymentsWebhookEventRequest()
|
|
3467
|
+
};
|
|
3468
|
+
apiInstance.triggerTestPaymentsWebhookEvent(opts).then((data) => {
|
|
4278
3469
|
console.log('API called successfully. Returned data: ' + data);
|
|
4279
3470
|
}, (error) => {
|
|
4280
3471
|
console.error(error);
|
|
@@ -4284,19 +3475,22 @@ apiInstance.queryDestinationWhitelistEnabled().then((data) => {
|
|
|
4284
3475
|
|
|
4285
3476
|
### Parameters
|
|
4286
3477
|
|
|
4287
|
-
|
|
3478
|
+
|
|
3479
|
+
Name | Type | Description | Notes
|
|
3480
|
+
------------- | ------------- | ------------- | -------------
|
|
3481
|
+
**TriggerTestPaymentsWebhookEventRequest** | [**TriggerTestPaymentsWebhookEventRequest**](TriggerTestPaymentsWebhookEventRequest.md)| The request body used to trigger a test Payments webhook event. You need to specify the event type. You can optionally include the `override_data` property to customize the payload. The provided fields must match the webhook event data structure for the specified event type. | [optional]
|
|
4288
3482
|
|
|
4289
3483
|
### Return type
|
|
4290
3484
|
|
|
4291
|
-
[**
|
|
3485
|
+
[**TriggerTestPaymentWebhookEventResponse**](TriggerTestPaymentWebhookEventResponse.md)
|
|
4292
3486
|
|
|
4293
3487
|
### Authorization
|
|
4294
3488
|
|
|
4295
|
-
[
|
|
3489
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
4296
3490
|
|
|
4297
3491
|
### HTTP request headers
|
|
4298
3492
|
|
|
4299
|
-
- **Content-Type**:
|
|
3493
|
+
- **Content-Type**: application/json
|
|
4300
3494
|
- **Accept**: application/json
|
|
4301
3495
|
|
|
4302
3496
|
|
|
@@ -4306,7 +3500,7 @@ This endpoint does not need any parameter.
|
|
|
4306
3500
|
|
|
4307
3501
|
Update bank account
|
|
4308
3502
|
|
|
4309
|
-
This operation updates the information of an existing bank account.
|
|
3503
|
+
<Note>This operation has been deprecated.</Note> This operation updates the information of an existing bank account.
|
|
4310
3504
|
|
|
4311
3505
|
### Example
|
|
4312
3506
|
|
|
@@ -4408,60 +3602,6 @@ Name | Type | Description | Notes
|
|
|
4408
3602
|
- **Accept**: application/json
|
|
4409
3603
|
|
|
4410
3604
|
|
|
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
3605
|
## updateDestination
|
|
4466
3606
|
|
|
4467
3607
|
> Destination updateDestination(destination_id, opts)
|
|
@@ -4516,114 +3656,6 @@ Name | Type | Description | Notes
|
|
|
4516
3656
|
- **Accept**: application/json
|
|
4517
3657
|
|
|
4518
3658
|
|
|
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
3659
|
## updateDestinationEntry
|
|
4628
3660
|
|
|
4629
3661
|
> UpdateDestinationEntry200Response updateDestinationEntry(destination_entry_id, opts)
|