Skip to main content
GET
/
v1
/
ramp-requests
List all ramp requests
curl --request GET \
  --url https://api-fundflow-qa.venly.io/v1/ramp-requests \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "pagination": {
    "pageNumber": 123,
    "pageSize": 123,
    "numberOfElements": 123,
    "numberOfPages": 123,
    "hasNextPage": true,
    "hasPreviousPage": true
  },
  "sort": {
    "orders": [
      "ASC"
    ]
  },
  "result": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paymentReference": "<string>",
      "rampType": "ON_RAMP",
      "status": "AWAITING_APPROVAL",
      "fiatAmount": 123,
      "fiatCurrency": "<string>",
      "cryptoAmount": 123,
      "cryptoCurrency": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>"
    }
  ]
}

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[]