Currencies

List crypto currencies

Retrieves a list of all cryptocurrencies available on the BVNK platform. This list represents cryptocurrencies that end users can select whilst making a payment.

Also, see Currencies for the comprehensive list of available currencies.

get/api/currency/crypto

Request

Query parameters

offsetnumber

Where to start fetching records.

maxnumber

Maximum number of items in response.

allowDepositsboolean

Only list currencies that allow deposits.

Response

OK

codestring

The currency code.

depositFeenumber

The % fee to deposit the currency.

fiatboolean

Is a fiat currency.

iconstring

The icon of the currency.

idinteger

The ID of the currency.

namestring

The currency name.

pricePrecisioninteger

The precision of decimal points for the currency.

quantityPrecisioninteger

The precision of decimal points for the currency displayed.

supportsDepositsboolean

Is deposits for this currency supported.

supportsWithdrawalsboolean

Is withdrawals for this currency supported

withdrawalFeenumber

The % fee to withdraw this currency.

Example response

[
  {
    "code": "ETH",
    "icon": "https://cdn.com/eth-icon.png",
    "id": 1432,
    "name": "Ethereum",
    "options": {
      "transaction": "https://etherscan.io/tx/{{hash}}",
      "explorer": "https://etherscan.io/",
      "address": "https://etherscan.io/address/{{address}}",
      "confirmations": 12
    },
    "protocols": [
      {
        "code": "ERC20",
        "network": "Ethereum"
      }
    ],
    "withdrawalFee": 0.01,
    "withdrawalParameters": [
      {
        "id": 1432,
        "code": "BTC",
        "name": "Bitcoin"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 3 revisions of this API.