Skip to main content
GET
Get an off-ramp

Authorizations

Authorization
string
header
required

User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.

Path Parameters

offRampId
string
required

The off-ramp ID

Example:

"6a9fee5c215e5530b3530e7e"

Response

Response for status 200

id
string
required

Unique off-ramp identifier

Example:

"6a99b80613a0c37251651788"

quoteId
string | null
required

The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote.

Example:

"6a99b7bacc18094dfe644ba6"

status
enum<string>
required
Available options:
awaiting_funding,
queued,
in_flight,
completed,
canceled,
failed,
reversed,
refunded
createdAt
string<date-time>
required
completedAt
string<date-time> | null
required

When the off-ramp was completed. Null until status is completed.

input
object | null
required

What the user paid — crypto asset and chain.

output
object
required

What the destination receives — fiat delivery details.

fiatDestination
enum<string> | null
required

Type of fiat destination.

  • bank_account: Bank account (includes debit card destinations).
  • bill: Bill payment.
  • crypto_card: Crypto card deposit.
Available options:
bank_account,
bill,
crypto_card,
null
Example:

"bank_account"

fees
object | null
required
transaction
object | null
required