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

# Get Defaults

Returns recommended default currencies, amounts, and payment methods per country.

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

## 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.
:::

### Query Parameters

<ParamTable
  rows={[
    { name: "type", type: "string", desc: "`buy` or `sell` (default: `buy`)" },
    { name: "country", type: "string", desc: "ISO country code (e.g. `US`)" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "message": {
      "recommended": {
        "amount": 300,
        "paymentMethod": "debitcard",
        "source": "USD",
        "target": "BTC",
        "country": "us"
      },
      "defaults": {
        "us": {
          "amount": 300,
          "paymentMethod": "debitcard",
          "source": "USD",
          "target": "BTC"
        }
      }
    }
  },
  "message": "Defaults retrieved"
}
```

### Error Responses

<ErrorTable
  rows={[
    { code: "RAMP_DEFAULTS_FAILED", status: "500", message: "Failed to get defaults" },
  ]}
/>

<CodeRail>

## Examples

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

```bash
curl "https://api.zenpayz.com/payment/api/v1/on-ramp/defaults?type=buy&country=US"
```

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

```javascript
const response = await fetch(
  'https://api.zenpayz.com/payment/api/v1/on-ramp/defaults?type=buy&country=US'
);
const { data } = await response.json();

const { amount, paymentMethod, source, target } = data.message.recommended;
console.log(`Default: ${amount} ${source} → ${target} via ${paymentMethod}`);
```

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

```python
import requests

response = requests.get(
    "https://api.zenpayz.com/payment/api/v1/on-ramp/defaults",
    params={"type": "buy", "country": "US"},
)
recommended = response.json()["data"]["message"]["recommended"]
print(f"Default: {recommended['amount']} {recommended['source']} → {recommended['target']}")
```

  </TabItem>
</Tabs>

</CodeRail>

## Next Steps

- [Buy Quotes](/docs/rest-api/endpoints/ramp/buy-quotes) -- Get quotes using these defaults
- [Supported Assets](/docs/rest-api/endpoints/ramp/supported-assets) -- See all available currencies
