> ## 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 onramp order



## OpenAPI

````yaml /openapi.yaml get /onramps/{orderId}
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:
  /onramps/{orderId}:
    get:
      tags:
        - Onramps
      summary: Get onramp order
      operationId: getOnramp
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
        - name: poll
          in: query
          schema:
            type: boolean
      responses:
        '200':
          $ref: '#/components/responses/OnrampOrder'
      security:
        - ApiKeyAuth: []
components:
  responses:
    OnrampOrder:
      description: Onramp order
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/SuccessEnvelope'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/OnrampOrder'
  schemas:
    SuccessEnvelope:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          nullable: true
    OnrampOrder:
      type: object
      properties:
        id:
          type: string
          format: uuid
        orderId:
          type: string
        customerId:
          type: string
        reference:
          type: string
        amount:
          type: string
        sourceCurrency:
          type: string
        amountToTransfer:
          type: string
        deposit:
          $ref: '#/components/schemas/OnrampBankAccount'
        destinationAddress:
          type: string
        destinationNetwork:
          type: string
        destinationCurrency:
          type: string
        destinationAddressType:
          type: string
          enum:
            - liquidation_address
            - main_wallet
        refundAccount:
          type: object
          properties:
            accountName:
              type: string
            accountIdentifier:
              type: string
            institution:
              type: string
        rate:
          type: string
        status:
          type: string
        settlementTxHash:
          type: string
        settledUsdcAmount:
          type: string
        settledAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    OnrampBankAccount:
      type: object
      properties:
        institution:
          type: string
        accountIdentifier:
          type: string
        accountName:
          type: string
        validUntil:
          type: string
          format: date-time
  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.

````