Skip to main content
GET
Legacy: List onramps

Overview

Retrieve onramps through the legacy compatibility route. New integrations should use GET /v1/funding-accounts with rail=NGN_VIRTUAL_ACCOUNT.

Authentication

X-Api-Key
string
required
Your merchant API key

Query Parameters

type
string
Filter by onramp typeAllowed values: TEMPORARY, PERMANENT
page
integer
Page number (1-indexed)Default: 1
limit
integer
Results per pageDefault: 50Max: 200

Request Examples

Response

data
array
required
Array of onramp objects
total
integer
required
Total number of onramps matching filters
page
integer
required
Current page number
limit
integer
required
Results per page
total_pages
integer
required
Total number of pages

Success Response

Error Responses

Next Steps

Get Onramp

Get a specific onramp by ID

Create Onramp

Create a new onramp