Skip to main content
GET
List all ramp requests
Returns ramp requests for your company with optional filtering by rampType, status, date range, and paymentReference, plus sorting and pagination. Concept guide: Transactions

Authorizations

Authorization
string
header
required

OAuth2 authentication via Venly Identity Platform

Query Parameters

rampType
enum<string>

Filter by ramp type (ON_RAMP for fiat-to-crypto, OFF_RAMP for crypto-to-fiat)

Available options:
ON_RAMP,
OFF_RAMP
status
enum<string>

Filter by request status

Available options:
AWAITING_APPROVAL,
AWAITING_FUNDS,
PROCESSING,
SUCCEEDED,
FAILED,
BLOCKED,
DENIED,
REJECTED,
CANCELLED
fromDate
string<date>

Filter requests created on or after this date (inclusive)

toDate
string<date>

Filter requests created on or before this date (inclusive)

paymentReference
string

Filter by payment reference (auto-generated unique identifier)

sortOn
string

Field name to sort by

sortOrder
enum<string>
default:ASC

Sort direction

Available options:
ASC,
DESC
page
integer<int32>
default:1

Page number (1-based indexing)

Required range: x >= 1
size
integer<int32>
default:100

Number of items per page

Required range: x >= 1

Response

Successfully retrieved ramp requests

success
boolean
default:true
pagination
object

Pagination metadata

sort
object

Sort configuration

result
object[]