Skip to main content
GET
Get an onramp order

Headers

x-api-key
string

Integrator API key: the project’s orders

authorization
string

Customer bearer from POST /compliance/sessions: that customer’s orders, and every order on its bound account

Example:

"Bearer eyJhbGciOi..."

Path Parameters

id
string
required

Order id, provider order id, checkout reference, or legacy <account>:<reference>

Pattern: ^[A-Za-z0-9._:-]{1,128}$

Response

The order

id
string<uuid>
required
provider
enum<string>
required
Available options:
noah,
swapped
kind
enum<string>
required
Available options:
fiat,
exchange
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
refunded
terminal
boolean
required

No stage will change again

stages
object
required
rail
object
required

provider_selected / unknown when the provider did not say

fiat
object
required

Each figure in a fixed currency; null when the provider did not state it

crypto
object | null
required
account
string
required

Ethereum address (0x followed by 40 hex characters)

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"

deliveryAddress
string | null
required

Ethereum address (0x followed by 40 hex characters)

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"

deliveryChain
string | null
required

CAIP-2 chain of the delivery, e.g. eip155:8453

providerStatus
string
required

The provider’s own status; informational

createdAt
string<date-time>
required

When the provider says the order began

updatedAt
string<date-time>
required