<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/ramp/config -->

# Get Ramp Config

Returns the current ramp configuration including integration mode and supported directions.

<EndpointHeader verb="GET" path="/payment/api/v1/on-ramp/config" />

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "x-request-id", desc: "Custom request ID for tracing" },
  ]}
/>

:::note Public Endpoint
This endpoint does not require authentication headers.
:::

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "integrationMode": "api",
    "supportsBuy": true,
    "supportsSell": true,
    "widgetBaseUrl": "https://buy.onramper.com"
  },
  "message": "Config retrieved"
}
```

### Response Fields

<ParamTable
  rows={[
    { name: "integrationMode", type: "string", desc: "`widget`, `api`, or `both`" },
    { name: "supportsBuy", type: "boolean", desc: "Whether on-ramp (fiat to crypto) is enabled" },
    { name: "supportsSell", type: "boolean", desc: "Whether off-ramp (crypto to fiat) is enabled" },
    { name: "widgetBaseUrl", type: "string", desc: "Base URL for the embeddable widget" },
  ]}
/>

### Error Responses

<ErrorTable
  rows={[
    { code: "RAMP_CONFIG_FAILED", status: "500", message: "Failed to retrieve configuration" },
  ]}
/>

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
curl https://api.zenpayz.com/payment/api/v1/on-ramp/config
```

  </TabItem>
  <TabItem value="javascript" label="JavaScript">

```javascript
const response = await fetch('https://api.zenpayz.com/payment/api/v1/on-ramp/config');
const { data } = await response.json();

console.log(data.integrationMode); // "api"
console.log(data.supportsBuy);     // true
```

  </TabItem>
  <TabItem value="python" label="Python">

```python
import requests

response = requests.get("https://api.zenpayz.com/payment/api/v1/on-ramp/config")
data = response.json()["data"]

print(data["integrationMode"])  # "api"
print(data["supportsBuy"])      # True
```

  </TabItem>
</Tabs>

</CodeRail>

## Next Steps

- [Supported Assets](/docs/rest-api/endpoints/ramp/supported-assets) -- Get available currencies
- [Buy Quotes](/docs/rest-api/endpoints/ramp/buy-quotes) -- Get buy quotes
- [Widget URL](/docs/rest-api/endpoints/ramp/widget-url) -- Generate a widget URL
