A Customer is able to choose from a list of virtual currencies in order to make a Payment for a PaymentIntent. The supported virtual currencies vary for each PaymentIntent and they depend on the PaymentIntent amount and the actual availability of a particular cryptocurrency.
This endpoint allows you to fetch the list of cryptocurrencies that are available for a specific PaymentIntent and the ones that are unavailable as well.
To get the list of cryptocurrencies for a specific PaymentIntent, pass the id of a PaymentIntent in the id parameter.
Furthermore, the state query parameter enables you to filter the currencies by their availability state. There can be several currency states. However, only one state is dedicated for the available currencies while the unavailable ones can have different states that explain the reason of unavailability.
Both the currency parameters and currency states are listed and described bellow.
Currency properties
| Property | Type | Description |
|---|---|---|
| name | string | Name of the cryptocurrency. |
| symbol | string | The ticker symbol of the particular 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. |
| tagName | string or null | Name of the tag/memo that a particular cryptocurrency uses. If a cryptocurrency does not use tag/memo, this parameter is null. |
Currency 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. |