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

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

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"
      ]
    }
  ]
]