Skip to main content
GET
Legacy: Retrieve an onramp

Overview

Retrieve an onramp through the legacy compatibility route. New integrations should use GET /v1/funding-accounts/{id}.

Authentication

X-Api-Key
string
required
Your merchant API key

Path Parameters

id
string
required
Onramp ID (UUID format)Example: 750e8400-e29b-41d4-a716-446655440000

Request Examples

Response

id
string
required
Unique onramp identifier (UUID)
type
string
required
Onramp type: TEMPORARY or PERMANENT
customer_id
string
required
Associated customer ID (UUID)
provisioning_status
string
required
Virtual account provisioning status: PENDING, ACTIVE, or FAILED
amount
string
Expected deposit amount in NGN. Always present for temporary onramps (required at creation). Not present for permanent onramps. Decimal string.Example: "50000.50"
rate_id
string
Associated rate identifier (temporary onramps only)
rate_expires_at
string
When the locked rate expires (temporary onramps only)
developer_fee
object
required
Developer fee percentage used for deposits received through this onramp.
settlement
object
required
Settlement configuration
virtual_account
object
required
Virtual bank account details
created_at
string
required
When the onramp was created (ISO 8601 timestamp)

Success Responses

Next Steps

List Onramps

List all onramps with filters

List Deposits

View deposits for an onramp