public.onramps

Get Onramp

Retrieves a single onramp by ID for the authenticated merchant. Returns both temporary and permanent onramps.

get/v1/onramps/{id}

Path parameters

idstring required

Onramp ID (UUID format)

Response

amountstring

created_atstring

currencystring

customer_idstring

idstring

provisioning_status'PENDING' | 'ACTIVE' | 'FAILED'

rate_expires_atstring

rate_idstring

type'TEMPORARY' | 'PERMANENT'

Example response

{
  "amount": "50000.50",
  "created_at": "2025-01-05T15:04:05Z",
  "currency": "NGN",
  "customer_id": "650e8400-e29b-41d4-a716-446655440000",
  "developer_fee": {
    "percentage": "1.5"
  },
  "id": "750e8400-e29b-41d4-a716-446655440000",
  "provisioning_status": "ACTIVE",
  "rate_expires_at": "2025-01-05T15:04:05Z",
  "rate_id": "550e8400-e29b-41d4-a716-446655440000",
  "settlement": {
    "asset": "USDC",
    "chain": "BASE",
    "destination_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "mode": "ONCHAIN"
  },
  "type": "PERMANENT",
  "virtual_account": {
    "account_name": "Daya-John Doe",
    "account_number": "1234567890",
    "bank_name": "Wema Bank",
    "expires_at": "2025-01-05T16:04:05Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.