/invoices/:id/payment-currencies/:currencyRetrieve an Invoice Payment Address
getInvoicesPaymentCurrenciesByIdCurrencyV1https://a-api.coinpayments.net/api/v1/invoices/:id/payment-currencies/:currencyRequest
path parametersidstringpathIf of active invoice
currencystringpathCurrency in format 'id' or 'id:contractAddress' for smart contracts
Responses
200 · 401 · 403Encapsulates the details for sending payments to the invoice
idstringthe unique id of the currency on the CoinPayments platform
1235typestringType of currency
cryptotokenfiatsymbolstringticker symbol for the currency. For fiat currencies this is the three character (ISO-4217) currency code, and for crypto currencies their multi-character symbol.
BTCnamestringthe name of the currency, e.g. 'United States Dollar' or 'Bitcoin'
BitcoinimageUrlstringnullableLink to a CoinPayments hosted image for a currency in a SVG format
decimalPlacesintegerthe number of digits after the decimal separator, e.g. 2 for USD, 8 for BTC, 0 for JPY
int32rankintegerthe relative ordering/ranking of this currency to the other supported currencies on the CoinPayments platform
int32statusstringThe status of the currency on the CoinPayments platform
activeunderMaintenancedeletedcapabilitiesstring[]nullablethe capabilities of the currency on the CoinPayments platform
paymentssingleSigAccountspooledAccountsutxoconversiononRampoffRampwebsitesstring[]nullablethe websites for the currency
explorersstring[]nullablethe explorers for the currency (if crypto or a token)
requiredConfirmationsintegerThe required number of confirmations needed to be received to treat transactions related to this currency as confirmed
int64isEnabledForPaymentbooleanWhether currency is enabled as a payment option for invoices and payment buttons
ratenumberthe rate of conversion between the base currency of the invoice and the payment methods currency
doublenamestringthe name of the additional charge or fee applied when paying in another currency
displayValuestringnullablethe value formatted for display
valuestringnullablethe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500.
31000currencyIdstringnullablethe currency the monetary `value` is represented in
1235valueAsDecimalnumberRepresents the monetary value as a decimal, allowing for precise calculations and storage.
doubledisplayValuestringnullablethe value formatted for display
valuestringnullablethe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500.
31000currencyIdstringnullablethe currency the monetary `value` is represented in
1235valueAsDecimalnumberRepresents the monetary value as a decimal, allowing for precise calculations and storage.
doubleaddressstringthe raw payment address
biP21stringnullablethe BIP21 payment code, if available
expiresstringthe timestamp when the payment expires and new payments will no longer be accepted
date-timedisplayValuestringnullablethe value formatted for display
valuestringnullablethe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500.
31000currencyIdstringnullablethe currency the monetary `value` is represented in
1235valueAsDecimalnumberRepresents the monetary value as a decimal, allowing for precise calculations and storage.
double