Get Currencies
GET /currencies
Facade PUBLIC
PUBLICHTTP Request
You can retrieve all the currencies supported by BitPay.
let currencies = await client.GetCurrencyInfo()
HTTP Response
Body
| Name | Description | Type |
|---|---|---|
data | Array of supported currencies | array |
→ code | ISO 4217 3-character currency code | string |
→ symbol | Display symbol | string |
→ precision | Number of decimal places | number |
→ name | English currency name | string |
→ plural | English plural form | string |
→ alts | Alternative currency name(s) | string |
→ minimum | Minimum supported value when creating an invoice, bill or payout for instance | string |
→ sanctionned | If the currency is linked to a sanctionned country | boolean |
→ decimals | decimal precision | number |
→ chain | For cryptocurrencies or tokens, the corresponding chain is also specified. For instance, with USDC (Circle USD Coin), the chain is ETH. | string |
{
"data": [
{
"code": "BTC",
"symbol": "฿",
"precision": 6,
"name": "Bitcoin",
"plural": "Bitcoin",
"alts": "btc",
"minimum": 0.000006,
"sanctioned": false,
"decimals": 8,
"chain": "BTC"
},
...
...
{
"code": "XRP",
"symbol": "Ʀ",
"precision": 6,
"name": "Ripple",
"plural": "Ripple",
"alts": "xrp",
"minimum": 0.000006,
"sanctioned": false,
"decimals": 6,
"chain": "XRP"
},
...
...
{
"code": "EUR",
"symbol": "€",
"precision": 2,
"name": "Eurozone Euro",
"plural": "Eurozone Euros",
"alts": "eur",
"minimum": 0.01,
"sanctioned": false,
"decimals": 2
},
...
...
{
"code": "USD",
"symbol": "$",
"precision": 2,
"name": "US Dollar",
"plural": "US Dollars",
"alts": "usd bucks",
"minimum": 0.01,
"sanctioned": false,
"decimals": 2
},
{
"code": "USDC",
"symbol": "$",
"precision": 2,
"name": "Circle USD Coin",
"plural": "Circle USD Coin",
"alts": "",
"minimum": 0.01,
"sanctioned": false,
"decimals": 6,
"chain": "ETH"
},
...
...
]
}