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

# Retrieve an Off-Ramp Order

> Returns a single off-ramp order by its `orderId`.

The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — `refundable`, `refundDestinationRequired`, `latestRefund`, `refundAddress` and `refundedTxnHash` — without paginating the whole list. That matters because a refund's progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See [Refunds](/ramps-api/refunds/overview).

Orders of a deactivated customer are not returned.



## OpenAPI

````yaml ramps-api/openapi.json GET /api/v1/offramp/{orderId}/
openapi: 3.1.0
info:
  title: Ripio Ramp API
  version: v1
  description: >-
    API for Ripio ramp services, enabling partners to integrate On-Ramp,
    Off-Ramp, customer management, KYC processes, and other financial
    functionalities. This API is RESTful, uses JSON for requests and responses,
    and standard HTTP status codes. This document is based on the
    'onramp-api.pdf' provided and aims to be compliant with OpenAPI
    Specification v3.1.0. The PDF indicates that the API documentation is a
    draft and subject to change.
servers:
  - url: https://skala-sandbox.ripio.com
    description: Sandbox environment
  - url: https://skala.ripio.com
    description: Production environment
security:
  - BearerToken: []
tags:
  - name: Authentication
    description: Operations related to API authentication and authorization.
  - name: Support Tickets
    description: >-
      Operations for raising and tracking customer support tickets with Ripio's
      support team. This feature must be enabled for your account by the Ripio
      team.
  - name: Customers
    description: Operations related to customer management.
  - name: KYC
    description: Operations related to Know Your Customer processes.
  - name: Fiat Accounts
    description: Operations related to managing fiat accounts and their requirements.
  - name: Quotes
    description: Operations related to obtaining and managing conversion quotes.
  - name: On-Ramp
    description: Operations related to fiat-to-crypto (on-ramp) processes.
  - name: Off-Ramp
    description: Operations related to crypto-to-fiat (off-ramp) processes.
  - name: Refunds
    description: >-
      Operations for returning the money of an on-ramp or off-ramp operation
      that could not be completed. Each ramp must be enabled for your account by
      the Ripio team.
  - name: Transactions
    description: Operations related to listing and managing all transaction types.
  - name: Networks
    description: >-
      Operations related to retrieving available deposit and withdrawal
      networks.
  - name: Rates
    description: Operations related to retrieving market rates.
  - name: Transaction Limits
    description: >-
      Operations related to retrieving per-transaction limits by currency and
      ramp operation.
  - name: Sandbox
    description: Operations specific to the sandbox environment for testing purposes.
  - name: Webhooks
    description: Webhook event notifications from Ripio Ramp API.
  - name: Sell and Pay
    description: >-
      Endpoints for managing Sell and Pay transactions, which allow customers to
      convert cryptocurrency to fiat currency and pay merchants via QR codes
paths:
  /api/v1/offramp/{orderId}/:
    get:
      tags:
        - Off-Ramp
      summary: Retrieve an Off-Ramp Order
      description: >-
        Returns a single off-ramp order by its `orderId`.


        The response is the same object the listing returns, so this is the
        cheapest way to re-read the refund fields of one order — `refundable`,
        `refundDestinationRequired`, `latestRefund`, `refundAddress` and
        `refundedTxnHash` — without paginating the whole list. That matters
        because a refund's progress and its rejection are only ever reported
        here: on this ramp only a completed refund emits a webhook event. See
        [Refunds](/ramps-api/refunds/overview).


        Orders of a deactivated customer are not returned.
      operationId: retrieveOffRampOrder
      parameters:
        - $ref: '#/components/parameters/OrderId'
      responses:
        '200':
          description: The off-ramp order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OffRampOrderTransactionDetail'
        '401':
          description: Unauthorized - Invalid or missing access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 40001
                type: NotAuthenticated
                detail:
                  message: Authentication credentials were not provided.
                  code: not_authenticated
                status: 401
        '404':
          description: >-
            Not Found - the order does not exist, is not an off-ramp order,
            belongs to another account, or its customer is deactivated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 40004
                type: NotFound
                detail:
                  message: Not found.
                  code: not_found
                status: 404
