Skip to content
/
Ramps List

Ramps List

Request

Retrieve a paginated list of transfer orders (ramps).

Pagination Modes:

  • Cursor Pagination: Use startAfter, endBefore, or cursor parameters. Dates are optional.
  • Offset Pagination: Use page parameter. Dates (dateFrom and dateTo) are required.

Important: Cannot mix pagination types. Choose either cursor-based or offset-based pagination.

Use Cases:

  • Retrieve transaction history for reporting
  • Sync transactions to your system
  • Display transaction list to customers
  • Export transaction data
Security
HMACAuth
Query
perPageinteger, [ 1 .. 200 ]

Number of items per page.

Range: 1-200 Default: 10

Recommendation: Use smaller page sizes (10-50) for better performance.

Default:10
Example:perPage=25
pageinteger, >= 1

Page number for offset pagination (1-based).

Offset Pagination Mode:

  • Cannot be used with cursor parameters (startAfter, endBefore, cursor)
  • Requires dateFrom and dateTo when used
  • Returns total count and page information
  • Suitable for UI pagination with page numbers

Example: page=2&perPage=25&dateFrom=2024-01-01&dateTo=2024-12-31

Default:1
Example:page=2
startAfterstring, <= 255 characters

Cursor to start after (order key or ID). Returns orders after this cursor, excluding it.

Cursor Pagination Mode:

  • Cannot be used with endBefore or page
  • Dates are optional when using cursor pagination
  • More efficient for large datasets
  • Suitable for infinite scroll or "load more" patterns

Example: startAfter=ORD-2024-100&perPage=25

Example:startAfter=ORD-2024-100
endBeforestring, <= 255 characters

Cursor to end before (order key or ID). Returns orders before this cursor, excluding it.

Cursor Pagination Mode:

  • Cannot be used with startAfter or page
  • Dates are optional when using cursor pagination
  • Useful for reverse pagination

Example: endBefore=ORD-2024-200&perPage=25

Example:endBefore=ORD-2024-200
cursorstring, <= 255 characters

Generic cursor parameter for pagination (typically from previous response).

Usage:

  • Cannot be used with page
  • Dates are optional when using cursor pagination
  • Use nextCursor or prevCursor from previous response
  • Opaque string - do not parse or modify

Example: cursor=eyJvcmRlcnMuaWQiOjEyMzQ1fQ==

Example:cursor=eyJvcmRlcnMuaWQiOjEyMzQ1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9
dateFromstring, (date)

Start date filter (YYYY-MM-DD).

Requirements:

  • Required for offset pagination (when using page)
  • Optional for cursor pagination (when using startAfter, endBefore, or cursor)

Validation:

  • Must be valid date in YYYY-MM-DD format
  • Cannot be in the future
  • Must be <= dateTo if both provided
Example:dateFrom=2024-01-01
dateTostring, (date)

End date filter (YYYY-MM-DD). Must be >= dateFrom if provided.

Requirements:

  • Required for offset pagination (when using page)
  • Optional for cursor pagination (when using startAfter, endBefore, or cursor)

Validation:

  • Must be valid date in YYYY-MM-DD format
  • Must be >= dateFrom
  • Cannot be in the future
Example:dateTo=2024-12-31
curl -i -X GET \
  'https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/ramps?perPage=25&page=2&startAfter=ORD-2024-100&endBefore=ORD-2024-200&cursor=eyJvcmRlcnMuaWQiOjEyMzQ1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9&dateFrom=2024-01-01&dateTo=2024-12-31' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful response with paginated ramps list.

Response Structure:

  • data: Array of ramp objects
  • pagination: Pagination metadata (cursor or offset based)

Pagination Metadata:

  • Cursor mode: nextCursor, prevCursor, hasMore, perPage
  • Offset mode: currentPage, perPage, total, lastPage, from, to
Bodyapplication/json
dataArray of objects(Ramps Data)required

Array of ramp transaction objects

paginationCursor Pagination (object) or Offset Pagination (object)(Pagination Metadata)required
One of:

Cursor-based pagination metadata.

Advantages:

  • More efficient for large datasets
  • Consistent results even when data changes
  • Suitable for infinite scroll patterns

Usage:

  • Use nextCursor to fetch next page
  • Use prevCursor to fetch previous page
  • Check hasMore to determine if more results exist
Response
Example response using cursor-based pagination. Use nextCursor for next page.
{
  "data": [
    { … }
  ],
  "pagination": {
    "nextCursor": "eyJvcmRlcnMuaWQiOjEyMzQ1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
    "prevCursor": null,
    "hasMore": true,
    "perPage": 10
  }
}
© Banxa 2026