Check on-ramp order status
curl --request GET \
--url https://api.hypermid.io/v1/onramp/status \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hypermid.io/v1/onramp/status"
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/status', 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/status",
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/status"
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/status")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hypermid.io/v1/onramp/status")
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": {
"orderUid": "ord_abc123def456",
"status": "COMPLETED",
"fiatCurrency": "USD",
"fiatAmount": 100,
"cryptoAsset": "ETH",
"cryptoAmount": "0.029615",
"chainId": 1,
"walletAddress": "0xYourAddress",
"txHash": "0xOnrampTxHash",
"paymentMethod": "credit_card",
"createdAt": 1711234578,
"completedAt": 1711234878
},
"error": null,
"meta": {
"requestId": "s9b0c1d2-e3f4-5678-2345-789012345678",
"timestamp": 1711234880,
"rateLimit": {
"limit": 2000,
"remaining": 1981,
"reset": 1711234927
}
}
}
{
"data": {
"orderUid": "ord_abc123def456",
"status": "PAYMENT_RECEIVED",
"fiatCurrency": "USD",
"fiatAmount": 100,
"cryptoAsset": "ETH",
"cryptoAmount": null,
"chainId": 1,
"walletAddress": "0xYourAddress",
"txHash": null,
"paymentMethod": "credit_card",
"createdAt": 1711234578,
"completedAt": null
},
"error": null,
"meta": {
"requestId": "t0c1d2e3-f4a5-6789-3456-890123456789",
"timestamp": 1711234680,
"rateLimit": {
"limit": 2000,
"remaining": 1980,
"reset": 1711234727
}
}
}
On-Ramp
Get On-Ramp Status
Check the status of a fiat on-ramp order
GET
/
v1
/
onramp
/
status
Check on-ramp order status
curl --request GET \
--url https://api.hypermid.io/v1/onramp/status \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hypermid.io/v1/onramp/status"
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/status', 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/status",
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/status"
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/status")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hypermid.io/v1/onramp/status")
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": {
"orderUid": "ord_abc123def456",
"status": "COMPLETED",
"fiatCurrency": "USD",
"fiatAmount": 100,
"cryptoAsset": "ETH",
"cryptoAmount": "0.029615",
"chainId": 1,
"walletAddress": "0xYourAddress",
"txHash": "0xOnrampTxHash",
"paymentMethod": "credit_card",
"createdAt": 1711234578,
"completedAt": 1711234878
},
"error": null,
"meta": {
"requestId": "s9b0c1d2-e3f4-5678-2345-789012345678",
"timestamp": 1711234880,
"rateLimit": {
"limit": 2000,
"remaining": 1981,
"reset": 1711234927
}
}
}
{
"data": {
"orderUid": "ord_abc123def456",
"status": "PAYMENT_RECEIVED",
"fiatCurrency": "USD",
"fiatAmount": 100,
"cryptoAsset": "ETH",
"cryptoAmount": null,
"chainId": 1,
"walletAddress": "0xYourAddress",
"txHash": null,
"paymentMethod": "credit_card",
"createdAt": 1711234578,
"completedAt": null
},
"error": null,
"meta": {
"requestId": "t0c1d2e3-f4a5-6789-3456-890123456789",
"timestamp": 1711234680,
"rateLimit": {
"limit": 2000,
"remaining": 1980,
"reset": 1711234727
}
}
}
Returns the current status of a fiat-to-crypto on-ramp order.
The order UID returned from the checkout endpoint.
{
"data": {
"orderUid": "ord_abc123def456",
"status": "COMPLETED",
"fiatCurrency": "USD",
"fiatAmount": 100,
"cryptoAsset": "ETH",
"cryptoAmount": "0.029615",
"chainId": 1,
"walletAddress": "0xYourAddress",
"txHash": "0xOnrampTxHash",
"paymentMethod": "credit_card",
"createdAt": 1711234578,
"completedAt": 1711234878
},
"error": null,
"meta": {
"requestId": "s9b0c1d2-e3f4-5678-2345-789012345678",
"timestamp": 1711234880,
"rateLimit": {
"limit": 2000,
"remaining": 1981,
"reset": 1711234927
}
}
}
{
"data": {
"orderUid": "ord_abc123def456",
"status": "PAYMENT_RECEIVED",
"fiatCurrency": "USD",
"fiatAmount": 100,
"cryptoAsset": "ETH",
"cryptoAmount": null,
"chainId": 1,
"walletAddress": "0xYourAddress",
"txHash": null,
"paymentMethod": "credit_card",
"createdAt": 1711234578,
"completedAt": null
},
"error": null,
"meta": {
"requestId": "t0c1d2e3-f4a5-6789-3456-890123456789",
"timestamp": 1711234680,
"rateLimit": {
"limit": 2000,
"remaining": 1980,
"reset": 1711234727
}
}
}
Status Values
| Status | Description |
|---|---|
CREATED | Checkout session created, waiting for user action |
PENDING | Payment is being processed |
PAYMENT_RECEIVED | Fiat payment confirmed, crypto transfer in progress |
CRYPTO_SENT | Crypto transaction submitted to the blockchain |
COMPLETED | Order fully completed |
FAILED | Order failed |
REFUNDED | Payment was refunded |
EXPIRED | Checkout session expired |
const status = await client.getOnrampStatus({
orderUid: "ord_abc123def456",
});
console.log("Status:", status.data.status);
if (status.data.status === "COMPLETED") {
console.log("Received:", status.data.cryptoAmount, status.data.cryptoAsset);
console.log("Tx:", status.data.txHash);
}
curl "https://api.hypermid.io/v1/onramp/status?orderUid=ord_abc123def456" \
-H "X-API-Key: your-api-key"
req, _ := http.NewRequest("GET",
"https://api.hypermid.io/v1/onramp/status?orderUid=ord_abc123def456", nil)
req.Header.Set("X-API-Key", "your-api-key")
resp, _ := http.DefaultClient.Do(req)
Authorizations
Partner API key. Optional for public endpoints, required for /v1/partner/*.
Query Parameters
The order UID returned from checkout
⌘I