Get On-Ramp Status

Check the status of a fiat on-ramp order

GET /v1/onramp/status

Check on-ramp order status

cURL

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

200 Completed

{
  "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
    }
  }
}

Returns the current status of a fiat-to-crypto on-ramp order.

orderUid · string · required

The order UID returned from the checkout endpoint.

200 Completed

{
  "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
    }
  }
}

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

TypeScript

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);
}

Authorizations

X-API-Key · string · header · required

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

Query Parameters

orderUid · string · required

The order UID returned from checkout

Response

200

application/json

Order status

data · object · required

Response payload (null on error)

Show child attributes

error · object · required

Show child attributes

meta · object · required

Show child attributes