@cobo/cobo-waas2 1.30.0 → 1.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/README.md +5 -36
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/PaymentApi.js +39 -931
  4. package/dist/index.js +21 -105
  5. package/dist/model/Balance.js +14 -0
  6. package/dist/model/BridgingFee.js +9 -0
  7. package/dist/model/ContractCallParams.js +16 -0
  8. package/dist/model/CreatePaymentOrderRequest.js +4 -3
  9. package/dist/model/CreateTopUpAddresses.js +2 -2
  10. package/dist/model/CreateWalletAddress.js +2 -2
  11. package/dist/model/PaymentBridgeStatus.js +61 -0
  12. package/dist/model/PaymentBulkSendItem.js +9 -9
  13. package/dist/model/PaymentPayout.js +35 -4
  14. package/dist/model/PaymentPayoutDetail.js +49 -13
  15. package/dist/model/PaymentPayoutEvent.js +49 -13
  16. package/dist/model/PreCheck.js +89 -0
  17. package/dist/model/SkipCheckType.js +56 -0
  18. package/dist/model/SupportedToken.js +17 -17
  19. package/dist/model/TransferParams.js +16 -0
  20. package/dist/model/WebhookEventData.js +6 -0
  21. package/dist/model/WebhookEventType.js +15 -0
  22. package/docs/Balance.md +1 -0
  23. package/docs/BridgingFee.md +1 -0
  24. package/docs/ContractCallParams.md +1 -0
  25. package/docs/CreatePaymentOrderRequest.md +2 -2
  26. package/docs/CreateTopUpAddresses.md +1 -1
  27. package/docs/CreateWalletAddress.md +1 -1
  28. package/docs/PaymentApi.md +117 -1138
  29. package/docs/PaymentBridgeStatus.md +12 -0
  30. package/docs/PaymentBulkSendItem.md +5 -5
  31. package/docs/PaymentPayout.md +2 -1
  32. package/docs/PaymentPayoutDetail.md +2 -1
  33. package/docs/PaymentPayoutEvent.md +2 -1
  34. package/docs/PreCheck.md +9 -0
  35. package/docs/SkipCheckType.md +10 -0
  36. package/docs/SupportedToken.md +10 -10
  37. package/docs/TransferParams.md +1 -0
  38. package/docs/WebhookEventData.md +1 -0
  39. package/docs/WebhookEventType.md +6 -0
  40. package/package.json +1 -1
  41. package/dist/model/CreateCounterpartyWalletAddressRequest.js +0 -140
  42. package/dist/model/CreateDestinationBankAccountRequest.js +0 -272
  43. package/dist/model/CreateDestinationWalletAddressRequest.js +0 -140
  44. package/dist/model/DeleteCounterparty200Response.js +0 -110
  45. package/dist/model/DeleteCounterpartyWalletAddress200Response.js +0 -110
  46. package/dist/model/DeleteDestination200Response.js +0 -110
  47. package/dist/model/DeleteDestinationBankAccount200Response.js +0 -110
  48. package/dist/model/DeleteDestinationWalletAddress200Response.js +0 -110
  49. package/dist/model/EnableDestinationWhitelistRequest.js +0 -106
  50. package/dist/model/ListCounterpartyWalletAddress200Response.js +0 -123
  51. package/dist/model/ListDestinationBankAccounts200Response.js +0 -123
  52. package/dist/model/ListDestinationWalletAddresses200Response.js +0 -123
  53. package/dist/model/QueryDestinationWhitelistEnabled200Response.js +0 -106
  54. package/dist/model/UpdateCounterpartyByIdRequest.js +0 -160
  55. package/dist/model/UpdateDestinationByIdRequest.js +0 -173
  56. package/docs/CreateCounterpartyWalletAddressRequest.md +0 -11
  57. package/docs/CreateDestinationBankAccountRequest.md +0 -20
  58. package/docs/CreateDestinationWalletAddressRequest.md +0 -11
  59. package/docs/DeleteCounterparty200Response.md +0 -9
  60. package/docs/DeleteCounterpartyWalletAddress200Response.md +0 -9
  61. package/docs/DeleteDestination200Response.md +0 -9
  62. package/docs/DeleteDestinationBankAccount200Response.md +0 -9
  63. package/docs/DeleteDestinationWalletAddress200Response.md +0 -9
  64. package/docs/EnableDestinationWhitelistRequest.md +0 -9
  65. package/docs/ListCounterpartyWalletAddress200Response.md +0 -10
  66. package/docs/ListDestinationBankAccounts200Response.md +0 -10
  67. package/docs/ListDestinationWalletAddresses200Response.md +0 -10
  68. package/docs/QueryDestinationWhitelistEnabled200Response.md +0 -9
  69. package/docs/UpdateCounterpartyByIdRequest.md +0 -13
  70. package/docs/UpdateDestinationByIdRequest.md +0 -14
