@cobo/cobo-waas2 1.34.0 → 1.36.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 +28 -4
- package/dist/ApiClient.js +1 -1
- package/dist/api/PaymentApi.js +126 -91
- package/dist/api/TravelRuleApi.js +293 -6
- package/dist/index.js +133 -7
- package/dist/model/AddressVerification.js +172 -0
- package/dist/model/AddressVerificationDetail.js +204 -0
- package/dist/model/AddressVerificationDetailSatoshiTestDetail.js +299 -0
- package/dist/model/AddressVerificationDetailSignatureDetail.js +172 -0
- package/dist/model/AddressVerificationMethod.js +61 -0
- package/dist/model/AddressVerificationStatus.js +66 -0
- package/dist/model/ApprovalUserDetail.js +9 -0
- package/dist/model/{UpdateBankAccountByIdRequest.js → CancelSatoshiTestChallengeRequest.js} +31 -28
- package/dist/model/ChainInfo.js +13 -0
- package/dist/model/CreateBulkSendRequest.js +13 -0
- package/dist/model/CreateSatoshiTestChallengeRequest.js +176 -0
- package/dist/model/GetTransactionLimitation200Response.js +10 -1
- package/dist/model/ListAddressVerifications200Response.js +147 -0
- package/dist/model/ListBulkSends200Response.js +123 -0
- package/dist/model/ListPayerTransactions200Response.js +123 -0
- package/dist/model/ListTopUpPayers200ResponseDataInner.js +14 -1
- package/dist/model/OrderLinkBusinessInfo.js +2 -2
- package/dist/model/OriginalMainGroupHandling.js +61 -0
- package/dist/model/PaymentBulkSend.js +13 -0
- package/dist/model/PaymentBulkSendEvent.js +18 -0
- package/dist/model/SatoshiTestCancelResult.js +144 -0
- package/dist/model/SatoshiTestChallenge.js +239 -0
- package/dist/model/SatoshiTestChallengeAction.js +61 -0
- package/dist/model/SatoshiTestChallengeStatus.js +81 -0
- package/dist/model/SignatureChallenge.js +137 -0
- package/dist/model/SignatureDetail.js +146 -0
- package/dist/model/TransactionCoboCategory.js +20 -0
- package/dist/model/TravelRuleTransactionType.js +61 -0
- package/dist/model/UpdateKeyShareHolderGroupByIdRequest.js +9 -0
- package/dist/model/WebhookEventData.js +1 -1
- package/dist/model/WebhookEventType.js +5 -0
- package/docs/AddressVerification.md +14 -0
- package/docs/AddressVerificationDetail.md +16 -0
- package/docs/AddressVerificationDetailSatoshiTestDetail.md +19 -0
- package/docs/AddressVerificationDetailSignatureDetail.md +12 -0
- package/docs/AddressVerificationMethod.md +12 -0
- package/docs/AddressVerificationStatus.md +14 -0
- package/docs/ApprovalUserDetail.md +1 -0
- package/docs/CancelSatoshiTestChallengeRequest.md +9 -0
- package/docs/ChainInfo.md +1 -0
- package/docs/CreateBulkSendRequest.md +1 -0
- package/docs/CreateSatoshiTestChallengeRequest.md +14 -0
- package/docs/GetTransactionLimitation200Response.md +2 -1
- package/docs/ListAddressVerifications200Response.md +10 -0
- package/docs/ListBulkSends200Response.md +10 -0
- package/docs/ListPayerTransactions200Response.md +10 -0
- package/docs/ListTopUpPayers200ResponseDataInner.md +2 -1
- package/docs/OrderLinkBusinessInfo.md +1 -1
- package/docs/OriginalMainGroupHandling.md +12 -0
- package/docs/PaymentApi.md +107 -83
- package/docs/PaymentBulkSend.md +1 -0
- package/docs/PaymentBulkSendEvent.md +1 -0
- package/docs/SatoshiTestCancelResult.md +21 -0
- package/docs/SatoshiTestChallenge.md +19 -0
- package/docs/SatoshiTestChallengeAction.md +12 -0
- package/docs/SatoshiTestChallengeStatus.md +20 -0
- package/docs/SignatureChallenge.md +11 -0
- package/docs/SignatureDetail.md +12 -0
- package/docs/TransactionCoboCategory.md +8 -0
- package/docs/TravelRuleApi.md +325 -1
- package/docs/TravelRuleTransactionType.md +12 -0
- package/docs/UpdateKeyShareHolderGroupByIdRequest.md +1 -0
- package/docs/WebhookEventData.md +1 -1
- package/docs/WebhookEventType.md +2 -0
- package/package.json +1 -1
- package/docs/UpdateBankAccountByIdRequest.md +0 -9
package/docs/PaymentApi.md
CHANGED
|
@@ -47,9 +47,9 @@ Method | HTTP request | Description
|
|
|
47
47
|
[**getSettlementInfoByIds**](PaymentApi.md#getSettlementInfoByIds) | **GET** /payments/settlement_info | Get withdrawable balances
|
|
48
48
|
[**getTopUpAddress**](PaymentApi.md#getTopUpAddress) | **GET** /payments/topup/address | Create/Get top-up address
|
|
49
49
|
[**listAllocationItems**](PaymentApi.md#listAllocationItems) | **GET** /payments/allocation_items | List all allocation items
|
|
50
|
-
[**listBankAccounts**](PaymentApi.md#listBankAccounts) | **GET** /payments/bank_accounts | List all bank accounts
|
|
51
50
|
[**listBatchAllocations**](PaymentApi.md#listBatchAllocations) | **GET** /payments/batch_allocations | List all batch allocations
|
|
52
51
|
[**listBulkSendItems**](PaymentApi.md#listBulkSendItems) | **GET** /payments/bulk_sends/{bulk_send_id}/items | List bulk send items
|
|
52
|
+
[**listBulkSends**](PaymentApi.md#listBulkSends) | **GET** /payments/bulk_sends | List bulk sends
|
|
53
53
|
[**listCounterparties**](PaymentApi.md#listCounterparties) | **GET** /payments/counterparty | List all counterparties
|
|
54
54
|
[**listCounterpartyEntries**](PaymentApi.md#listCounterpartyEntries) | **GET** /payments/counterparty_entry | List counterparty entries
|
|
55
55
|
[**listCryptoAddresses**](PaymentApi.md#listCryptoAddresses) | **GET** /payments/crypto_addresses | List crypto addresses
|
|
@@ -58,6 +58,7 @@ Method | HTTP request | Description
|
|
|
58
58
|
[**listForcedSweepRequests**](PaymentApi.md#listForcedSweepRequests) | **GET** /payments/force_sweep_requests | List forced sweeps
|
|
59
59
|
[**listMerchantBalances**](PaymentApi.md#listMerchantBalances) | **GET** /payments/balance/merchants | List merchant balances
|
|
60
60
|
[**listMerchants**](PaymentApi.md#listMerchants) | **GET** /payments/merchants | List all merchants
|
|
61
|
+
[**listPayerTransactions**](PaymentApi.md#listPayerTransactions) | **GET** /payments/topup/payers/transactions | List payer transactions
|
|
61
62
|
[**listPaymentOrders**](PaymentApi.md#listPaymentOrders) | **GET** /payments/orders | List all pay-in orders
|
|
62
63
|
[**listPaymentSupportedTokens**](PaymentApi.md#listPaymentSupportedTokens) | **GET** /payments/supported_tokens | List supported tokens
|
|
63
64
|
[**listPaymentWalletBalances**](PaymentApi.md#listPaymentWalletBalances) | **GET** /payments/balance/payment_wallets | List payment wallet balances
|
|
@@ -68,7 +69,6 @@ Method | HTTP request | Description
|
|
|
68
69
|
[**listTopUpPayers**](PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
|
|
69
70
|
[**paymentEstimateFee**](PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
|
|
70
71
|
[**triggerTestPaymentsWebhookEvent**](PaymentApi.md#triggerTestPaymentsWebhookEvent) | **POST** /payments/webhooks/trigger | Trigger test webhook event
|
|
71
|
-
[**updateBankAccountById**](PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
72
72
|
[**updateCounterparty**](PaymentApi.md#updateCounterparty) | **PUT** /payments/counterparty/{counterparty_id} | Update counterparty
|
|
73
73
|
[**updateDestination**](PaymentApi.md#updateDestination) | **PUT** /payments/destination/{destination_id} | Update destination
|
|
74
74
|
[**updateDestinationEntry**](PaymentApi.md#updateDestinationEntry) | **PUT** /payments/destination_entry/{destination_entry_id} | Update destination entry
|
|
@@ -2250,7 +2250,7 @@ apiInstance.getTopUpAddress(token_id, custom_payer_id, opts).then((data) => {
|
|
|
2250
2250
|
Name | Type | Description | Notes
|
|
2251
2251
|
------------- | ------------- | ------------- | -------------
|
|
2252
2252
|
**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` |
|
|
2253
|
-
**custom_payer_id** | **String**|
|
|
2253
|
+
**custom_payer_id** | **String**| Unique customer identifier on the merchant side, used to allocate a dedicated top-up address |
|
|
2254
2254
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
2255
2255
|
|
|
2256
2256
|
### Return type
|
|
@@ -2331,13 +2331,13 @@ Name | Type | Description | Notes
|
|
|
2331
2331
|
- **Accept**: application/json
|
|
2332
2332
|
|
|
2333
2333
|
|
|
2334
|
-
##
|
|
2334
|
+
## listBatchAllocations
|
|
2335
2335
|
|
|
2336
|
-
>
|
|
2336
|
+
> ListBatchAllocations200Response listBatchAllocations(opts)
|
|
2337
2337
|
|
|
2338
|
-
List all
|
|
2338
|
+
List all batch allocations
|
|
2339
2339
|
|
|
2340
|
-
|
|
2340
|
+
This operation retrieves the information of all batch allocations.
|
|
2341
2341
|
|
|
2342
2342
|
### Example
|
|
2343
2343
|
|
|
@@ -2351,7 +2351,13 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2351
2351
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2352
2352
|
// Call the API
|
|
2353
2353
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2354
|
-
|
|
2354
|
+
const opts = {
|
|
2355
|
+
'limit': 10,
|
|
2356
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2357
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2358
|
+
'request_id': "random_request_id"
|
|
2359
|
+
};
|
|
2360
|
+
apiInstance.listBatchAllocations(opts).then((data) => {
|
|
2355
2361
|
console.log('API called successfully. Returned data: ' + data);
|
|
2356
2362
|
}, (error) => {
|
|
2357
2363
|
console.error(error);
|
|
@@ -2361,11 +2367,17 @@ apiInstance.listBankAccounts().then((data) => {
|
|
|
2361
2367
|
|
|
2362
2368
|
### Parameters
|
|
2363
2369
|
|
|
2364
|
-
|
|
2370
|
+
|
|
2371
|
+
Name | Type | Description | Notes
|
|
2372
|
+
------------- | ------------- | ------------- | -------------
|
|
2373
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2374
|
+
**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]
|
|
2375
|
+
**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]
|
|
2376
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
2365
2377
|
|
|
2366
2378
|
### Return type
|
|
2367
2379
|
|
|
2368
|
-
[**
|
|
2380
|
+
[**ListBatchAllocations200Response**](ListBatchAllocations200Response.md)
|
|
2369
2381
|
|
|
2370
2382
|
### Authorization
|
|
2371
2383
|
|
|
@@ -2377,13 +2389,13 @@ This endpoint does not need any parameter.
|
|
|
2377
2389
|
- **Accept**: application/json
|
|
2378
2390
|
|
|
2379
2391
|
|
|
2380
|
-
##
|
|
2392
|
+
## listBulkSendItems
|
|
2381
2393
|
|
|
2382
|
-
>
|
|
2394
|
+
> ListBulkSendItems200Response listBulkSendItems(bulk_send_id, opts)
|
|
2383
2395
|
|
|
2384
|
-
List
|
|
2396
|
+
List bulk send items
|
|
2385
2397
|
|
|
2386
|
-
This operation retrieves the
|
|
2398
|
+
This operation retrieves the list of items for a specific bulk send.
|
|
2387
2399
|
|
|
2388
2400
|
### Example
|
|
2389
2401
|
|
|
@@ -2397,13 +2409,13 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2397
2409
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2398
2410
|
// Call the API
|
|
2399
2411
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2412
|
+
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
2400
2413
|
const opts = {
|
|
2401
2414
|
'limit': 10,
|
|
2402
2415
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2403
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
2404
|
-
'request_id': "random_request_id"
|
|
2416
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
2405
2417
|
};
|
|
2406
|
-
apiInstance.
|
|
2418
|
+
apiInstance.listBulkSendItems(bulk_send_id, opts).then((data) => {
|
|
2407
2419
|
console.log('API called successfully. Returned data: ' + data);
|
|
2408
2420
|
}, (error) => {
|
|
2409
2421
|
console.error(error);
|
|
@@ -2416,14 +2428,14 @@ apiInstance.listBatchAllocations(opts).then((data) => {
|
|
|
2416
2428
|
|
|
2417
2429
|
Name | Type | Description | Notes
|
|
2418
2430
|
------------- | ------------- | ------------- | -------------
|
|
2431
|
+
**bulk_send_id** | **String**| The bulk send ID. |
|
|
2419
2432
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2420
2433
|
**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]
|
|
2421
2434
|
**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]
|
|
2422
|
-
**request_id** | **String**| The request ID. | [optional]
|
|
2423
2435
|
|
|
2424
2436
|
### Return type
|
|
2425
2437
|
|
|
2426
|
-
[**
|
|
2438
|
+
[**ListBulkSendItems200Response**](ListBulkSendItems200Response.md)
|
|
2427
2439
|
|
|
2428
2440
|
### Authorization
|
|
2429
2441
|
|
|
@@ -2435,13 +2447,13 @@ Name | Type | Description | Notes
|
|
|
2435
2447
|
- **Accept**: application/json
|
|
2436
2448
|
|
|
2437
2449
|
|
|
2438
|
-
##
|
|
2450
|
+
## listBulkSends
|
|
2439
2451
|
|
|
2440
|
-
>
|
|
2452
|
+
> ListBulkSends200Response listBulkSends(opts)
|
|
2441
2453
|
|
|
2442
|
-
List bulk
|
|
2454
|
+
List bulk sends
|
|
2443
2455
|
|
|
2444
|
-
This operation retrieves the list of
|
|
2456
|
+
This operation retrieves the list of bulk sends.
|
|
2445
2457
|
|
|
2446
2458
|
### Example
|
|
2447
2459
|
|
|
@@ -2455,13 +2467,13 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
2455
2467
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
2456
2468
|
// Call the API
|
|
2457
2469
|
const apiInstance = new CoboWaas2.PaymentApi();
|
|
2458
|
-
const bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
|
|
2459
2470
|
const opts = {
|
|
2460
2471
|
'limit': 10,
|
|
2461
2472
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
2462
|
-
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
2473
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
2474
|
+
'request_id': "random_request_id"
|
|
2463
2475
|
};
|
|
2464
|
-
apiInstance.
|
|
2476
|
+
apiInstance.listBulkSends(opts).then((data) => {
|
|
2465
2477
|
console.log('API called successfully. Returned data: ' + data);
|
|
2466
2478
|
}, (error) => {
|
|
2467
2479
|
console.error(error);
|
|
@@ -2474,14 +2486,14 @@ apiInstance.listBulkSendItems(bulk_send_id, opts).then((data) => {
|
|
|
2474
2486
|
|
|
2475
2487
|
Name | Type | Description | Notes
|
|
2476
2488
|
------------- | ------------- | ------------- | -------------
|
|
2477
|
-
**bulk_send_id** | **String**| The bulk send ID. |
|
|
2478
2489
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
2479
2490
|
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
2480
2491
|
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
2492
|
+
**request_id** | **String**| The request ID. | [optional]
|
|
2481
2493
|
|
|
2482
2494
|
### Return type
|
|
2483
2495
|
|
|
2484
|
-
[**
|
|
2496
|
+
[**ListBulkSends200Response**](ListBulkSends200Response.md)
|
|
2485
2497
|
|
|
2486
2498
|
### Authorization
|
|
2487
2499
|
|
|
@@ -2979,6 +2991,72 @@ Name | Type | Description | Notes
|
|
|
2979
2991
|
- **Accept**: application/json
|
|
2980
2992
|
|
|
2981
2993
|
|
|
2994
|
+
## listPayerTransactions
|
|
2995
|
+
|
|
2996
|
+
> ListPayerTransactions200Response listPayerTransactions(custom_payer_id, opts)
|
|
2997
|
+
|
|
2998
|
+
List payer transactions
|
|
2999
|
+
|
|
3000
|
+
This operation retrieves on-chain transactions related to a specific top-up payer. You need to specify `custom_payer_id`, which is the merchant-defined customer identifier used when creating top-up addresses. <Note>This operation is applicable to the top-up scenario only.</Note> For more information, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview).
|
|
3001
|
+
|
|
3002
|
+
### Example
|
|
3003
|
+
|
|
3004
|
+
```javascript
|
|
3005
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3006
|
+
// Initialize the API client
|
|
3007
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
3008
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3009
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3010
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3011
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3012
|
+
// Call the API
|
|
3013
|
+
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3014
|
+
const custom_payer_id = "payer_0001";
|
|
3015
|
+
const opts = {
|
|
3016
|
+
'limit': 10,
|
|
3017
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
3018
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
|
|
3019
|
+
'merchant_id': "M1001",
|
|
3020
|
+
'token_id': "ETH_USDT",
|
|
3021
|
+
'transaction_hashes': "239861be9a4afe080c359b7fe4a1d035945ec46256b1a0f44d1267c71de8ec28",
|
|
3022
|
+
'transaction_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,557918d2-632a-4fe1-932f-315711f05fe3"
|
|
3023
|
+
};
|
|
3024
|
+
apiInstance.listPayerTransactions(custom_payer_id, opts).then((data) => {
|
|
3025
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
3026
|
+
}, (error) => {
|
|
3027
|
+
console.error(error);
|
|
3028
|
+
});
|
|
3029
|
+
|
|
3030
|
+
```
|
|
3031
|
+
|
|
3032
|
+
### Parameters
|
|
3033
|
+
|
|
3034
|
+
|
|
3035
|
+
Name | Type | Description | Notes
|
|
3036
|
+
------------- | ------------- | ------------- | -------------
|
|
3037
|
+
**custom_payer_id** | **String**| Unique customer identifier on the merchant side, used to allocate a dedicated top-up address |
|
|
3038
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
3039
|
+
**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]
|
|
3040
|
+
**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]
|
|
3041
|
+
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
3042
|
+
**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]
|
|
3043
|
+
**transaction_hashes** | **String**| A list of transaction hashes, separated by comma. | [optional]
|
|
3044
|
+
**transaction_ids** | **String**| A list of transaction IDs, separated by comma. | [optional]
|
|
3045
|
+
|
|
3046
|
+
### Return type
|
|
3047
|
+
|
|
3048
|
+
[**ListPayerTransactions200Response**](ListPayerTransactions200Response.md)
|
|
3049
|
+
|
|
3050
|
+
### Authorization
|
|
3051
|
+
|
|
3052
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3053
|
+
|
|
3054
|
+
### HTTP request headers
|
|
3055
|
+
|
|
3056
|
+
- **Content-Type**: Not defined
|
|
3057
|
+
- **Accept**: application/json
|
|
3058
|
+
|
|
3059
|
+
|
|
2982
3060
|
## listPaymentOrders
|
|
2983
3061
|
|
|
2984
3062
|
> ListPaymentOrders200Response listPaymentOrders(opts)
|
|
@@ -3383,7 +3461,7 @@ Name | Type | Description | Notes
|
|
|
3383
3461
|
|
|
3384
3462
|
List payers
|
|
3385
3463
|
|
|
3386
|
-
This operation retrieves the information of all payers
|
|
3464
|
+
This operation retrieves the information of all payers. You can filter the result by merchant ID and payer_id. <Note>The `transactions` field in the response returns up to the latest 200 transactions only. This field will be removed in a future version. To paginate through payer transactions, use [List payer transactions](https://www.cobo.com/payments/en/guides/overview).</Note>
|
|
3387
3465
|
|
|
3388
3466
|
### Example
|
|
3389
3467
|
|
|
@@ -3541,60 +3619,6 @@ Name | Type | Description | Notes
|
|
|
3541
3619
|
- **Accept**: application/json
|
|
3542
3620
|
|
|
3543
3621
|
|
|
3544
|
-
## updateBankAccountById
|
|
3545
|
-
|
|
3546
|
-
> BankAccount updateBankAccountById(bank_account_id, opts)
|
|
3547
|
-
|
|
3548
|
-
Update bank account
|
|
3549
|
-
|
|
3550
|
-
<Note>This operation has been deprecated.</Note> This operation updates the information of an existing bank account.
|
|
3551
|
-
|
|
3552
|
-
### Example
|
|
3553
|
-
|
|
3554
|
-
```javascript
|
|
3555
|
-
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
3556
|
-
// Initialize the API client
|
|
3557
|
-
const apiClient = CoboWaas2.ApiClient.instance
|
|
3558
|
-
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
3559
|
-
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
3560
|
-
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
3561
|
-
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
3562
|
-
// Call the API
|
|
3563
|
-
const apiInstance = new CoboWaas2.PaymentApi();
|
|
3564
|
-
const bank_account_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
3565
|
-
const opts = {
|
|
3566
|
-
'UpdateBankAccountByIdRequest': new CoboWaas2.UpdateBankAccountByIdRequest()
|
|
3567
|
-
};
|
|
3568
|
-
apiInstance.updateBankAccountById(bank_account_id, opts).then((data) => {
|
|
3569
|
-
console.log('API called successfully. Returned data: ' + data);
|
|
3570
|
-
}, (error) => {
|
|
3571
|
-
console.error(error);
|
|
3572
|
-
});
|
|
3573
|
-
|
|
3574
|
-
```
|
|
3575
|
-
|
|
3576
|
-
### Parameters
|
|
3577
|
-
|
|
3578
|
-
|
|
3579
|
-
Name | Type | Description | Notes
|
|
3580
|
-
------------- | ------------- | ------------- | -------------
|
|
3581
|
-
**bank_account_id** | **String**| The bank account ID. |
|
|
3582
|
-
**UpdateBankAccountByIdRequest** | [**UpdateBankAccountByIdRequest**](UpdateBankAccountByIdRequest.md)| The request body for updating an existing bank account. | [optional]
|
|
3583
|
-
|
|
3584
|
-
### Return type
|
|
3585
|
-
|
|
3586
|
-
[**BankAccount**](BankAccount.md)
|
|
3587
|
-
|
|
3588
|
-
### Authorization
|
|
3589
|
-
|
|
3590
|
-
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
3591
|
-
|
|
3592
|
-
### HTTP request headers
|
|
3593
|
-
|
|
3594
|
-
- **Content-Type**: application/json
|
|
3595
|
-
- **Accept**: application/json
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
3622
|
## updateCounterparty
|
|
3599
3623
|
|
|
3600
3624
|
> Counterparty updateCounterparty(counterparty_id, opts)
|
package/docs/PaymentBulkSend.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**bulk_send_id** | **String** | The bulk send ID. |
|
|
8
|
+
**request_id** | **String** | The request ID. | [optional]
|
|
8
9
|
**source_account** | **String** | The source account from which the bulk send will be made. - 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\"`. |
|
|
9
10
|
**description** | **String** | The description for the entire bulk send batch. | [optional]
|
|
10
11
|
**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | |
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
|
8
8
|
**bulk_send_id** | **String** | The bulk send ID. |
|
|
9
|
+
**request_id** | **String** | The request ID. | [optional]
|
|
9
10
|
**source_account** | **String** | The source account from which the bulk send will be made. - 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\"`. |
|
|
10
11
|
**description** | **String** | The description for the entire bulk send batch. | [optional]
|
|
11
12
|
**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# CoboWaas2.SatoshiTestCancelResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**challenge_id** | **String** | The challenge that was cancelled. |
|
|
8
|
+
**status** | **String** | Final status after cancellation. |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## Enum: StatusEnum
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
* `DELETED` (value: `"DELETED"`)
|
|
16
|
+
|
|
17
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CoboWaas2.SatoshiTestChallenge
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**challenge_id** | **String** | The unique identifier of the Satoshi Test challenge. |
|
|
8
|
+
**from_address** | **String** | The counterparty (self-custody) wallet address that must transfer the micro-deposit. |
|
|
9
|
+
**to_address** | **String** | The Cobo-generated verification address that will receive the micro-deposit. |
|
|
10
|
+
**amount** | **String** | The exact amount (in the token's smallest unit) that must be transferred. The amount is unique per challenge and is used together with `to_address` to identify a matching on-chain transfer. |
|
|
11
|
+
**token_id** | **String** | The ID of the token used for the micro-deposit (typically the chain's native asset). |
|
|
12
|
+
**chain_id** | **String** | The chain on which the micro-deposit is expected. |
|
|
13
|
+
**status** | [**SatoshiTestChallengeStatus**](SatoshiTestChallengeStatus.md) | |
|
|
14
|
+
**remaining_seconds** | **Number** | Remaining time (in seconds) before the challenge expires. `0` when the challenge is not yet submitted or has already completed/expired. |
|
|
15
|
+
**matched_txid** | **String** | The on-chain transaction hash of the matching transfer, once matched. | [optional]
|
|
16
|
+
**started_at** | **Number** | Timestamp (milliseconds) when the challenge was submitted and the countdown started. | [optional]
|
|
17
|
+
**expires_at** | **Number** | Timestamp (milliseconds) when the challenge will expire if not matched. | [optional]
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CoboWaas2.SatoshiTestChallengeStatus
|
|
2
|
+
|
|
3
|
+
## Enum
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
* `PREPARE` (value: `"PREPARE"`)
|
|
7
|
+
|
|
8
|
+
* `PENDING` (value: `"PENDING"`)
|
|
9
|
+
|
|
10
|
+
* `MATCHED` (value: `"MATCHED"`)
|
|
11
|
+
|
|
12
|
+
* `VERIFIED` (value: `"VERIFIED"`)
|
|
13
|
+
|
|
14
|
+
* `EXPIRED` (value: `"EXPIRED"`)
|
|
15
|
+
|
|
16
|
+
* `DELETED` (value: `"DELETED"`)
|
|
17
|
+
|
|
18
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.SignatureChallenge
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**address** | **String** | The self-custody wallet address that must sign this challenge. This is the counterparty address for the transaction: for deposits it is the sender's wallet, and for withdrawals it is the recipient's wallet. |
|
|
8
|
+
**challenge** | **String** | The human-readable, time-sensitive message to sign. Contains the wallet address, a unique nonce, and a timestamp. |
|
|
9
|
+
**expires_in** | **Number** | Number of seconds before the challenge expires. The signature must be submitted within this window. |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.SignatureDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**address** | **String** | The self-custody wallet address that signed the challenge. |
|
|
8
|
+
**challenge** | **String** | The challenge string that was signed. | [optional]
|
|
9
|
+
**signature** | **String** | The wallet signature submitted by the client. | [optional]
|
|
10
|
+
**verified_at** | **Number** | Timestamp (milliseconds) when the signature was verified. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -83,6 +83,14 @@
|
|
|
83
83
|
|
|
84
84
|
* `WalletConnect` (value: `"WalletConnect"`)
|
|
85
85
|
|
|
86
|
+
* `JustLendReceiverPrecharge` (value: `"JustLendReceiverPrecharge"`)
|
|
87
|
+
|
|
88
|
+
* `JustLendEnergyRental` (value: `"JustLendEnergyRental"`)
|
|
89
|
+
|
|
90
|
+
* `JustLendEnergyReturn` (value: `"JustLendEnergyReturn"`)
|
|
91
|
+
|
|
92
|
+
* `TrxRecharge` (value: `"TrxRecharge"`)
|
|
93
|
+
|
|
86
94
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
87
95
|
|
|
88
96
|
|