This endpoint will return an approximate value of each supported cryptocurrency based on the FIAT amount provided.
The Withdrawal Estimation enables the merchant to show an approximation of how much in terms of a specific cryptocurrency the customer will receive for a payout request. This can improve the user experience as it gives the user an option to accept or reject the Withdrawal request based on reviewing the approximate amount.
Additionally, the endpoint allows you specify whether you want show only the available cryptocurrencies or the ones currently not available by the provider. If nothing is specified all cryptocurrencies are returned with the availability state for each provided in the response.
Feel free to test out the endpoint with the default values or change the query parameter values available on the bottom of the page.
Estimates properties
| Property | Type | Description |
|---|---|---|
| symbol | string | The ticker symbol of the particular cryptocurrency. |
| name | string | Name of the cryptocurrency. |
| state | string | The availability state of a cryptocurrency. |
| approximateAmount | string or null | The requested amount of a PaymentIntent calculated in terms of a particular cryptocurrency. Value is null if the cryptocurrency is not available for any reason. |
Estimated currencies states
| state | Description |
|---|---|
| available | The cryptocurrency is available as a mean of payment. |
| unavailable_by_provider | The cryptocurrency is not available due to liquidity provider's restriction. |
| unavailable_by_operations | The cryptocurrency is not available due to Coinify's restriction. |
| unavailable_amount_too_large | The cryptocurrency is not available because the requested amount exceeds the maximum amount possible to be paid with this currency. |
| unavailable_amount_too_low | The cryptocurrency is not available because the requested amount is lower than the minimum amount possible to be paid with this currency. |