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)
{
  "payment_id": "<string>",
  "output_amount_delivered": "<string>",
  "delivery_tx_hash": "<string>",
  "destination_address": "<string>",
  "updated_at": "<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.