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

x-api-key

Your API key

Path parameters

Parameter

Type

Description

currency

string

Fiat currency code (e.g., NGN, KES, GHS)

Example request

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

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

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

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("x-api-key", "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))
}

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "data": {
    "currency": "NGN",
    "minimumAmount": 1000
  }
}

Minimum amounts vary by currency and may change. Always check before initiating a transaction.

PreviousGet On-Ramp Status NextInitiate Off-Ramp (with Customer)

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagPath parameters

hashtagExample request

hashtagExample response

Endpoint

Authentication

Path parameters

Example request

Example response