GETv2/currencies/:id

Retrieve a Currency by ID

SDKgetCurrenciesByIdV2

finds a currency by its id

PublicAnonymous

Endpoint · Instance A

https://a-api.coinpayments.net/api/v2/currencies/:id

Request

path parameters

idstringpath

the id of the currency to retrieve

Responses

200

Represents money, in any form (e.g. crypto/fiat currencies and tokens), supported on the CoinPayments platform in some capacity (e.g. holding in a wallet and/or payment processing).

idstring

the unique id of the currency on the CoinPayments platform

Example1235

typestring

Type of currency

Enumcryptotokenfiat

symbolstring

ticker symbol for the currency. For fiat currencies this is the three character (ISO-4217) currency code, and for crypto currencies their multi-character symbol.

ExampleBTC

namestring

the name of the currency, e.g. 'United States Dollar' or 'Bitcoin'

ExampleBitcoin

imageUrlstringnullable

Link to a CoinPayments hosted image for a currency in a SVG format

decimalPlacesinteger

the number of digits after the decimal separator, e.g. 2 for USD, 8 for BTC, 0 for JPY

Formatint32

rankinteger

the relative ordering/ranking of this currency to the other supported currencies on the CoinPayments platform

Formatint32

statusstring

The status of the currency on the CoinPayments platform

EnumactiveunderMaintenancedeleted

capabilitiesstring[]nullable

the capabilities of the currency on the CoinPayments platform

EnumpaymentssingleSigAccountspooledAccountsutxoconversiononRampoffRamp

websitesstring[]nullable

the websites for the currency

explorersstring[]nullable

the explorers for the currency (if crypto or a token)

requiredConfirmationsinteger

The required number of confirmations needed to be received to treat transactions related to this currency as confirmed

Formatint64

isEnabledForPaymentboolean

Whether currency is enabled as a payment option for invoices and payment buttons