Get On-Ramp Config

On-ramp supported chains and tokens

curl --request GET \
  --url https://api.hypermid.io/v1/onramp/config \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hypermid.io/v1/onramp/config"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hypermid.io/v1/onramp/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hypermid.io/v1/onramp/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.hypermid.io/v1/onramp/config"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hypermid.io/v1/onramp/config")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hypermid.io/v1/onramp/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "currencies": [
      { "code": "USD", "name": "US Dollar", "symbol": "$" },
      { "code": "EUR", "name": "Euro", "symbol": "\u20ac" },
      { "code": "GBP", "name": "British Pound", "symbol": "\u00a3" },
      { "code": "CAD", "name": "Canadian Dollar", "symbol": "C$" },
      { "code": "AUD", "name": "Australian Dollar", "symbol": "A$" },
      { "code": "CHF", "name": "Swiss Franc", "symbol": "CHF" }
    ],
    "paymentMethods": [
      {
        "id": "credit_card",
        "name": "Credit Card",
        "processingTime": "Instant",
        "feePercentage": 3.49
      },
      {
        "id": "debit_card",
        "name": "Debit Card",
        "processingTime": "Instant",
        "feePercentage": 2.99
      },
      {
        "id": "bank_transfer",
        "name": "Bank Transfer",
        "processingTime": "1-3 business days",
        "feePercentage": 1.49
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "u1d2e3f4-a5b6-7890-4567-901234567890",
    "timestamp": 1711234579,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1979,
      "reset": 1711234627
    }
  }
}

GET

onramp

config

On-ramp supported chains and tokens

curl --request GET \
  --url https://api.hypermid.io/v1/onramp/config \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hypermid.io/v1/onramp/config"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hypermid.io/v1/onramp/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hypermid.io/v1/onramp/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.hypermid.io/v1/onramp/config"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hypermid.io/v1/onramp/config")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hypermid.io/v1/onramp/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "currencies": [
      { "code": "USD", "name": "US Dollar", "symbol": "$" },
      { "code": "EUR", "name": "Euro", "symbol": "\u20ac" },
      { "code": "GBP", "name": "British Pound", "symbol": "\u00a3" },
      { "code": "CAD", "name": "Canadian Dollar", "symbol": "C$" },
      { "code": "AUD", "name": "Australian Dollar", "symbol": "A$" },
      { "code": "CHF", "name": "Swiss Franc", "symbol": "CHF" }
    ],
    "paymentMethods": [
      {
        "id": "credit_card",
        "name": "Credit Card",
        "processingTime": "Instant",
        "feePercentage": 3.49
      },
      {
        "id": "debit_card",
        "name": "Debit Card",
        "processingTime": "Instant",
        "feePercentage": 2.99
      },
      {
        "id": "bank_transfer",
        "name": "Bank Transfer",
        "processingTime": "1-3 business days",
        "feePercentage": 1.49
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "u1d2e3f4-a5b6-7890-4567-901234567890",
    "timestamp": 1711234579,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1979,
      "reset": 1711234627
    }
  }
}

Returns the available fiat currencies and payment methods for the on-ramp service.

{
  "data": {
    "currencies": [
      { "code": "USD", "name": "US Dollar", "symbol": "$" },
      { "code": "EUR", "name": "Euro", "symbol": "\u20ac" },
      { "code": "GBP", "name": "British Pound", "symbol": "\u00a3" },
      { "code": "CAD", "name": "Canadian Dollar", "symbol": "C$" },
      { "code": "AUD", "name": "Australian Dollar", "symbol": "A$" },
      { "code": "CHF", "name": "Swiss Franc", "symbol": "CHF" }
    ],
    "paymentMethods": [
      {
        "id": "credit_card",
        "name": "Credit Card",
        "processingTime": "Instant",
        "feePercentage": 3.49
      },
      {
        "id": "debit_card",
        "name": "Debit Card",
        "processingTime": "Instant",
        "feePercentage": 2.99
      },
      {
        "id": "bank_transfer",
        "name": "Bank Transfer",
        "processingTime": "1-3 business days",
        "feePercentage": 1.49
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "u1d2e3f4-a5b6-7890-4567-901234567890",
    "timestamp": 1711234579,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1979,
      "reset": 1711234627
    }
  }
}

const config = await client.getOnrampConfig();

console.log("Supported currencies:");
for (const currency of config.data.currencies) {
  console.log(`  ${currency.symbol} ${currency.code} - ${currency.name}`);
}

console.log("Payment methods:");
for (const method of config.data.paymentMethods) {
  console.log(`  ${method.name}: ${method.feePercentage}% fee, ${method.processingTime}`);
}

curl https://api.hypermid.io/v1/onramp/config \
  -H "X-API-Key: your-api-key"

req, _ := http.NewRequest("GET",
    "https://api.hypermid.io/v1/onramp/config", nil)
req.Header.Set("X-API-Key", "your-api-key")
resp, _ := http.DefaultClient.Do(req)

Authorizations

X-API-Key

string

header

required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Response

Config data

data

object

required

Response payload (null on error)

Show child attributes

error

object | null

required

Show child attributes

Overview

Discovery

Swap

On-Ramp

Partner

System

Get On-Ramp Config

Authorizations

Response