@cobo/cobo-waas2 1.24.0 → 1.25.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 +25 -2
- package/dist/ApiClient.js +1 -1
- package/dist/api/ComplianceApi.js +132 -2
- package/dist/api/DevelopersWebhooksApi.js +2 -2
- package/dist/api/PaymentApi.js +65 -22
- package/dist/api/TransactionsApi.js +2 -2
- package/dist/index.js +112 -0
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/BridgingFee.js +4 -4
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/CommissionFee.js +2 -2
- package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
- package/dist/model/ComplianceKytScreeningsUpdateEventData.js +305 -0
- package/dist/model/CreateMerchantRequest.js +2 -2
- package/dist/model/CreateOrderLinkRequest.js +129 -0
- package/dist/model/CreatePaymentOrderRequest.js +14 -1
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateSettlement.js +2 -28
- package/dist/model/CreateSettlementRequestRequest.js +3 -3
- package/dist/model/CustodialTransferDestination.js +1 -1
- package/dist/model/FundsStatusType.js +111 -0
- package/dist/model/KytScreeningsDecisionsType.js +71 -0
- package/dist/model/KytScreeningsEventData.js +155 -0
- package/dist/model/KytScreeningsReviewType.js +61 -0
- package/dist/model/KytScreeningsTransaction.js +144 -0
- package/dist/model/KytScreeningsTransactionType.js +61 -0
- package/dist/model/Link.js +125 -0
- package/dist/model/LinkDisplayInfo.js +100 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/Merchant.js +3 -3
- package/dist/model/Order.js +13 -0
- package/dist/model/OrderLinkBusinessInfo.js +261 -0
- package/dist/model/OrderLinkBusinessInfoCustomExchangeRatesInner.js +125 -0
- package/dist/model/OtcFee.js +3 -3
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentEstimateFee.js +4 -4
- package/dist/model/PaymentEstimateFee201Response.js +1 -0
- package/dist/model/PaymentEstimateFeeRequest.js +2 -1
- package/dist/model/PaymentEstimatedFee.js +4 -4
- package/dist/model/PaymentOrderEventData.js +26 -3
- package/dist/model/PaymentRefundEventData.js +8 -3
- package/dist/model/PaymentSettlementEvent.js +12 -7
- package/dist/model/PaymentTransactionEventData.js +8 -3
- package/dist/model/ReviewStatusType.js +91 -0
- package/dist/model/Settlement.js +2 -2
- package/dist/model/SubmitKytResponse.js +122 -0
- package/dist/model/SubmitKytScreeningsDecisionsBody.js +122 -0
- package/dist/model/SubmitKytScreeningsReviewBody.js +122 -0
- package/dist/model/SupportedToken.js +1 -1
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEventData.js +64 -12
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +10 -0
- package/docs/AddressesEventData.md +3 -1
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/BridgingFee.md +3 -3
- package/docs/ChainsEventData.md +3 -1
- package/docs/CommissionFee.md +1 -1
- package/docs/ComplianceApi.md +158 -1
- package/docs/ComplianceDispositionUpdateEventData.md +3 -1
- package/docs/ComplianceKytScreeningsUpdateEventData.md +57 -0
- package/docs/CreateMerchantRequest.md +2 -2
- package/docs/CreateOrderLinkRequest.md +10 -0
- package/docs/CreatePaymentOrderRequest.md +2 -1
- package/docs/CreateRefundRequest.md +2 -2
- package/docs/CreateSettlement.md +1 -3
- package/docs/CreateSettlementRequestRequest.md +3 -3
- package/docs/DevelopersWebhooksApi.md +1 -1
- package/docs/FundsStatusType.md +32 -0
- package/docs/KytScreeningsDecisionsType.md +16 -0
- package/docs/KytScreeningsEventData.md +13 -0
- package/docs/KytScreeningsReviewType.md +12 -0
- package/docs/KytScreeningsTransaction.md +12 -0
- package/docs/KytScreeningsTransactionType.md +12 -0
- package/docs/Link.md +10 -0
- package/docs/LinkDisplayInfo.md +10 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/Merchant.md +2 -2
- package/docs/Order.md +1 -0
- package/docs/OrderLinkBusinessInfo.md +19 -0
- package/docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md +10 -0
- package/docs/OtcFee.md +2 -2
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentApi.md +64 -11
- package/docs/PaymentEstimateFee.md +2 -2
- package/docs/PaymentEstimateFee201Response.md +1 -1
- package/docs/PaymentEstimateFeeRequest.md +1 -1
- package/docs/PaymentEstimatedFee.md +2 -2
- package/docs/PaymentOrderEventData.md +4 -1
- package/docs/PaymentRefundEventData.md +3 -1
- package/docs/PaymentSettlementEvent.md +5 -3
- package/docs/PaymentTransactionEventData.md +3 -1
- package/docs/ReviewStatusType.md +24 -0
- package/docs/Settlement.md +2 -2
- package/docs/SubmitKytResponse.md +10 -0
- package/docs/SubmitKytScreeningsDecisionsBody.md +10 -0
- package/docs/SubmitKytScreeningsReviewBody.md +10 -0
- package/docs/SupportedToken.md +1 -1
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokensEventData.md +3 -1
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +1 -1
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WebhookEventData.md +10 -4
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +4 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@ For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](http
|
|
|
15
15
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
16
16
|
|
|
17
17
|
- API version: v2
|
|
18
|
-
- Package version: 1.
|
|
18
|
+
- Package version: 1.25.0
|
|
19
19
|
- Generator version: 7.6.0
|
|
20
20
|
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
21
21
|
For more information, please visit [https://www.cobo.com/waas](https://www.cobo.com/waas)
|
|
@@ -83,8 +83,11 @@ Class | Method | HTTP request | Description
|
|
|
83
83
|
*CoboWaas2.AutoSweepApi* | [**listAutoSweepTask**](docs/AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List auto-sweep tasks
|
|
84
84
|
*CoboWaas2.AutoSweepApi* | [**listWalletSweepToAddresses**](docs/AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List sweep-to addresses
|
|
85
85
|
*CoboWaas2.ComplianceApi* | [**getDispositionStatus**](docs/ComplianceApi.md#getDispositionStatus) | **GET** /compliance/funds/disposition | Get disposition status
|
|
86
|
+
*CoboWaas2.ComplianceApi* | [**getKytScreeningStatus**](docs/ComplianceApi.md#getKytScreeningStatus) | **GET** /compliance/kyt/screenings/status | Get KYT screening status
|
|
86
87
|
*CoboWaas2.ComplianceApi* | [**isolateFunds**](docs/ComplianceApi.md#isolateFunds) | **POST** /compliance/funds/disposition/isolate | Isolate funds
|
|
87
88
|
*CoboWaas2.ComplianceApi* | [**refundFunds**](docs/ComplianceApi.md#refundFunds) | **POST** /compliance/funds/disposition/refund | Refund funds
|
|
89
|
+
*CoboWaas2.ComplianceApi* | [**submitKytManualReview**](docs/ComplianceApi.md#submitKytManualReview) | **POST** /compliance/kyt/screenings/manual_review | Submit KYT manual review result
|
|
90
|
+
*CoboWaas2.ComplianceApi* | [**submitKytScreeningDecisions**](docs/ComplianceApi.md#submitKytScreeningDecisions) | **POST** /compliance/kyt/screenings/decisions | Submit KYT screening decision
|
|
88
91
|
*CoboWaas2.ComplianceApi* | [**unfreezeFunds**](docs/ComplianceApi.md#unfreezeFunds) | **POST** /compliance/funds/disposition/unfreeze | Unfreeze frozen funds
|
|
89
92
|
*CoboWaas2.DevelopersApi* | [**getApiKeyInfo**](docs/DevelopersApi.md#getApiKeyInfo) | **GET** /developers/api_key_info | Get API key information
|
|
90
93
|
*CoboWaas2.DevelopersApi* | [**listCallbackMessages**](docs/DevelopersApi.md#listCallbackMessages) | **GET** /developers/callback_messages | List all callback messages
|
|
@@ -114,6 +117,7 @@ Class | Method | HTTP request | Description
|
|
|
114
117
|
*CoboWaas2.PaymentApi* | [**createCryptoAddress**](docs/PaymentApi.md#createCryptoAddress) | **POST** /payments/crypto_addresses | Create crypto address
|
|
115
118
|
*CoboWaas2.PaymentApi* | [**createForcedSweepRequest**](docs/PaymentApi.md#createForcedSweepRequest) | **POST** /payments/force_sweep_requests | Create forced sweep
|
|
116
119
|
*CoboWaas2.PaymentApi* | [**createMerchant**](docs/PaymentApi.md#createMerchant) | **POST** /payments/merchants | Create merchant
|
|
120
|
+
*CoboWaas2.PaymentApi* | [**createOrderLink**](docs/PaymentApi.md#createOrderLink) | **POST** /payments/links/orders | Create order link
|
|
117
121
|
*CoboWaas2.PaymentApi* | [**createPaymentOrder**](docs/PaymentApi.md#createPaymentOrder) | **POST** /payments/orders | Create pay-in order
|
|
118
122
|
*CoboWaas2.PaymentApi* | [**createRefund**](docs/PaymentApi.md#createRefund) | **POST** /payments/refunds | Create refund order
|
|
119
123
|
*CoboWaas2.PaymentApi* | [**createSettlementRequest**](docs/PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
|
|
@@ -139,7 +143,7 @@ Class | Method | HTTP request | Description
|
|
|
139
143
|
*CoboWaas2.PaymentApi* | [**listSettlementRequests**](docs/PaymentApi.md#listSettlementRequests) | **GET** /payments/settlement_requests | List all settlement requests
|
|
140
144
|
*CoboWaas2.PaymentApi* | [**listTopUpPayerAccounts**](docs/PaymentApi.md#listTopUpPayerAccounts) | **GET** /payments/topup/payer_accounts | List top-up payer accounts
|
|
141
145
|
*CoboWaas2.PaymentApi* | [**listTopUpPayers**](docs/PaymentApi.md#listTopUpPayers) | **GET** /payments/topup/payers | List payers
|
|
142
|
-
*CoboWaas2.PaymentApi* | [**paymentEstimateFee**](docs/PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee |
|
|
146
|
+
*CoboWaas2.PaymentApi* | [**paymentEstimateFee**](docs/PaymentApi.md#paymentEstimateFee) | **POST** /payments/estimate_fee | Estimate fees
|
|
143
147
|
*CoboWaas2.PaymentApi* | [**updateBankAccountById**](docs/PaymentApi.md#updateBankAccountById) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account
|
|
144
148
|
*CoboWaas2.PaymentApi* | [**updateMerchantById**](docs/PaymentApi.md#updateMerchantById) | **PUT** /payments/merchants/{merchant_id} | Update merchant
|
|
145
149
|
*CoboWaas2.PaymentApi* | [**updatePaymentOrder**](docs/PaymentApi.md#updatePaymentOrder) | **PUT** /payments/orders/{order_id} | Update pay-in order
|
|
@@ -355,6 +359,7 @@ Class | Method | HTTP request | Description
|
|
|
355
359
|
- [CoboWaas2.CoboSafeDelegateType](docs/CoboSafeDelegateType.md)
|
|
356
360
|
- [CoboWaas2.CommissionFee](docs/CommissionFee.md)
|
|
357
361
|
- [CoboWaas2.ComplianceDispositionUpdateEventData](docs/ComplianceDispositionUpdateEventData.md)
|
|
362
|
+
- [CoboWaas2.ComplianceKytScreeningsUpdateEventData](docs/ComplianceKytScreeningsUpdateEventData.md)
|
|
358
363
|
- [CoboWaas2.ContractCallDestination](docs/ContractCallDestination.md)
|
|
359
364
|
- [CoboWaas2.ContractCallDestinationType](docs/ContractCallDestinationType.md)
|
|
360
365
|
- [CoboWaas2.ContractCallParams](docs/ContractCallParams.md)
|
|
@@ -387,6 +392,7 @@ Class | Method | HTTP request | Description
|
|
|
387
392
|
- [CoboWaas2.CreateMpcProjectRequest](docs/CreateMpcProjectRequest.md)
|
|
388
393
|
- [CoboWaas2.CreateMpcVaultRequest](docs/CreateMpcVaultRequest.md)
|
|
389
394
|
- [CoboWaas2.CreateMpcWalletParams](docs/CreateMpcWalletParams.md)
|
|
395
|
+
- [CoboWaas2.CreateOrderLinkRequest](docs/CreateOrderLinkRequest.md)
|
|
390
396
|
- [CoboWaas2.CreatePaymentOrderRequest](docs/CreatePaymentOrderRequest.md)
|
|
391
397
|
- [CoboWaas2.CreatePrimeBrokerAddress201Response](docs/CreatePrimeBrokerAddress201Response.md)
|
|
392
398
|
- [CoboWaas2.CreatePrimeBrokerAddressRequest](docs/CreatePrimeBrokerAddressRequest.md)
|
|
@@ -493,6 +499,7 @@ Class | Method | HTTP request | Description
|
|
|
493
499
|
- [CoboWaas2.ForcedSweep](docs/ForcedSweep.md)
|
|
494
500
|
- [CoboWaas2.ForcedSweepRequest](docs/ForcedSweepRequest.md)
|
|
495
501
|
- [CoboWaas2.ForcedSweepStatus](docs/ForcedSweepStatus.md)
|
|
502
|
+
- [CoboWaas2.FundsStatusType](docs/FundsStatusType.md)
|
|
496
503
|
- [CoboWaas2.GetApiKeyInfo200Response](docs/GetApiKeyInfo200Response.md)
|
|
497
504
|
- [CoboWaas2.GetExchangeRate200Response](docs/GetExchangeRate200Response.md)
|
|
498
505
|
- [CoboWaas2.GetMaxTransferableValueWithFeeModelRequest](docs/GetMaxTransferableValueWithFeeModelRequest.md)
|
|
@@ -516,6 +523,13 @@ Class | Method | HTTP request | Description
|
|
|
516
523
|
- [CoboWaas2.KeyShareHolderGroupType](docs/KeyShareHolderGroupType.md)
|
|
517
524
|
- [CoboWaas2.KeyShareHolderStatus](docs/KeyShareHolderStatus.md)
|
|
518
525
|
- [CoboWaas2.KeyShareHolderType](docs/KeyShareHolderType.md)
|
|
526
|
+
- [CoboWaas2.KytScreeningsDecisionsType](docs/KytScreeningsDecisionsType.md)
|
|
527
|
+
- [CoboWaas2.KytScreeningsEventData](docs/KytScreeningsEventData.md)
|
|
528
|
+
- [CoboWaas2.KytScreeningsReviewType](docs/KytScreeningsReviewType.md)
|
|
529
|
+
- [CoboWaas2.KytScreeningsTransaction](docs/KytScreeningsTransaction.md)
|
|
530
|
+
- [CoboWaas2.KytScreeningsTransactionType](docs/KytScreeningsTransactionType.md)
|
|
531
|
+
- [CoboWaas2.Link](docs/Link.md)
|
|
532
|
+
- [CoboWaas2.LinkDisplayInfo](docs/LinkDisplayInfo.md)
|
|
519
533
|
- [CoboWaas2.ListAddressBalancesByToken200Response](docs/ListAddressBalancesByToken200Response.md)
|
|
520
534
|
- [CoboWaas2.ListAddressBooks200Response](docs/ListAddressBooks200Response.md)
|
|
521
535
|
- [CoboWaas2.ListAddresses200Response](docs/ListAddresses200Response.md)
|
|
@@ -591,6 +605,8 @@ Class | Method | HTTP request | Description
|
|
|
591
605
|
- [CoboWaas2.MpcStakeSource](docs/MpcStakeSource.md)
|
|
592
606
|
- [CoboWaas2.MpcTransferSource](docs/MpcTransferSource.md)
|
|
593
607
|
- [CoboWaas2.Order](docs/Order.md)
|
|
608
|
+
- [CoboWaas2.OrderLinkBusinessInfo](docs/OrderLinkBusinessInfo.md)
|
|
609
|
+
- [CoboWaas2.OrderLinkBusinessInfoCustomExchangeRatesInner](docs/OrderLinkBusinessInfoCustomExchangeRatesInner.md)
|
|
594
610
|
- [CoboWaas2.OrderStatus](docs/OrderStatus.md)
|
|
595
611
|
- [CoboWaas2.OrgInfo](docs/OrgInfo.md)
|
|
596
612
|
- [CoboWaas2.OtcFee](docs/OtcFee.md)
|
|
@@ -636,6 +652,7 @@ Class | Method | HTTP request | Description
|
|
|
636
652
|
- [CoboWaas2.RequestApproval](docs/RequestApproval.md)
|
|
637
653
|
- [CoboWaas2.RetryCallbackMessage201Response](docs/RetryCallbackMessage201Response.md)
|
|
638
654
|
- [CoboWaas2.RetryWebhookEventById201Response](docs/RetryWebhookEventById201Response.md)
|
|
655
|
+
- [CoboWaas2.ReviewStatusType](docs/ReviewStatusType.md)
|
|
639
656
|
- [CoboWaas2.RevokeApprovalRequest201Response](docs/RevokeApprovalRequest201Response.md)
|
|
640
657
|
- [CoboWaas2.RevokeApprovalRequestRequest](docs/RevokeApprovalRequestRequest.md)
|
|
641
658
|
- [CoboWaas2.RoleDetail](docs/RoleDetail.md)
|
|
@@ -684,6 +701,9 @@ Class | Method | HTTP request | Description
|
|
|
684
701
|
- [CoboWaas2.StellarContractCallTrustLineParam](docs/StellarContractCallTrustLineParam.md)
|
|
685
702
|
- [CoboWaas2.SubWalletAssetBalance](docs/SubWalletAssetBalance.md)
|
|
686
703
|
- [CoboWaas2.SubmitDepositTravelRuleInfo201Response](docs/SubmitDepositTravelRuleInfo201Response.md)
|
|
704
|
+
- [CoboWaas2.SubmitKytResponse](docs/SubmitKytResponse.md)
|
|
705
|
+
- [CoboWaas2.SubmitKytScreeningsDecisionsBody](docs/SubmitKytScreeningsDecisionsBody.md)
|
|
706
|
+
- [CoboWaas2.SubmitKytScreeningsReviewBody](docs/SubmitKytScreeningsReviewBody.md)
|
|
687
707
|
- [CoboWaas2.SupportedToken](docs/SupportedToken.md)
|
|
688
708
|
- [CoboWaas2.SuspendedTokenEventData](docs/SuspendedTokenEventData.md)
|
|
689
709
|
- [CoboWaas2.SuspendedTokenOperationType](docs/SuspendedTokenOperationType.md)
|
|
@@ -1047,4 +1067,7 @@ Authentication schemes defined for the API:
|
|
|
1047
1067
|
- compliance_funds.isolate: Isolate compliance funds request
|
|
1048
1068
|
- compliance_funds.unfreeze: Unfreeze compliance funds request
|
|
1049
1069
|
- compliance_funds.read: Read compliance funds request information
|
|
1070
|
+
- compliance_kyt_review.update: Update KYT review status
|
|
1071
|
+
- compliance_kyt_decisions.update: Update KYT decision status
|
|
1072
|
+
- compliance_kyt_status.read: Read KYT screening status
|
|
1050
1073
|
|
package/dist/ApiClient.js
CHANGED
|
@@ -9,7 +9,11 @@ var _DispositionQueryResponse = _interopRequireDefault(require("../model/Disposi
|
|
|
9
9
|
var _DispositionResponse = _interopRequireDefault(require("../model/DispositionResponse"));
|
|
10
10
|
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
11
11
|
var _IsolateDisposition = _interopRequireDefault(require("../model/IsolateDisposition"));
|
|
12
|
+
var _KytScreeningsTransaction = _interopRequireDefault(require("../model/KytScreeningsTransaction"));
|
|
12
13
|
var _RefundDisposition = _interopRequireDefault(require("../model/RefundDisposition"));
|
|
14
|
+
var _SubmitKytResponse = _interopRequireDefault(require("../model/SubmitKytResponse"));
|
|
15
|
+
var _SubmitKytScreeningsDecisionsBody = _interopRequireDefault(require("../model/SubmitKytScreeningsDecisionsBody"));
|
|
16
|
+
var _SubmitKytScreeningsReviewBody = _interopRequireDefault(require("../model/SubmitKytScreeningsReviewBody"));
|
|
13
17
|
var _UnfreezeDisposition = _interopRequireDefault(require("../model/UnfreezeDisposition"));
|
|
14
18
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
15
19
|
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
@@ -47,7 +51,7 @@ var ComplianceApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
51
|
/**
|
|
48
52
|
* Get disposition status
|
|
49
53
|
* This operation retrieves the current status of a disposition request for a specific transaction. You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze) that has been initiated for a transaction. The response includes the disposition type, current status, and the disposition transaction ID if applicable. <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note>
|
|
50
|
-
* @param {String} transaction_id The UUID of the transaction to
|
|
54
|
+
* @param {String} transaction_id The unique identifier (UUID) of the transaction to retrieve KYT screening status information for.
|
|
51
55
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionQueryResponse} and HTTP response
|
|
52
56
|
*/
|
|
53
57
|
return _createClass(ComplianceApi, [{
|
|
@@ -77,7 +81,7 @@ var ComplianceApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
77
81
|
/**
|
|
78
82
|
* Get disposition status
|
|
79
83
|
* This operation retrieves the current status of a disposition request for a specific transaction. You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze) that has been initiated for a transaction. The response includes the disposition type, current status, and the disposition transaction ID if applicable. <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note>
|
|
80
|
-
* @param {String} transaction_id The UUID of the transaction to
|
|
84
|
+
* @param {String} transaction_id The unique identifier (UUID) of the transaction to retrieve KYT screening status information for.
|
|
81
85
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionQueryResponse}
|
|
82
86
|
*/
|
|
83
87
|
}, {
|
|
@@ -88,6 +92,50 @@ var ComplianceApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
88
92
|
});
|
|
89
93
|
}
|
|
90
94
|
|
|
95
|
+
/**
|
|
96
|
+
* Get KYT screening status
|
|
97
|
+
* This operation retrieves the current KYT (Know Your Transaction) screening status, including review status and fund disposition status, for a specific transaction. Use this endpoint to monitor the real-time screening progress for transactions processed through the KYT compliance system. <Note>This endpoint provides comprehensive compliance monitoring capabilities to help maintain AML (Anti-Money Laundering) regulatory compliance and audit trail requirements.</Note>
|
|
98
|
+
* @param {String} transaction_id The unique identifier (UUID) of the transaction to retrieve KYT screening status information for.
|
|
99
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/KytScreeningsTransaction} and HTTP response
|
|
100
|
+
*/
|
|
101
|
+
}, {
|
|
102
|
+
key: "getKytScreeningStatusWithHttpInfo",
|
|
103
|
+
value: function getKytScreeningStatusWithHttpInfo(transaction_id) {
|
|
104
|
+
var postBody = null;
|
|
105
|
+
if (postBody && postBody.toJSON) {
|
|
106
|
+
postBody = postBody.toJSON();
|
|
107
|
+
}
|
|
108
|
+
// verify the required parameter 'transaction_id' is set
|
|
109
|
+
if (transaction_id === undefined || transaction_id === null) {
|
|
110
|
+
throw new Error("Missing the required parameter 'transaction_id' when calling getKytScreeningStatus");
|
|
111
|
+
}
|
|
112
|
+
var pathParams = {};
|
|
113
|
+
var queryParams = {
|
|
114
|
+
'transaction_id': transaction_id
|
|
115
|
+
};
|
|
116
|
+
var headerParams = {};
|
|
117
|
+
var formParams = {};
|
|
118
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
119
|
+
var contentTypes = [];
|
|
120
|
+
var accepts = ['application/json'];
|
|
121
|
+
var returnType = _KytScreeningsTransaction["default"];
|
|
122
|
+
return this.apiClient.callApi('/compliance/kyt/screenings/status', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Get KYT screening status
|
|
127
|
+
* This operation retrieves the current KYT (Know Your Transaction) screening status, including review status and fund disposition status, for a specific transaction. Use this endpoint to monitor the real-time screening progress for transactions processed through the KYT compliance system. <Note>This endpoint provides comprehensive compliance monitoring capabilities to help maintain AML (Anti-Money Laundering) regulatory compliance and audit trail requirements.</Note>
|
|
128
|
+
* @param {String} transaction_id The unique identifier (UUID) of the transaction to retrieve KYT screening status information for.
|
|
129
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/KytScreeningsTransaction}
|
|
130
|
+
*/
|
|
131
|
+
}, {
|
|
132
|
+
key: "getKytScreeningStatus",
|
|
133
|
+
value: function getKytScreeningStatus(transaction_id) {
|
|
134
|
+
return this.getKytScreeningStatusWithHttpInfo(transaction_id).then(function (response_and_data) {
|
|
135
|
+
return response_and_data.data;
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
|
|
91
139
|
/**
|
|
92
140
|
* Isolate funds
|
|
93
141
|
* This operation creates a request to isolate funds for a specific transaction. The funds will be sent to a designated isolation address for compliance purposes. You need to specify the transaction ID to be isolated and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The isolation will initiate a withdrawal transaction from the compliance-managed address to the specified isolation address.</Note>
|
|
@@ -170,6 +218,88 @@ var ComplianceApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
170
218
|
});
|
|
171
219
|
}
|
|
172
220
|
|
|
221
|
+
/**
|
|
222
|
+
* Submit KYT manual review result
|
|
223
|
+
* This operation submits a manual review result for a KYT (Know Your Transaction) screening case that requires human analysis. Use this endpoint when transactions flagged for manual review have been analyzed by compliance officers and require submission of review outcomes with detailed comments and justifications. This endpoint is specifically designed for submitting comprehensive manual review findings rather than automated screening decisions. <Note>Submitting a manual review result will update the KYT screening status and initiate appropriate compliance workflow actions based on the review outcome.</Note>
|
|
224
|
+
* @param {Object} opts Optional parameters
|
|
225
|
+
* @param {module:model/SubmitKytScreeningsReviewBody} [SubmitKytScreeningsReviewBody] The request body to submit a manual review result for KYT screening case that requires human analysis.
|
|
226
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubmitKytResponse} and HTTP response
|
|
227
|
+
*/
|
|
228
|
+
}, {
|
|
229
|
+
key: "submitKytManualReviewWithHttpInfo",
|
|
230
|
+
value: function submitKytManualReviewWithHttpInfo(opts) {
|
|
231
|
+
opts = opts || {};
|
|
232
|
+
var postBody = opts['SubmitKytScreeningsReviewBody'];
|
|
233
|
+
if (postBody && postBody.toJSON) {
|
|
234
|
+
postBody = postBody.toJSON();
|
|
235
|
+
}
|
|
236
|
+
var pathParams = {};
|
|
237
|
+
var queryParams = {};
|
|
238
|
+
var headerParams = {};
|
|
239
|
+
var formParams = {};
|
|
240
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
241
|
+
var contentTypes = ['application/json'];
|
|
242
|
+
var accepts = ['application/json'];
|
|
243
|
+
var returnType = _SubmitKytResponse["default"];
|
|
244
|
+
return this.apiClient.callApi('/compliance/kyt/screenings/manual_review', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Submit KYT manual review result
|
|
249
|
+
* This operation submits a manual review result for a KYT (Know Your Transaction) screening case that requires human analysis. Use this endpoint when transactions flagged for manual review have been analyzed by compliance officers and require submission of review outcomes with detailed comments and justifications. This endpoint is specifically designed for submitting comprehensive manual review findings rather than automated screening decisions. <Note>Submitting a manual review result will update the KYT screening status and initiate appropriate compliance workflow actions based on the review outcome.</Note>
|
|
250
|
+
* @param {Object} opts Optional parameters
|
|
251
|
+
* @param {module:model/SubmitKytScreeningsReviewBody} opts.SubmitKytScreeningsReviewBody The request body to submit a manual review result for KYT screening case that requires human analysis.
|
|
252
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubmitKytResponse}
|
|
253
|
+
*/
|
|
254
|
+
}, {
|
|
255
|
+
key: "submitKytManualReview",
|
|
256
|
+
value: function submitKytManualReview(opts) {
|
|
257
|
+
return this.submitKytManualReviewWithHttpInfo(opts).then(function (response_and_data) {
|
|
258
|
+
return response_and_data.data;
|
|
259
|
+
});
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* Submit KYT screening decision
|
|
264
|
+
* This operation submits a KYT (Know Your Transaction) screening decision for a specific transaction based on an external compliance review. Use this endpoint to provide a screening decision (Approval, ApprovalWithAlert, Rejection, or ManualReview) after completing the external KYT screening process. The submitted decision will be recorded for compliance audit purposes and regulatory reporting requirements. <Note>Submitting a screening decision will update the transaction's KYT status and may automatically trigger downstream compliance workflows or notifications depending on the decision type.</Note>
|
|
265
|
+
* @param {Object} opts Optional parameters
|
|
266
|
+
* @param {module:model/SubmitKytScreeningsDecisionsBody} [SubmitKytScreeningsDecisionsBody] The request body to submit a KYT screening decision for a specific transaction based on external compliance review.
|
|
267
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubmitKytResponse} and HTTP response
|
|
268
|
+
*/
|
|
269
|
+
}, {
|
|
270
|
+
key: "submitKytScreeningDecisionsWithHttpInfo",
|
|
271
|
+
value: function submitKytScreeningDecisionsWithHttpInfo(opts) {
|
|
272
|
+
opts = opts || {};
|
|
273
|
+
var postBody = opts['SubmitKytScreeningsDecisionsBody'];
|
|
274
|
+
if (postBody && postBody.toJSON) {
|
|
275
|
+
postBody = postBody.toJSON();
|
|
276
|
+
}
|
|
277
|
+
var pathParams = {};
|
|
278
|
+
var queryParams = {};
|
|
279
|
+
var headerParams = {};
|
|
280
|
+
var formParams = {};
|
|
281
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
282
|
+
var contentTypes = ['application/json'];
|
|
283
|
+
var accepts = ['application/json'];
|
|
284
|
+
var returnType = _SubmitKytResponse["default"];
|
|
285
|
+
return this.apiClient.callApi('/compliance/kyt/screenings/decisions', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Submit KYT screening decision
|
|
290
|
+
* This operation submits a KYT (Know Your Transaction) screening decision for a specific transaction based on an external compliance review. Use this endpoint to provide a screening decision (Approval, ApprovalWithAlert, Rejection, or ManualReview) after completing the external KYT screening process. The submitted decision will be recorded for compliance audit purposes and regulatory reporting requirements. <Note>Submitting a screening decision will update the transaction's KYT status and may automatically trigger downstream compliance workflows or notifications depending on the decision type.</Note>
|
|
291
|
+
* @param {Object} opts Optional parameters
|
|
292
|
+
* @param {module:model/SubmitKytScreeningsDecisionsBody} opts.SubmitKytScreeningsDecisionsBody The request body to submit a KYT screening decision for a specific transaction based on external compliance review.
|
|
293
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubmitKytResponse}
|
|
294
|
+
*/
|
|
295
|
+
}, {
|
|
296
|
+
key: "submitKytScreeningDecisions",
|
|
297
|
+
value: function submitKytScreeningDecisions(opts) {
|
|
298
|
+
return this.submitKytScreeningDecisionsWithHttpInfo(opts).then(function (response_and_data) {
|
|
299
|
+
return response_and_data.data;
|
|
300
|
+
});
|
|
301
|
+
}
|
|
302
|
+
|
|
173
303
|
/**
|
|
174
304
|
* Unfreeze frozen funds
|
|
175
305
|
* This operation creates a request to unfreeze funds for a previously frozen transaction. It releases the frozen funds back to their original state. You only need to specify the transaction ID to be unfrozen. Once unfrozen, the funds will be available for normal operations. <Note>The unfreeze process will release the compliance hold on the transaction, allowing it to proceed normally.</Note>
|
|
@@ -460,7 +460,7 @@ var DevelopersWebhooksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
460
460
|
|
|
461
461
|
/**
|
|
462
462
|
* Trigger test event
|
|
463
|
-
* This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide 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.
|
|
463
|
+
* This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide 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. <Note>Currently, you can only trigger test webhook events with the event data types `Transaction` and `TSSRequest`.</Note>
|
|
464
464
|
* @param {Object} opts Optional parameters
|
|
465
465
|
* @param {module:model/TriggerTestWebhookEventRequest} [TriggerTestWebhookEventRequest] The request body used to trigger a test webhook event.
|
|
466
466
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TriggerTestWebhookEvent201Response} and HTTP response
|
|
@@ -486,7 +486,7 @@ var DevelopersWebhooksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
488
|
* Trigger test event
|
|
489
|
-
* This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide 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.
|
|
489
|
+
* This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide 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. <Note>Currently, you can only trigger test webhook events with the event data types `Transaction` and `TSSRequest`.</Note>
|
|
490
490
|
* @param {Object} opts Optional parameters
|
|
491
491
|
* @param {module:model/TriggerTestWebhookEventRequest} opts.TriggerTestWebhookEventRequest The request body used to trigger a test webhook event.
|
|
492
492
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TriggerTestWebhookEvent201Response}
|
package/dist/api/PaymentApi.js
CHANGED
|
@@ -9,6 +9,7 @@ var _AcquiringType = _interopRequireDefault(require("../model/AcquiringType"));
|
|
|
9
9
|
var _BankAccount = _interopRequireDefault(require("../model/BankAccount"));
|
|
10
10
|
var _CreateCryptoAddressRequest = _interopRequireDefault(require("../model/CreateCryptoAddressRequest"));
|
|
11
11
|
var _CreateMerchantRequest = _interopRequireDefault(require("../model/CreateMerchantRequest"));
|
|
12
|
+
var _CreateOrderLinkRequest = _interopRequireDefault(require("../model/CreateOrderLinkRequest"));
|
|
12
13
|
var _CreatePaymentOrderRequest = _interopRequireDefault(require("../model/CreatePaymentOrderRequest"));
|
|
13
14
|
var _CreateRefundRequest = _interopRequireDefault(require("../model/CreateRefundRequest"));
|
|
14
15
|
var _CreateSettlementRequestRequest = _interopRequireDefault(require("../model/CreateSettlementRequestRequest"));
|
|
@@ -20,6 +21,7 @@ var _ForcedSweepRequest = _interopRequireDefault(require("../model/ForcedSweepRe
|
|
|
20
21
|
var _GetExchangeRate200Response = _interopRequireDefault(require("../model/GetExchangeRate200Response"));
|
|
21
22
|
var _GetRefunds200Response = _interopRequireDefault(require("../model/GetRefunds200Response"));
|
|
22
23
|
var _GetSettlementInfoByIds200Response = _interopRequireDefault(require("../model/GetSettlementInfoByIds200Response"));
|
|
24
|
+
var _Link = _interopRequireDefault(require("../model/Link"));
|
|
23
25
|
var _ListForcedSweepRequests200Response = _interopRequireDefault(require("../model/ListForcedSweepRequests200Response"));
|
|
24
26
|
var _ListMerchantBalances200Response = _interopRequireDefault(require("../model/ListMerchantBalances200Response"));
|
|
25
27
|
var _ListMerchants200Response = _interopRequireDefault(require("../model/ListMerchants200Response"));
|
|
@@ -206,7 +208,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
206
208
|
|
|
207
209
|
/**
|
|
208
210
|
* Create merchant
|
|
209
|
-
* This operation creates a merchant
|
|
211
|
+
* This operation creates a merchant. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. For more information on merchant creation, please refer to [Preparation](https://www.cobo.com/developers/v2/payments/preparation#create-merchant).
|
|
210
212
|
* @param {Object} opts Optional parameters
|
|
211
213
|
* @param {module:model/CreateMerchantRequest} [CreateMerchantRequest] The request body to create a merchant.
|
|
212
214
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Merchant} and HTTP response
|
|
@@ -232,7 +234,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
232
234
|
|
|
233
235
|
/**
|
|
234
236
|
* Create merchant
|
|
235
|
-
* This operation creates a merchant
|
|
237
|
+
* This operation creates a merchant. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. For more information on merchant creation, please refer to [Preparation](https://www.cobo.com/developers/v2/payments/preparation#create-merchant).
|
|
236
238
|
* @param {Object} opts Optional parameters
|
|
237
239
|
* @param {module:model/CreateMerchantRequest} opts.CreateMerchantRequest The request body to create a merchant.
|
|
238
240
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Merchant}
|
|
@@ -245,6 +247,47 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
245
247
|
});
|
|
246
248
|
}
|
|
247
249
|
|
|
250
|
+
/**
|
|
251
|
+
* Create order link
|
|
252
|
+
* This operation creates a payment link of a pay-in order.
|
|
253
|
+
* @param {Object} opts Optional parameters
|
|
254
|
+
* @param {module:model/CreateOrderLinkRequest} [CreateOrderLinkRequest] The request body to create a payment link of a pay-in order.
|
|
255
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Link} and HTTP response
|
|
256
|
+
*/
|
|
257
|
+
}, {
|
|
258
|
+
key: "createOrderLinkWithHttpInfo",
|
|
259
|
+
value: function createOrderLinkWithHttpInfo(opts) {
|
|
260
|
+
opts = opts || {};
|
|
261
|
+
var postBody = opts['CreateOrderLinkRequest'];
|
|
262
|
+
if (postBody && postBody.toJSON) {
|
|
263
|
+
postBody = postBody.toJSON();
|
|
264
|
+
}
|
|
265
|
+
var pathParams = {};
|
|
266
|
+
var queryParams = {};
|
|
267
|
+
var headerParams = {};
|
|
268
|
+
var formParams = {};
|
|
269
|
+
var authNames = ['CoboAuth'];
|
|
270
|
+
var contentTypes = ['application/json'];
|
|
271
|
+
var accepts = ['application/json'];
|
|
272
|
+
var returnType = _Link["default"];
|
|
273
|
+
return this.apiClient.callApi('/payments/links/orders', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* Create order link
|
|
278
|
+
* This operation creates a payment link of a pay-in order.
|
|
279
|
+
* @param {Object} opts Optional parameters
|
|
280
|
+
* @param {module:model/CreateOrderLinkRequest} opts.CreateOrderLinkRequest The request body to create a payment link of a pay-in order.
|
|
281
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Link}
|
|
282
|
+
*/
|
|
283
|
+
}, {
|
|
284
|
+
key: "createOrderLink",
|
|
285
|
+
value: function createOrderLink(opts) {
|
|
286
|
+
return this.createOrderLinkWithHttpInfo(opts).then(function (response_and_data) {
|
|
287
|
+
return response_and_data.data;
|
|
288
|
+
});
|
|
289
|
+
}
|
|
290
|
+
|
|
248
291
|
/**
|
|
249
292
|
* Create pay-in order
|
|
250
293
|
* This operation creates a pay-in order.
|
|
@@ -370,7 +413,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
370
413
|
|
|
371
414
|
/**
|
|
372
415
|
* Delete crypto address
|
|
373
|
-
* This operation unregisters a crypto address from being used for crypto
|
|
416
|
+
* This operation unregisters a crypto address from being used for crypto payouts.
|
|
374
417
|
* @param {String} crypto_address_id The crypto address ID.
|
|
375
418
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteCryptoAddress201Response} and HTTP response
|
|
376
419
|
*/
|
|
@@ -400,7 +443,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
400
443
|
|
|
401
444
|
/**
|
|
402
445
|
* Delete crypto address
|
|
403
|
-
* This operation unregisters a crypto address from being used for crypto
|
|
446
|
+
* This operation unregisters a crypto address from being used for crypto payouts.
|
|
404
447
|
* @param {String} crypto_address_id The crypto address ID.
|
|
405
448
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteCryptoAddress201Response}
|
|
406
449
|
*/
|
|
@@ -414,7 +457,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
414
457
|
|
|
415
458
|
/**
|
|
416
459
|
* Get exchange rate
|
|
417
|
-
* This operation retrieves the current exchange rate between a specified currency pair.
|
|
460
|
+
* This operation retrieves the current exchange rate between a specified currency pair. The exchange rate is updated approximately every 10 minutes. <Note>This operation returns the exchange rate for reference only. The actual exchange rate may vary due to market fluctuations and other factors.</Note>
|
|
418
461
|
* @param {String} token_id 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`
|
|
419
462
|
* @param {String} currency The fiat currency. Currently, only `USD` is supported.
|
|
420
463
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetExchangeRate200Response} and HTTP response
|
|
@@ -450,7 +493,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
450
493
|
|
|
451
494
|
/**
|
|
452
495
|
* Get exchange rate
|
|
453
|
-
* This operation retrieves the current exchange rate between a specified currency pair.
|
|
496
|
+
* This operation retrieves the current exchange rate between a specified currency pair. The exchange rate is updated approximately every 10 minutes. <Note>This operation returns the exchange rate for reference only. The actual exchange rate may vary due to market fluctuations and other factors.</Note>
|
|
454
497
|
* @param {String} token_id 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`
|
|
455
498
|
* @param {String} currency The fiat currency. Currently, only `USD` is supported.
|
|
456
499
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetExchangeRate200Response}
|
|
@@ -566,7 +609,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
566
609
|
|
|
567
610
|
/**
|
|
568
611
|
* Get developer balance
|
|
569
|
-
* This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [
|
|
612
|
+
* This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).
|
|
570
613
|
* @param {String} token_id 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`
|
|
571
614
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PspBalance} and HTTP response
|
|
572
615
|
*/
|
|
@@ -596,7 +639,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
596
639
|
|
|
597
640
|
/**
|
|
598
641
|
* Get developer balance
|
|
599
|
-
* This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [
|
|
642
|
+
* This operation retrieves the balance information for you as the developer. The balance information is grouped by token. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).
|
|
600
643
|
* @param {String} token_id 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`
|
|
601
644
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PspBalance}
|
|
602
645
|
*/
|
|
@@ -830,9 +873,9 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
830
873
|
}
|
|
831
874
|
var pathParams = {};
|
|
832
875
|
var queryParams = {
|
|
833
|
-
'merchant_id': opts['merchant_id'],
|
|
834
876
|
'token_id': token_id,
|
|
835
|
-
'custom_payer_id': custom_payer_id
|
|
877
|
+
'custom_payer_id': custom_payer_id,
|
|
878
|
+
'merchant_id': opts['merchant_id']
|
|
836
879
|
};
|
|
837
880
|
var headerParams = {};
|
|
838
881
|
var formParams = {};
|
|
@@ -993,7 +1036,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
993
1036
|
|
|
994
1037
|
/**
|
|
995
1038
|
* List merchant balances
|
|
996
|
-
* This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned. For more information, please refer to [
|
|
1039
|
+
* This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).
|
|
997
1040
|
* @param {String} token_id 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`
|
|
998
1041
|
* @param {module:model/AcquiringType} acquiring_type The payment acquisition type. - `Order`: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions. - `TopUp`: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models.
|
|
999
1042
|
* @param {Object} opts Optional parameters
|
|
@@ -1033,7 +1076,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1033
1076
|
|
|
1034
1077
|
/**
|
|
1035
1078
|
* List merchant balances
|
|
1036
|
-
* This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned. For more information, please refer to [
|
|
1079
|
+
* This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned. For more information, please refer to [Funds allocation and balances](https://www.cobo.com/developers/v2/payments/amounts-and-balances).
|
|
1037
1080
|
* @param {String} token_id 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`
|
|
1038
1081
|
* @param {module:model/AcquiringType} acquiring_type The payment acquisition type. - `Order`: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions. - `TopUp`: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models.
|
|
1039
1082
|
* @param {Object} opts Optional parameters
|
|
@@ -1056,8 +1099,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1056
1099
|
* @param {String} [before] 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.
|
|
1057
1100
|
* @param {String} [after] 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.
|
|
1058
1101
|
* @param {String} [keyword] A search term used for fuzzy matching of merchant names.
|
|
1059
|
-
* @param {String} [wallet_id]
|
|
1060
|
-
* @param {module:model/WalletSetup} [wallet_setup]
|
|
1102
|
+
* @param {String} [wallet_id] This parameter has been deprecated.
|
|
1103
|
+
* @param {module:model/WalletSetup} [wallet_setup] The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses. - `Shared`: Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously. - `Separate`: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant. - `Default`: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization).
|
|
1061
1104
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMerchants200Response} and HTTP response
|
|
1062
1105
|
*/
|
|
1063
1106
|
}, {
|
|
@@ -1094,8 +1137,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1094
1137
|
* @param {String} opts.before 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.
|
|
1095
1138
|
* @param {String} opts.after 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.
|
|
1096
1139
|
* @param {String} opts.keyword A search term used for fuzzy matching of merchant names.
|
|
1097
|
-
* @param {String} opts.wallet_id
|
|
1098
|
-
* @param {module:model/WalletSetup} opts.wallet_setup
|
|
1140
|
+
* @param {String} opts.wallet_id This parameter has been deprecated.
|
|
1141
|
+
* @param {module:model/WalletSetup} opts.wallet_setup The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses. - `Shared`: Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously. - `Separate`: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant. - `Default`: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization).
|
|
1099
1142
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMerchants200Response}
|
|
1100
1143
|
*/
|
|
1101
1144
|
}, {
|
|
@@ -1468,10 +1511,10 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1468
1511
|
}
|
|
1469
1512
|
|
|
1470
1513
|
/**
|
|
1471
|
-
*
|
|
1472
|
-
* This operation
|
|
1514
|
+
* Estimate fees
|
|
1515
|
+
* This operation calculates fees for payment-related operations, including: - **Pay-in**: Fees for accepting payments - **Refunds**: Fees for refunding the payment - **Crypto payouts**: Fees for payouts in crypto - **Fiat off-ramp**: Fees for fiat currency transfers via off-ramp. The returned fees represent the charges that would apply if the operation were executed immediately. Note that actual fees may vary over time based on your usage volume and applicable fee rates.
|
|
1473
1516
|
* @param {Object} opts Optional parameters
|
|
1474
|
-
* @param {module:model/PaymentEstimateFeeRequest} [PaymentEstimateFeeRequest] The request body
|
|
1517
|
+
* @param {module:model/PaymentEstimateFeeRequest} [PaymentEstimateFeeRequest] The request body for fee estimation.
|
|
1475
1518
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PaymentEstimateFee201Response} and HTTP response
|
|
1476
1519
|
*/
|
|
1477
1520
|
}, {
|
|
@@ -1494,10 +1537,10 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1494
1537
|
}
|
|
1495
1538
|
|
|
1496
1539
|
/**
|
|
1497
|
-
*
|
|
1498
|
-
* This operation
|
|
1540
|
+
* Estimate fees
|
|
1541
|
+
* This operation calculates fees for payment-related operations, including: - **Pay-in**: Fees for accepting payments - **Refunds**: Fees for refunding the payment - **Crypto payouts**: Fees for payouts in crypto - **Fiat off-ramp**: Fees for fiat currency transfers via off-ramp. The returned fees represent the charges that would apply if the operation were executed immediately. Note that actual fees may vary over time based on your usage volume and applicable fee rates.
|
|
1499
1542
|
* @param {Object} opts Optional parameters
|
|
1500
|
-
* @param {module:model/PaymentEstimateFeeRequest} opts.PaymentEstimateFeeRequest The request body
|
|
1543
|
+
* @param {module:model/PaymentEstimateFeeRequest} opts.PaymentEstimateFeeRequest The request body for fee estimation.
|
|
1501
1544
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PaymentEstimateFee201Response}
|
|
1502
1545
|
*/
|
|
1503
1546
|
}, {
|
|
@@ -203,7 +203,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
203
203
|
|
|
204
204
|
/**
|
|
205
205
|
* Call smart contract
|
|
206
|
-
* This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets on EVM-compatible chains and Solana
|
|
206
|
+
* This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets on EVM-compatible chains and Solana.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
|
|
207
207
|
* @param {Object} opts Optional parameters
|
|
208
208
|
* @param {module:model/ContractCallParams} [ContractCallParams] The request body for making a contract call.
|
|
209
209
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateTransferTransaction201Response} and HTTP response
|
|
@@ -229,7 +229,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
229
229
|
|
|
230
230
|
/**
|
|
231
231
|
* Call smart contract
|
|
232
|
-
* This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets on EVM-compatible chains and Solana
|
|
232
|
+
* This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets on EVM-compatible chains and Solana.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
|
|
233
233
|
* @param {Object} opts Optional parameters
|
|
234
234
|
* @param {module:model/ContractCallParams} opts.ContractCallParams The request body for making a contract call.
|
|
235
235
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateTransferTransaction201Response}
|