> ## Documentation Index
> Fetch the complete documentation index at: https://docs.daya.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Legacy: Retrieve an onramp

> Legacy route for retrieving an NGN receive flow

## Overview

Retrieve an onramp through the legacy compatibility route. New integrations should use [`GET /v1/funding-accounts/{id}`](/api-reference/funding-accounts/get-funding-account).

## Authentication

<ParamField header="X-Api-Key" type="string" required>
  Your merchant API key
</ParamField>

## Path Parameters

<ParamField path="id" type="string" required>
  Onramp ID (UUID format)

  **Example:** `750e8400-e29b-41d4-a716-446655440000`
</ParamField>

## Request Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url https://api.daya.co/v1/onramps/750e8400-e29b-41d4-a716-446655440000 \
    --header 'X-Api-Key: YOUR_API_KEY'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://api.daya.co/v1/onramps/750e8400-e29b-41d4-a716-446655440000',
    {
      headers: {
        'X-Api-Key': 'YOUR_API_KEY'
      }
    }
  );
  const onramp = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.daya.co/v1/onramps/750e8400-e29b-41d4-a716-446655440000',
      headers={'X-Api-Key': 'YOUR_API_KEY'}
  )
  onramp = response.json()
  ```
</CodeGroup>

## Response

<ResponseField name="id" type="string" required>
  Unique onramp identifier (UUID)
</ResponseField>

<ResponseField name="type" type="string" required>
  Onramp type: `TEMPORARY` or `PERMANENT`
</ResponseField>

<ResponseField name="customer_id" type="string" required>
  Associated customer ID (UUID)
</ResponseField>

<ResponseField name="provisioning_status" type="string" required>
  Virtual account provisioning status: `PENDING`, `ACTIVE`, or `FAILED`
</ResponseField>

<ResponseField name="amount" type="string">
  Expected deposit amount in NGN. Always present for temporary onramps (required at creation). Not present for permanent onramps. Decimal string.

  **Example:** `"50000.50"`
</ResponseField>

<ResponseField name="rate_id" type="string">
  Associated rate identifier (temporary onramps only)
</ResponseField>

<ResponseField name="rate_expires_at" type="string">
  When the locked rate expires (temporary onramps only)
</ResponseField>

<ResponseField name="developer_fee" type="object" required>
  Developer fee percentage used for deposits received through this onramp.

  <Expandable title="developer_fee properties">
    <ResponseField name="developer_fee.percentage" type="string">
      Configured percentage as a decimal string.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="settlement" type="object" required>
  Settlement configuration

  <Expandable title="settlement properties">
    <ResponseField name="settlement.mode" type="string">
      Settlement mode: `ONCHAIN` or `INTERNAL_BALANCE`
    </ResponseField>

    <ResponseField name="settlement.asset" type="string">
      Asset type: `USDC` or `USDT`
    </ResponseField>

    <ResponseField name="settlement.chain" type="string">
      Blockchain network
    </ResponseField>

    <ResponseField name="settlement.destination_address" type="string">
      On-chain destination address
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="virtual_account" type="object" required>
  Virtual bank account details

  <Expandable title="virtual_account properties">
    <ResponseField name="virtual_account.account_number" type="string">
      Virtual account number
    </ResponseField>

    <ResponseField name="virtual_account.account_name" type="string">
      Account name
    </ResponseField>

    <ResponseField name="virtual_account.bank_name" type="string">
      Bank name
    </ResponseField>

    <ResponseField name="virtual_account.expires_at" type="string">
      When the virtual account expires (temporary onramps only)
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="created_at" type="string" required>
  When the onramp was created (ISO 8601 timestamp)
</ResponseField>

### Success Responses

<ResponseExample>
  ```json 200 OK - Permanent Onramp theme={null}
  {
    "id": "750e8400-e29b-41d4-a716-446655440000",
    "type": "PERMANENT",
    "customer_id": "650e8400-e29b-41d4-a716-446655440000",
    "provisioning_status": "ACTIVE",
    "developer_fee": {
      "percentage": "2.5"
    },
    "settlement": {
      "mode": "ONCHAIN",
      "asset": "USDC",
      "chain": "BASE",
      "destination_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"
    },
    "virtual_account": {
      "account_number": "1234567890",
      "account_name": "Daya-John Doe",
      "bank_name": "Wema Bank"
    },
    "created_at": "2026-01-10T12:00:00Z"
  }
  ```

  ```json 200 OK - Temporary Onramp theme={null}
  {
    "id": "850e8400-e29b-41d4-a716-446655440000",
    "type": "TEMPORARY",
    "customer_id": "660e8400-e29b-41d4-a716-446655440000",
    "provisioning_status": "ACTIVE",
    "amount": "50000.50",
    "rate_id": "550e8400-e29b-41d4-a716-446655440000",
    "rate_expires_at": "2026-01-14T15:30:00Z",
    "developer_fee": {
      "percentage": "2.5"
    },
    "settlement": {
      "mode": "ONCHAIN",
      "asset": "USDC",
      "chain": "SOLANA",
      "destination_address": "7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV"
    },
    "virtual_account": {
      "account_number": "9876543210",
      "account_name": "Daya - user@example.com",
      "bank_name": "Wema Bank",
      "expires_at": "2026-01-14T15:30:00Z"
    },
    "created_at": "2026-01-14T15:05:00Z"
  }
  ```

  ```json 400 Bad Request theme={null}
  {
    "error": {
      "code": "BAD_REQUEST",
      "message": "Invalid onramp ID format",
      "request_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "error": {
      "code": "NOT_FOUND",
      "message": "Onramp not found",
      "request_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
  ```
</ResponseExample>

## Next Steps

<CardGroup cols={2}>
  <Card title="List Onramps" icon="list" href="/api-reference/onramp/list-onramps">
    List all onramps with filters
  </Card>

  <Card title="List Deposits" icon="money-bill" href="/api-reference/deposits/list-deposits">
    View deposits for an onramp
  </Card>
</CardGroup>