Eligibility

Get supported currencies, countries, and states

The Eligibility API provides information on the currencies and regions supported by Blockchain.com Pay.

Get currencies

Returns an array of all currencies enabled on your account. Contact your account executive to customise your account settings.

GEThttps://api.blockchain.info/partner-gateway/partner-api/v1/currencies

Authorization

Response

get the list of existing currencies

Body

type*enum

Can be crypto or fiat

cryptofiat

name*string

Name of the currency

code*string

The alphabetical code used to identify the currency. The code is an abbreviated version of the currency name that is used to identify the currency. Sometimes referred to as the currency "ticker". Code is case sensitive.

precision*number

The number of decimal places supported by the currency. For example, Bitcoin has a precision of 8 decimal places, so the smallest possible unit of Bitcoin is 0.00000001 BTC. Always 'null' for fiat.

minBuyAmountstring

The minimum base currency amount a customer can use to buy crypto. For example, if minBuyAmount for BTC is $25, no orders for less than $25 can be created for the customer when buying Bitcoin. Always null for fiat

maxBuyAmountstring

The maximum base currency amount a customer can use to buy crypto. For example, for maxBuyAmount for Bitcoin is $1,200, no orders for more than $1,200 can be created for the customer when buying Bitcoin. Always null for fiat

supportsDestinationTagboolean

Whether the currency supports destination tags / memo. This is true for example for XLM and XRP. Always null for fiat.

networkstring

The network the currency is on. Can be BTC, ETH etc. Always null for fiat.

isSupportedInUSboolean

Whether purchases for this currency are supported in the US. Always null for fiat

allowedUSStatesarray of string

List of US states that are supported for this currency. US states are specified by the last 2 letter of their ISO 3166-2:US code. Always null for fiat

Request

const response = await fetch('https://api.blockchain.info/partner-gateway/partner-api/v1/currencies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "type": "crypto",
    "name": "text",
    "code": "text",
    "precision": 0,
    "minBuyAmount": "text",
    "maxBuyAmount": "text",
    "supportsDestinationTag": false,
    "network": "text",
    "isSupportedInUS": false,
    "allowedUSStates": [
      "text"
    ]
  }
]

Get countries and states

Returns an array of all countries and states supported by BcPay.

GEThttps://api.blockchain.info/partner-gateway/partner-api/v1/regions

Authorization

Query parameters

Response

get eligible regions

Body

countries*array of Country (object)

usStates*array of UsState (object)

Request

const response = await fetch('https://api.blockchain.info/partner-gateway/partner-api/v1/regions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "countries": [
    {
      "alpha2": "text",
      "alpha3": "text",
      "isBuyAllowed": "text",
      "name": "text"
    }
  ],
  "usStates": [
    {
      "alpha2": "text",
      "isBuyAllowed": false,
      "name": "text"
    }
  ]
}

Get payment methods

Returns an array of all payment methods enabled on your account. Contact your account executive to customise your account settings.

GEThttps://api.blockchain.info/partner-gateway/partner-api/v1/payment-methods

Authorization

Response

get the list of existing payment methods

Body

type*enum

Type of the payment method supported. Currently only CARD is supported.

CARD

supportedCurrencies*array of string

List of currencies supported for this payment method. Each Currency is specified by its alphabetical code. The code is an abbreviated version of the currency name, sometimes referred to as the currency "ticker". Code is case sensitive.

Request

const response = await fetch('https://api.blockchain.info/partner-gateway/partner-api/v1/payment-methods', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "type": "CARD",
    "supportedCurrencies": [
      "text"
    ]
  }
]

Last updated 15 days ago

[ { "type": "crypto", "name": "text", "code": "text", "precision": 0, "minBuyAmount": "text", "maxBuyAmount": "text", "supportsDestinationTag": false, "network": "text", "isSupportedInUS": false, "allowedUSStates": [ "text" ] } ]