latestOpenAPI 3.0.32026-08-106722.8 KB

7579ec027be7

Eligibility

Get countries and states

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

get/v1/regions

Query parameters

onlyBuyAllowedboolean

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

Response

Eligible regions.

Example response

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