Skip to main content
GET
Get an on-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

onRampId
string
required

The on-ramp ID

Pattern: ^[0-9a-fA-F]{24}$
Example:

"6aeeb7b3d7558672d5262d1b"

Response

Response for status 200

id
string
required

Unique on-ramp identifier

Example:

"6aeeb7b3d7558672d5262d1b"

status
enum<string>
required
Available options:
awaiting_payment,
processing,
partially_delivered,
completed,
cancelled,
failed,
reversed,
refunded,
in_review
createdAt
string<date-time>
required
input
object
required
fees
object
required
source
object | null
required

Where the fiat for this on-ramp originated. Present when the on-ramp was funded by debiting a linked funding source (ACH debit); null when funds were pushed from an external bank account (ach_credit, wire, sepa_credit_transfer).

cancellable
boolean
required

Whether this on-ramp can be cancelled now. Only ACH-debit on-ramps qualify, and only before the bank debit is transmitted and before any crypto is released; cancel with POST /v1/deposits/{source.depositId}/cancel. Advisory: the cancel call re-checks and may still refuse.

output
object
deliverySummary
object
deliveries
object[]
completedAt
string<date-time>