package/docs/Balance.md CHANGED
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
8
8
  **available** | **String** | The amount of tokens ready to be spent. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. |
9
9
  **pending** | **String** | The total amount being sent in a transaction, which is calculated as the withdrawal amount plus the transaction fee. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
10
10
  **locked** | **String** | For UTXO chains, this is the combined value of the selected UTXOs for the transaction. For other chains, it is equal to the Pending amount. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
11
+ **frozen** | **String** | Amount frozen due to compliance inspection. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
11
12
 
12
13
 
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
7
7
  **fee_amount** | **String** | The fee charged for bridging tokens to another chain. |
8
8
  **received_token_id** | **String** | The ID of the destination token received after bridging. | [optional]
9
9
  **received_amount** | **String** | The final amount of the token received after bridging. | [optional]
10
+ **bridge_status** | [**PaymentBridgeStatus**](PaymentBridgeStatus.md) | | [optional]
10
11
 
11
12
 
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
13
13
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
14
14
  **transaction_process_type** | [**TransactionProcessType**](TransactionProcessType.md) | | [optional]
15
15
  **auto_fuel** | [**AutoFuelType**](AutoFuelType.md) | | [optional]
16
+ **pre_check** | [**PreCheck**](PreCheck.md) | | [optional]
16
17
 
17
18
 
@@ -7,12 +7,12 @@ Name | Type | Description | Notes
7
7
  **merchant_id** | **String** | The merchant ID. |
8
8
  **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional]
9
9
  **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
10
- **pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com/developers/v2/guides/overview/supported-chains-and-tokens). | [optional]
10
+ **pricing_currency** | **String** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com//payments/en/guides/supported-chains-and-tokens#pricing-currency). | [optional]
11
11
  **pricing_amount** | **String** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional]
12
12
  **fee_amount** | **String** | The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. |
13
13
  **payable_currency** | **String** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
14
14
  **payable_amount** | **String** | The total amount the payer needs to pay, denominated in the specified `payable_currency`. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. | [optional]
15
- **expired_in** | **Number** | The pay-in order will expire after approximately a certain number of seconds: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. | [optional]
15
+ **expired_in** | **Number** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. | [optional] [default to 1800]
16
16
  **amount_tolerance** | **String** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional]
17
17
  **currency** | **String** | This field has been deprecated. Please use `pricing_currency` instead. | [optional] [default to '']
18
18
  **order_amount** | **String** | This field has been deprecated. Please use `pricing_amount` instead. | [optional]
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **merchant_id** | **String** | The merchant ID. If not provided, the default merchant created during organization initialization will be used. | [optional]
8
8
  **token_id** | **String** | The token ID, which identifies the cryptocurrency. |
9
- **custom_payer_ids** | **[String]** | A list of unique custom payer IDs required to create top-up addresses. The maximum number of items is 50. |
9
+ **custom_payer_ids** | **[String]** | A list of unique custom payer IDs required to create top-up addresses. |
10
10
 
11
11
 
@@ -5,6 +5,6 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **address** | **String** | The wallet address. |
8
- **chain_id** | **String** | The chain ID of the address. |
8
+ **chain_id** | **String** | The chain ID of the cryptocurrency. Supported values in the development environment: - Counterparty: `ARBITRUM_ETH`, `BASE_ETH`, `BSC_BNB`, `ETH`, `TRON`, `MATIC`, `SOL`, `TTRON`, `SOLDEV_SOL`, `SETH` - Destination: `All EVM Networks`, `SOL`, `TRON`, `TTRON`, `SOLDEV_SOL` Supported values in the production environment: - Counterparty: `ARBITRUM_ETH`, `BASE_ETH`, `BSC_BNB`, `ETH`, `TRON`, `MATIC`, `SOL` - Destination: `All EVM Networks`, `SOL`, `TRON` |
9
9
 
10
10