Skip to main content
GET
Get an on-ramp

Authorizations

Authorization
string
header
required

Cognito JWT token for regular user authentication

Path Parameters

onRampId
string
required

The on-ramp ID

Example:

"onramp_xyz789"

Response

Response for status 200

id
string
required

Unique on-ramp identifier

Example:

"onramp_xyz789"

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).

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