components:
  parameters:
    OrderId:
      name: orderId
      in: path
      required: true
      description: Unique identifier for the order.
      schema:
        type: string
        format: uuid
      example: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
  schemas:
    OffRampOrderTransactionDetail:
      type: object
      description: Details of an off-ramp transaction.
      properties:
        transactionId:
          type: string
          format: uuid
          description: Unique identifier for the off-ramp transaction.
        createdAt:
          type: string
          format: date-time
          description: Date and time the off-ramp transaction was created.
        customerId:
          type: string
          format: uuid
          description: Customer's unique identifier.
        quoteId:
          type: string
          format: uuid
          description: Reference to the original quote used for this transaction.
        fromCurrency:
          type: string
          description: The source cryptocurrency being off-ramped.
          example: USDC
        toCurrency:
          type: string
          description: The target fiat currency received.
          example: ARS
        amount:
          type: string
          description: The amount of the target currency transferred or to be transferred.
        chain:
          type: string
          description: The cryptocurrency blockchain for the deposit address.
          example: ETHEREUM
        metadata:
          type: object
          description: Additional metadata associated with the transaction.
          additionalProperties: true
          example: {}
        txnHash:
          type:
            - string
            - 'null'
          description: >-
            The transaction hash of the customer's incoming crypto deposit.
            `null` until the deposit is detected on-chain.
          example: null
        providerId:
          type: string
          description: >-
            The fiat withdrawal provider's transaction identifier. Available for
            completed Argentine off-ramp orders.
        finishedAt:
          type: string
          description: >-
            Date and time the fiat withdrawal was completed by the provider.
            Available for completed Argentine off-ramp orders.
        fiatAccountId:
          type: string
          format: uuid
          description: Identifier of the fiat account the payout is sent to.
        refundAddress:
          type:
            - string
            - 'null'
          description: The effective on-chain refund address for this order, if any.
        refundable:
          type: boolean
          description: >-
            Whether a [crypto refund](/ramps-api/refunds/request-crypto-refund)
            can be requested for this order right now. Computed per request, so
            use it to decide whether to call the refund endpoint instead of
            discovering it through a 400.
          example: false
        refundDestinationRequired:
          type:
            - boolean
            - 'null'
          description: >-
            Whether requesting a refund for this order requires naming a
            `refundAddress`. `false` means the crypto is returned to the
            deposit's on-chain origin address and an address is rejected. `null`
            when the order is not in refund territory.
          example: false
        latestRefund:
          anyOf:
            - $ref: '#/components/schemas/LatestCryptoRefund'
            - type: 'null'
          description: >-
            State of the most recent refund of this order's crypto deposit, or
            `null` if there never was one. On this ramp only a **completed**
            refund emits an event (`OFF-RAMP.ORDER.REFUNDED`), so this block is
            how progress is followed and the only way a rejection is ever read.
        refundedTxnHash:
          type:
            - string
            - 'null'
          description: On-chain hash of the crypto refund, once refunded. `null` otherwise.
          example: null
      required:
        - transactionId
        - createdAt
        - customerId
        - quoteId
        - fromCurrency
        - toCurrency
        - amount
        - chain
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Application-specific error code.
        type:
          type: string
          description: Type of error or exception.
        detail:
          type:
            - object
            - array
          description: >-
            Error details. The shape depends on the error:


            - Most business errors return an object with a `message` key.

            - Field validation errors return an object keyed by field name, each
            holding an array of `{ message, code }`.

            - Request-level validation errors (e.g. a missing query parameter)
            return a bare array of `{ message, code }`.
          properties:
            message:
              type: string
              description: Detailed error message.
          additionalProperties: true
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - type
        - detail
        - status
    LatestCryptoRefund:
      type: object
      description: State of the most recent crypto refund of the order's deposit.
      properties:
        refundId:
          type: string
          format: uuid
          description: Unique identifier of the refund.
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - REJECTED
            - FAILED
          description: >-
            Current state of the refund: `PENDING` (registered, not yet sent to
            the provider), `PROCESSING` (sent, awaiting confirmation),
            `COMPLETED` (the money reached its destination), `REJECTED` (the
            request was declined — see `rejectionReason` — and nothing was sent)
            or `FAILED` / `CANCELLED` (the attempt did not go through; contact
            Ripio support).
        rejectionReason:
          type: string
          enum:
            - ''
            - DUPLICATE_REQUEST
            - INVALID_DESTINATION
            - ALREADY_RESOLVED
            - NOT_ELIGIBLE
            - CONTACT_SUPPORT
          description: Why the request was declined. Empty unless `status` is `REJECTED`.
        initiatedBy:
          type: string
          enum:
            - PARTNER
            - WIDGET
            - OPS
          description: >-
            Which door the request came through: `PARTNER` (your API call),
            `WIDGET` (the end user, from the widget) or `OPS` (registered by
            Ripio's support team on the customer's behalf).
        requestedAt:
          type: string
          format: date-time
          description: When the refund was requested.
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtained via
        [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as
        `Authorization: Bearer <access_token>`.

````