Skip to main content
GET
/
v2
/
onramp
/
status
Python (SDK)
from compass_api_sdk import CompassAPI


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.onramp.onramp_status(payment_id="<id>")

    # Handle response
    print(res)
import { CompassApiSDK } from "@compass-labs/api-sdk";

const compassApiSDK = new CompassApiSDK({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
const result = await compassApiSDK.onramp.onrampStatus({
paymentId: "<id>",
});

console.log(result);
}

run();
curl --request GET \
--url https://api.compasslabs.ai/v2/onramp/status \
--header 'x-api-key: <api-key>'
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.compasslabs.ai/v2/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.compasslabs.ai/v2/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.compasslabs.ai/v2/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.compasslabs.ai/v2/onramp/status")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.compasslabs.ai/v2/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
{
  "payment_id": "<string>",
  "output_amount_delivered": "<string>",
  "delivery_tx_hash": "<string>",
  "destination_address": "<string>",
  "updated_at": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

payment_id
string
required

The payment_id returned by POST /v2/onramp/create.

Response

Successful Response

Current state of a fiat on-ramp payment.

Re-read on demand from Halliday (the system of record) — Compass holds no state of its own.

payment_id
string
required

Halliday's payment id, echoed straight through.

status
enum<string>
required

Lifecycle state: pending (awaiting card payment), processing (payment received, bridging/swapping to USDC), delivered (USDC received in the destination wallet), or failed.

Available options:
pending,
processing,
delivered,
failed
output_amount_delivered
string | null

USDC delivered so far, human-readable. Set once delivered.

delivery_tx_hash
string | null

Ethereum tx hash of the USDC delivery, once available.

destination_address
string | null

The wallet the USDC is delivered to.

updated_at
string | null

ISO-8601 timestamp of the last status change, if provided.