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

Partner's public API key. Required on all endpoints to identify the partner.

Responses

200

List of fiat and crypto currencies available for trading.

application/json

typestring · enumRequired

Whether this is a fiat or crypto currency.

Example: FIATPossible values:

namestringRequired

Full name of the currency.

Example: US Dollar

codestringRequired

Alphabetical ticker code for the currency. Case sensitive.

Example: USD

precisionintegerRequired

Number of decimal places supported. For example, BTC has precision 8 (smallest unit 0.00000001 BTC).

Example: 2

minBuyAmountstringOptional

Minimum fiat amount allowed per order. Only present for fiat currencies.

Example: 20.00

maxBuyAmountstringOptional

Maximum fiat amount allowed per order. Only present for fiat currencies.

Example: 1200.00

networkstringOptional

The blockchain network the currency runs on (e.g. BTC, ETH). Always null for fiat.

Example: BTC

supportsDestinationTagbooleanOptional

Whether the currency supports destination tags or memo fields (e.g. XLM, XRP). Always null for fiat.

isSupportedInUSbooleanOptional

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

allowedUSStatesstring[]Optional

US states where this currency can be purchased, using the last 2 characters of ISO 3166-2:US codes. Always null for fiat.

Example: ["AL","CT"]

401

Missing or invalid API key.

application/json

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: */*

[
  {
    "type": "FIAT",
    "name": "US Dollar",
    "code": "USD",
    "precision": 2,
    "minBuyAmount": "20.00",
    "maxBuyAmount": "1200.00",
    "network": "BTC",
    "supportsDestinationTag": true,
    "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

Partner's public API key. Required on all endpoints to identify the partner.

Query parameters

onlyBuyAllowedbooleanOptional

If true, only returns countries and states where buying is permitted.

Default: true

Responses

200

Eligible regions.

application/json

401

Missing or invalid API key.

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: */*

{
  "countries": [
    {
      "alpha2": "US",
      "alpha3": "USA",
      "isBuyAllowed": true,
      "name": "United States"
    }
  ],
  "usStates": [
    {
      "alpha2": "CA",
      "isBuyAllowed": true,
      "name": "California"
    }
  ]
}

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

Partner's public API key. Required on all endpoints to identify the partner.

Responses

200

List of eligible payment methods and their supported currencies.

application/json

typestring · enumRequired

Payment method to be used for the order.

Example: CARDPossible values:

supportedCurrenciesstring[]Required

Fiat currency codes supported for this payment method.

401

Missing or invalid API key.

application/json

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: */*

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