> For the complete documentation index, see [llms.txt](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-on-ramp/get-minimum-amount.md).

# Get Minimum On-Ramp Amount

Get the minimum on-ramp amount for a fiat currency.

Returns the minimum fiat amount required to initiate an on-ramp transaction for a given currency.

## Endpoint

```
GET /v1/onramp/minimum-amount/:currency
```

## Authentication

| Header          | Value        |
| --------------- | ------------ |
| `Authorization` | Your API key |

## Path parameters

| Parameter  | Type   | Description                                    |
| ---------- | ------ | ---------------------------------------------- |
| `currency` | string | Fiat currency code (e.g., `NGN`, `KES`, `ZAR`) |

## Example request

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X GET https://ramp-api.ivorypay.io/api/v1/onramp/minimum-amount/NGN \
  -H "Authorization: your_api_key"
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const response = await fetch(
  "https://ramp-api.ivorypay.io/api/v1/onramp/minimum-amount/NGN",
  {
    method: "GET",
    headers: {
      "Authorization": "your_api_key",
    },
  }
);

const data = await response.json();
console.log(data);
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/onramp/minimum-amount/NGN",
    headers={
        "Authorization": "your_api_key",
    },
)

print(response.json())
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/onramp/minimum-amount/NGN", nil)
	req.Header.Set("Authorization", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}
```

{% endtab %}
{% endtabs %}

## Example response

```json
{
  "success": true,
  "message": "Query successful",
  "data": {
    "currency": "NGN",
    "minimumAmount": 1000
  }
}
```

{% hint style="info" %}
Minimum amounts vary by currency and may change. Always check before initiating a transaction.
{% endhint %}