Skip to main content
GET
List onramps

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

default to 10, maximum to 100

Required range: 1 <= x <= 100
startingAfter
string

Return records after this cursor.

endingBefore
string

Return records before this cursor.

sourceUserId
string

Filter by the public ID of the funding (source) user (prefixed with usr_).

destinationUserId
string

Filter by the public ID of the receiving (destination) user (prefixed with usr_).

status
enum<string>

Filter by onramp status. Lifecycle status of the onramp transaction.

Available options:
NOT_INITIATED,
CREATED,
OPEN_QUOTE,
IN_REVIEW,
FIAT_INITIATED,
AWAITING_FUNDS,
FIAT_PENDING,
FIAT_PROCESSED,
CRYPTO_INITIATED,
CRYPTO_PENDING,
COMPLETED,
FIAT_FAILED,
FIAT_RETURNED,
CRYPTO_FAILED,
QUOTE_FAILED,
EXPIRED,
UNKNOWN,
CANCELLED
Example:

"AWAITING_FUNDS"

Response

A cursor-paginated list of onramps.

Cursor-paginated list of onramps.

data
object[]
pagination
object