Skip to main content
GET
Get On-Ramp Purchase

Authorizations

X-API-Key
string
header
default:sk_your_secret_key_here
required

Your partner secret key (server-side only)

Headers

X-Request-Id
string<uuid>

UUID for request tracing. Para returns one if omitted.

Path Parameters

purchaseId
string<uuid>
required

Para on-ramp purchase id — the purchaseId carried on the ONRAMP_LAUNCHED SDK event when the ramp launched, and on the onramp.completed webhook when it settled.

Response

On-ramp purchase record

status
enum<string>
required

Lifecycle state. INITIATED = created, not yet settled. FINISHED = the provider confirmed delivery (this is when onramp.completed fires). CANCELLED = the purchase will not settle. Treat unknown status values as non-terminal — future versions may add states.

Available options:
INITIATED,
CANCELLED,
FINISHED
userId
string<uuid>
required
purchaseId
string<uuid>
required

Para's id for this purchase.

provider
enum<string>
required

The provider that fulfilled the purchase. Coinbase Apple Pay reports as COINBASE; the surface is conveyed by paymentMethod.

Available options:
COINBASE,
MOONPAY,
RAMP,
STRIPE
transactionHash
string | null
required

On-chain hash of the crypto delivered to the user. null until settled, and also null when the provider settled without reporting one.

asset
object
required

The delivered token, resolved from the catalog. Fields are best-effort; an empty object means the token could not be resolved.

testMode
boolean
required

Whether this was a test purchase. Test purchases run a real quote but are never charged — filter them out of production accounting.

completedAt
string<date-time> | null
required

When the purchase was marked settled. null unless status is FINISHED.

paymentMethod
enum<string>

Checkout style used.

Available options:
WIDGET,
APPLE_PAY
assetQuantity
string

Crypto amount delivered, as a decimal token amount.

fiatAmount
string
fiatCurrency
string
Example:

"USD"

walletId
string<uuid> | null

Set when the crypto landed in a Para wallet; absent for a raw external-address destination.

destinationAddress
string | null

The on-chain address the crypto was delivered to.