Countries & Currencies
Countries & payment methods
The Config API endpoint returns the current countries (states) supported by Coinbase Onramp and the payment methods available in each region. Clients can call this API periodically and cache the response so that they know which users to serve Onramp. Today, Coinbase operates in 90+ countries and this gets updated as we grow! See FAQ for an overview.
There are two ways to get the config:
- Use the fetchOnrampConfig util to get the config
- Make a direct call to the API
Full API endpoint list
For a complete list of all API endpoints supported by Onramp/Offramp, visit our API Reference section.
Method
URL
Request Parameters
The Onramp Config API has no request parameters.
Response Fields
The Onramp Config API returns a JSON response including the following fields.
| Name | Description |
|---|---|
countries | A list of supported countries, represented by their ISO 3166-1 two digit country code. Each country contains a list of payment method types available in that country; for the US it also contains a list of supported states. |
Example Request/Response
Fiat currencies and crypto assets supported
The Options endpoint returns the supported fiat currencies and available crypto assets that can be passed into the Onramp Quote API.
Full API endpoint list
For a complete list of all API endpoints supported by Onramp/Offramp, visit our API Reference section.
Method
URL
Request Parameters
| Name | Req | Description |
|---|---|---|
country | Y | ISO 3166-1 two-digit country code string representing the purchasing user’s country of residence, e.g., US. |
subdivision | N | ISO 3166-2 two-digit country subdivision code representing the purchasing user’s subdivision of residence within their country, e.g. NY. Required if the country=“US” because certain states (e.g., NY) have state specific asset restrictions. |
Response Fields
The Onramp Options API returns a JSON response including the following fields.
| Name | Description |
|---|---|
payment_currencies | List of supported fiat currencies that can be exchanged for crypto on Onramp in the given location. Each currency contains a list of available payment methods, with min and max transaction limits for that currency. |
purchase_currencies | List of available crypto assets that can be bought on Onramp in the given location. |