Eligibility

Get supported currencies, countries, and states

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

Get currencies

get

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

Authorizations

PublicApiKeyAuthPrivateApiKeyAuth

X-Public-API-KeystringRequired

Responses

200

Get the list of fiat and crypto currencies

application/json

typestring · enumRequired

Can be crypto or fiat

Possible values:

namestringRequired

Name of the currency

Example: ["US Dollar","Bitcoin"]

codestringRequired

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.

Example: ["USD","BTC"]

precisionnumberRequired

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. For USD, the precision is 2 decimal places, so the smallest possible unit of USD is 0.01 USD.

Example: [2,8]

minBuyAmountstringOptional

The minimum base currency amount a customer can use to buy crypto. For example, if minBuyAmount is 25 under USD fiat currency object, no orders for less than $25 can be placed. This field is only present for fiat currencies.

Example: 20

maxBuyAmountstringOptional

The maximum base currency amount a customer can use to buy crypto. For example, for maxBuyAmount is 1200 under USD fiat currency object, no orders for more than $1200 can be placed. This field is only present for fiat currencies.

Example: 1200

networkstringOptional

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

Example: ["BTC","ETH"]

supportsDestinationTagbooleanOptional

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

isSupportedInUSbooleanOptional

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

allowedUSStatesstring[]Optional

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

Example: ["AL","CT"]

get

/v1/currencies

HTTPcURLJavaScriptPython

GET /partner-gateway/partner-api/v1/currencies HTTP/1.1
Host: api.blockchain.info
X-Public-API-Key: YOUR_API_KEY
Accept: */*

200

Get the list of fiat and crypto currencies

[
  [
    {
      "type": "FIAT",
      "name": "US Dollar",
      "code": "USD",
      "precision": 2,
      "minBuyAmount": 20,
      "maxBuyAmount": 1200
    },
    {
      "type": "CRYPTO",
      "name": "Bitcoin",
      "code": "BTC",
      "precision": 8,
      "network": "BTC",
      "supportsDestinationTag": false,
      "isSupportedInUS": true,
      "allowedUSStates": [
        "AL",
        "CT"
      ]
    }
  ]
]

Get countries and states

get

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

Authorizations

PublicApiKeyAuthPrivateApiKeyAuth

X-Public-API-KeystringRequired

Query parameters

onlyBuyAllowedbooleanOptional

If present, only returns countries and states that are allowed to buy.

Default: true

Responses

200

Get eligible regions

application/json

get

/v1/regions

HTTPcURLJavaScriptPython

GET /partner-gateway/partner-api/v1/regions HTTP/1.1
Host: api.blockchain.info
X-Public-API-Key: YOUR_API_KEY
Accept: */*

200

Get eligible regions

{
  "countries": [
    [
      {
        "alpha2": "BE",
        "alpha3": "BEL",
        "isBuyAllowed": true,
        "name": "Belgium"
      },
      {
        "alpha2": "GB",
        "alpha3": "GBR",
        "isBuyAllowed": true,
        "name": "United Kingdom"
      },
      {
        "alpha2": "US",
        "alpha3": "USA",
        "isBuyAllowed": true,
        "name": "United States"
      }
    ]
  ],
  "usStates": [
    [
      {
        "alpha2": "CA",
        "isBuyAllowed": true,
        "name": "California"
      },
      {
        "alpha2": "FL",
        "isBuyAllowed": true,
        "name": "Florida"
      },
      {
        "alpha2": "WA",
        "isBuyAllowed": true,
        "name": "Washington"
      }
    ]
  ]
}

Get payment methods

get

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

Authorizations

PublicApiKeyAuthPrivateApiKeyAuth

X-Public-API-KeystringRequired

Responses

200

Get eligible payment methods

application/json

typestring · enumRequired

Type of the payment method supported.

Possible values:

supportedCurrenciesstring[]Required

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.

get

/v1/payment-methods

HTTPcURLJavaScriptPython

GET /partner-gateway/partner-api/v1/payment-methods HTTP/1.1
Host: api.blockchain.info
X-Public-API-Key: YOUR_API_KEY
Accept: */*

200

Get eligible payment methods

[
  [
    {
      "type": "CARD",
      "supportedCurrencies": [
        "USD",
        "GBP",
        "EUR"
      ]
    }
  ]
]