public.onramps

List Onramps

Lists all onramps for the authenticated merchant with optional filtering by type and pagination

get/v1/onramps

Query parameters

limitinteger

Number of results per page (default: 50, max: 200)

pageinteger

Page number (default: 1)

type'TEMPORARY' | 'PERMANENT'

Filter by onramp type

account_numberstring

Filter by active virtual account number

Response

limitinteger

pageinteger

totalinteger

total_pagesinteger

Example response

{
  "data": [
    {
      "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.