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

# Get NGN rails temporary VA onramp

> Requires `transfers:read`. Syncs StRails onramp status on read by default. Response includes live `sweep` (temp vs main wallet balances / consolidate eligibility).



## OpenAPI

````yaml /openapi.yaml get /rails/onramps/{id}
openapi: 3.1.0
info:
  title: Remitflex API
  version: 1.0.0
  description: >
    Programmatic access to Remitflex payment routes, fiat rates, customers, and
    transactions.


    **Dashboard:** Create API keys at https://dashboard.remitflex.io


    **Authentication:** Send your API key as `Authorization: Bearer
    rmf_live_...` or `rmf_test_...`.


    **Idempotency:** Mutating requests (`POST`, `PUT`, `PATCH`, `DELETE`)
    require an `Idempotency-Key` header when authenticated with an API key.
servers:
  - url: http://localhost:4000/v1
    description: Local development
  - url: https://api.remitflex.io/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /rails/onramps/{id}:
    get:
      tags:
        - NGN rails
      summary: Get NGN rails temporary VA onramp
      description: >-
        Requires `transfers:read`. Syncs StRails onramp status on read by
        default. Response includes live `sweep` (temp vs main wallet balances /
        consolidate eligibility).
      operationId: getRailsOnramp
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: sync
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
              - '0'
              - '1'
      responses:
        '200':
          description: Rails onramp fetched
        '404':
          description: Not found
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >
        API key created in the Remitflex Dashboard at dashboard.remitflex.io
        (`rmf_live_...` or `rmf_test_...`).

        Key management endpoints require a dashboard JWT and are not part of
        this reference.

````