whitebit-python-sdk 1.1.0__py3-none-any.whl

whitebit/withdraw/client.py

@@ -0,0 +1,496 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawWithdrawClient, RawWithdrawClient
+from .types.create_withdraw_request_beneficiary import CreateWithdrawRequestBeneficiary
+from .types.create_withdraw_request_travel_rule import CreateWithdrawRequestTravelRule
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class WithdrawClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawWithdrawClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawWithdrawClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWithdrawClient
+        """
+        return self._raw_client
+
+    def create_withdraw(
+        self,
+        *,
+        ticker: str,
+        amount: str,
+        address: str,
+        unique_id: str,
+        request: str,
+        nonce: str,
+        memo: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        network: typing.Optional[str] = OMIT,
+        partial_enable: typing.Optional[bool] = OMIT,
+        beneficiary: typing.Optional[CreateWithdrawRequestBeneficiary] = OMIT,
+        travel_rule: typing.Optional[CreateWithdrawRequestTravelRule] = OMIT,
+        payment_description: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[typing.Optional[typing.Any]]:
+        """
+        The endpoint creates withdraw for the specified ticker.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        <Note>
+        Also, fiat currencies can't be withdrawn without KYC verification.
+        </Note>
+
+        Parameters
+        ----------
+        ticker : str
+            Currency's [ticker](/glossary#ticker). Example: BTC
+
+            ⚠️ Currencies ticker must have "can_deposit" status equal to "true". Use [Asset Status endpoint](/public/http-v4/asset-status-list) to know more about currency.
+
+        amount : str
+            Withdraw amount (including [fee](/glossary#fee)). To add the fee to the specified amount, use the /main-account/withdraw-pay request.
+
+        address : str
+            Target address (wallet address for cryptocurrencies, identifier/[card token](/glossary#card-token) for [fiat](/glossary#fiat) currencies)
+
+        unique_id : str
+            Unique transaction identifier.
+
+            ⚠️ Generate a new unique ID for each withdrawal request.
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        memo : typing.Optional[str]
+            [Memo](/glossary#memodestination-tag).
+
+            ⚠️ Required if currency is memoable.
+
+        provider : typing.Optional[str]
+            [Fiat](/glossary#fiat) currency [provider](/glossary#provider). Example: VISAMASTER
+
+            ⚠️ Required for fiat currencies. Currency provider should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response.
+
+        network : typing.Optional[str]
+            Cryptocurrency network. Available for multi network currencies. Example: OMNI
+
+            ⚠️ Currency network should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response. Default for USDT is ERC20
+
+        partial_enable : typing.Optional[bool]
+            Optional parameter for [FIAT](/glossary#fiat) withdrawals with increased Maximum Limit if set as "true". To use this parameter, the application must support "Partially successful" withdrawal status and latest updates in deposit/withdrawal history.
+
+        beneficiary : typing.Optional[CreateWithdrawRequestBeneficiary]
+            Beneficiary information data array.
+
+            ⚠️ Required if currency [ticker](/glossary#ticker) is one of: UAH_IBAN, USD_VISAMASTER, EUR_VISAMASTER, USD, EUR
+
+        travel_rule : typing.Optional[CreateWithdrawRequestTravelRule]
+            Travel Rule information data array.
+
+            ⚠️ Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+
+        payment_description : typing.Optional[str]
+            Description of withdrawal destination
+
+            ⚠️ Required if currency is crypto and withdrawal from whitebit-tr.com
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[typing.Optional[typing.Any]]
+            Validation succeeded and withdraw creation process is started. Check the request status by uniqueId in deposit/withdraw history.
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.withdraw.create_withdraw(ticker='ETH', amount='0.9', address='0x0964A6B8F794A4B8d61b62652dB27ddC9844FB4c', unique_id='24529041', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.create_withdraw(
+            ticker=ticker,
+            amount=amount,
+            address=address,
+            unique_id=unique_id,
+            request=request,
+            nonce=nonce,
+            memo=memo,
+            provider=provider,
+            network=network,
+            partial_enable=partial_enable,
+            beneficiary=beneficiary,
+            travel_rule=travel_rule,
+            payment_description=payment_description,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_withdraw_pay(
+        self,
+        *,
+        ticker: str,
+        amount: str,
+        address: str,
+        unique_id: str,
+        request: str,
+        nonce: str,
+        memo: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        network: typing.Optional[str] = OMIT,
+        partial_enable: typing.Optional[bool] = OMIT,
+        beneficiary: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        travel_rule: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[typing.Optional[typing.Any]]:
+        """
+        The endpoint has the similar logic as /main-account/withdraw, but with the only difference: amount that is specified will not include [fee](/glossary#fee) (it will be calculated to make target withdraw amount equal to the specified amount).
+
+        **Example:**
+        - When creating a base withdraw with amount = 100 USD, the receiver receives 100 USD minus the [fee](/glossary#fee), and the balance decreases by 100 USD.
+        - When using this endpoint with amount = 100 USD, the receiver receives 100 USD, and the balance decreases by 100 USD plus the [fee](/glossary#fee).
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        ticker : str
+            Currencies [ticker](/glossary#ticker). Example: BTC ⚠️ Currencies ticker must have "can_deposit" status equal to "true". Use [Asset Status endpoint](/public/http-v4/asset-status-list) to know more about currency.
+
+        amount : str
+            Withdraw amount (including [fee](/glossary#fee)). To add the fee to the specified amount, use the /main-account/withdraw-pay request
+
+        address : str
+            Target address (wallet address for cryptocurrencies, identifier/[card token](/glossary#card-token) for [fiat](/glossary#fiat) currencies)
+
+        unique_id : str
+            Unique transaction identifier. ⚠️ Generate a new unique ID for each withdrawal request.
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        memo : typing.Optional[str]
+            Required if currency is memoable. See [memo](/glossary#memodestination-tag) for details.
+
+        provider : typing.Optional[str]
+            [Fiat](/glossary#fiat) currency [provider](/glossary#provider). Example: VISAMASTER ⚠️ Currency provider should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response. Required if currency is fiat.
+
+        network : typing.Optional[str]
+            Cryptocurrency network. Available for [multinetwork](/glossary#multinetwork) currencies. Example: OMNI ⚠️ Currency network should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response. Default for USDT is ERC20
+
+        partial_enable : typing.Optional[bool]
+            Optional parameter for [FIAT](/glossary#fiat) withdrawals with increased Maximum Limit if set as "true". To use this parameter, the application must support "Partially successful" withdrawal status and latest updates in deposit/withdrawal history.
+
+        beneficiary : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Beneficiary information data. Required if currency [ticker](/glossary#ticker) is one of: UAH_IBAN, USD_VISAMASTER, EUR_VISAMASTER, USD, EUR
+
+        travel_rule : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Travel Rule information data. Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[typing.Optional[typing.Any]]
+            Validation succeeded and withdraw creation process is started. Check the request status by uniqueId in deposit/withdraw history.
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.withdraw.create_withdraw_pay(ticker='ETH', amount='0.9', address='0x0964A6B8F794A4B8d61b62652dB27ddC9844FB4c', unique_id='24529041', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.create_withdraw_pay(
+            ticker=ticker,
+            amount=amount,
+            address=address,
+            unique_id=unique_id,
+            request=request,
+            nonce=nonce,
+            memo=memo,
+            provider=provider,
+            network=network,
+            partial_enable=partial_enable,
+            beneficiary=beneficiary,
+            travel_rule=travel_rule,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncWithdrawClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawWithdrawClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWithdrawClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWithdrawClient
+        """
+        return self._raw_client
+
+    async def create_withdraw(
+        self,
+        *,
+        ticker: str,
+        amount: str,
+        address: str,
+        unique_id: str,
+        request: str,
+        nonce: str,
+        memo: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        network: typing.Optional[str] = OMIT,
+        partial_enable: typing.Optional[bool] = OMIT,
+        beneficiary: typing.Optional[CreateWithdrawRequestBeneficiary] = OMIT,
+        travel_rule: typing.Optional[CreateWithdrawRequestTravelRule] = OMIT,
+        payment_description: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[typing.Optional[typing.Any]]:
+        """
+        The endpoint creates withdraw for the specified ticker.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        <Note>
+        Also, fiat currencies can't be withdrawn without KYC verification.
+        </Note>
+
+        Parameters
+        ----------
+        ticker : str
+            Currency's [ticker](/glossary#ticker). Example: BTC
+
+            ⚠️ Currencies ticker must have "can_deposit" status equal to "true". Use [Asset Status endpoint](/public/http-v4/asset-status-list) to know more about currency.
+
+        amount : str
+            Withdraw amount (including [fee](/glossary#fee)). To add the fee to the specified amount, use the /main-account/withdraw-pay request.
+
+        address : str
+            Target address (wallet address for cryptocurrencies, identifier/[card token](/glossary#card-token) for [fiat](/glossary#fiat) currencies)
+
+        unique_id : str
+            Unique transaction identifier.
+
+            ⚠️ Generate a new unique ID for each withdrawal request.
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        memo : typing.Optional[str]
+            [Memo](/glossary#memodestination-tag).
+
+            ⚠️ Required if currency is memoable.
+
+        provider : typing.Optional[str]
+            [Fiat](/glossary#fiat) currency [provider](/glossary#provider). Example: VISAMASTER
+
+            ⚠️ Required for fiat currencies. Currency provider should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response.
+
+        network : typing.Optional[str]
+            Cryptocurrency network. Available for multi network currencies. Example: OMNI
+
+            ⚠️ Currency network should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response. Default for USDT is ERC20
+
+        partial_enable : typing.Optional[bool]
+            Optional parameter for [FIAT](/glossary#fiat) withdrawals with increased Maximum Limit if set as "true". To use this parameter, the application must support "Partially successful" withdrawal status and latest updates in deposit/withdrawal history.
+
+        beneficiary : typing.Optional[CreateWithdrawRequestBeneficiary]
+            Beneficiary information data array.
+
+            ⚠️ Required if currency [ticker](/glossary#ticker) is one of: UAH_IBAN, USD_VISAMASTER, EUR_VISAMASTER, USD, EUR
+
+        travel_rule : typing.Optional[CreateWithdrawRequestTravelRule]
+            Travel Rule information data array.
+
+            ⚠️ Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+
+        payment_description : typing.Optional[str]
+            Description of withdrawal destination
+
+            ⚠️ Required if currency is crypto and withdrawal from whitebit-tr.com
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[typing.Optional[typing.Any]]
+            Validation succeeded and withdraw creation process is started. Check the request status by uniqueId in deposit/withdraw history.
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.withdraw.create_withdraw(ticker='ETH', amount='0.9', address='0x0964A6B8F794A4B8d61b62652dB27ddC9844FB4c', unique_id='24529041', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_withdraw(
+            ticker=ticker,
+            amount=amount,
+            address=address,
+            unique_id=unique_id,
+            request=request,
+            nonce=nonce,
+            memo=memo,
+            provider=provider,
+            network=network,
+            partial_enable=partial_enable,
+            beneficiary=beneficiary,
+            travel_rule=travel_rule,
+            payment_description=payment_description,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_withdraw_pay(
+        self,
+        *,
+        ticker: str,
+        amount: str,
+        address: str,
+        unique_id: str,
+        request: str,
+        nonce: str,
+        memo: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        network: typing.Optional[str] = OMIT,
+        partial_enable: typing.Optional[bool] = OMIT,
+        beneficiary: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        travel_rule: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[typing.Optional[typing.Any]]:
+        """
+        The endpoint has the similar logic as /main-account/withdraw, but with the only difference: amount that is specified will not include [fee](/glossary#fee) (it will be calculated to make target withdraw amount equal to the specified amount).
+
+        **Example:**
+        - When creating a base withdraw with amount = 100 USD, the receiver receives 100 USD minus the [fee](/glossary#fee), and the balance decreases by 100 USD.
+        - When using this endpoint with amount = 100 USD, the receiver receives 100 USD, and the balance decreases by 100 USD plus the [fee](/glossary#fee).
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        ticker : str
+            Currencies [ticker](/glossary#ticker). Example: BTC ⚠️ Currencies ticker must have "can_deposit" status equal to "true". Use [Asset Status endpoint](/public/http-v4/asset-status-list) to know more about currency.
+
+        amount : str
+            Withdraw amount (including [fee](/glossary#fee)). To add the fee to the specified amount, use the /main-account/withdraw-pay request
+
+        address : str
+            Target address (wallet address for cryptocurrencies, identifier/[card token](/glossary#card-token) for [fiat](/glossary#fiat) currencies)
+
+        unique_id : str
+            Unique transaction identifier. ⚠️ Generate a new unique ID for each withdrawal request.
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        memo : typing.Optional[str]
+            Required if currency is memoable. See [memo](/glossary#memodestination-tag) for details.
+
+        provider : typing.Optional[str]
+            [Fiat](/glossary#fiat) currency [provider](/glossary#provider). Example: VISAMASTER ⚠️ Currency provider should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response. Required if currency is fiat.
+
+        network : typing.Optional[str]
+            Cryptocurrency network. Available for [multinetwork](/glossary#multinetwork) currencies. Example: OMNI ⚠️ Currency network should be taken from [Asset Status endpoint](/public/http-v4/asset-status-list) response. Default for USDT is ERC20
+
+        partial_enable : typing.Optional[bool]
+            Optional parameter for [FIAT](/glossary#fiat) withdrawals with increased Maximum Limit if set as "true". To use this parameter, the application must support "Partially successful" withdrawal status and latest updates in deposit/withdrawal history.
+
+        beneficiary : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Beneficiary information data. Required if currency [ticker](/glossary#ticker) is one of: UAH_IBAN, USD_VISAMASTER, EUR_VISAMASTER, USD, EUR
+
+        travel_rule : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Travel Rule information data. Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[typing.Optional[typing.Any]]
+            Validation succeeded and withdraw creation process is started. Check the request status by uniqueId in deposit/withdraw history.
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.withdraw.create_withdraw_pay(ticker='ETH', amount='0.9', address='0x0964A6B8F794A4B8d61b62652dB27ddC9844FB4c', unique_id='24529041', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_withdraw_pay(
+            ticker=ticker,
+            amount=amount,
+            address=address,
+            unique_id=unique_id,
+            request=request,
+            nonce=nonce,
+            memo=memo,
+            provider=provider,
+            network=network,
+            partial_enable=partial_enable,
+            beneficiary=beneficiary,
+            travel_rule=travel_rule,
+            request_options=request_options,
+        )
+        return _response.data