Skip to content
Spritz API Docs

Get an on-ramp

GET
/v1/on-ramps/{onRampId}

Returns details for a specific on-ramp transaction.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
onRampId
required

The on-ramp ID

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Response for status 200

object
id
required

Unique on-ramp identifier

string
status
required
string
Allowed values: awaiting_payment processing completed cancelled refunded in_review
createdAt
required
string format: date-time
input
required
object
amount
required

Fiat amount sent (after fees)

string
currency
required
string
Allowed values: USD CAD EUR GBP
rail
required
string
Allowed values: ach_push wire_push sepa_push
fees
required
object
amount
required

Fee in source currency

string
currency
required

Currency of the fee paid

string
output
object
amount
required

Crypto amount received

string
token
required

Token received

string
network
required
string
Allowed values: ethereum polygon base arbitrum avalanche optimism solana tron bitcoin
address
required

Destination wallet address

string
txHash

Blockchain transaction hash

string
completedAt
string format: date-time

401

Section titled “401 ”

Response for status 401

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
realm

The authentication realm

string
scope

The required scope for this resource

string

404

Section titled “404 ”

Response for status 404

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
resourceType
required

The type of resource that was not found

string
resourceId
required

The identifier of the resource that was not found

string

500

Section titled “500 ”

Response for status 500

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string