> ## 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.

# List Off-Ramp Orders

> Retrieves a list of off-ramp orders, regardless of the session, with optional filtering by date range and pagination. Results are limited to active customers — orders belonging to deactivated customers are excluded.



## OpenAPI

````yaml ramps-api/openapi.json GET /api/v1/offramp/
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: 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/:
    get:
      tags:
        - Off-Ramp
      summary: List Off-Ramp Orders
      description: >-
        Retrieves a list of off-ramp orders, regardless of the session, with
        optional filtering by date range and pagination. Results are limited to
        active customers — orders belonging to deactivated customers are
        excluded.
      operationId: listOffRampOrders
      parameters:
        - $ref: '#/components/parameters/StartDate'
        - $ref: '#/components/parameters/EndDate'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: A paginated list of off-ramp orders.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOffRampOrderList'
        '400':
          description: Bad Request - e.g., invalid filter parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '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
components:
  parameters:
    StartDate:
      name: startDate
      in: query
      description: Filter orders/sessions created after this date (ISO 8601 format).
      required: false
      schema:
        type: string
        format: date-time
      example: '2024-01-26T12:45:00.078230Z'
    EndDate:
      name: endDate
      in: query
      description: Filter orders/sessions created before this date (ISO 8601 format).
      required: false
      schema:
        type: string
        format: date-time
      example: '2024-01-26T12:45:00.078230Z'
    Limit:
      name: limit
      in: query
      description: Maximum number of items to return.
      required: false
      schema:
        type: integer
        minimum: 1
        default: 100
      example: 100
    Offset:
      name: offset
      in: query
      description: Starting point to limit the total items to return (for pagination).
      required: false
      schema:
        type: integer
        minimum: 0
      example: 0
  schemas:
    PaginatedOffRampOrderList:
      type: object
      properties:
        count:
          type: integer
          description: Total number of items across all pages.
        next:
          type:
            - string
            - 'null'
          format: uri
          description: URL to the next page of results. Null if no next page.
        previous:
          type:
            - string
            - 'null'
          format: uri
          description: URL to the previous page of results. Null if no previous page.
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/OffRampOrderTransactionDetail'
          description: Array of Off-Ramp order objects for the current page.
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Application-specific error code.
        type:
          type: string
          description: Type of error or exception.
        detail:
          type: object
          properties:
            message:
              type: string
              description: Detailed error message.
          additionalProperties: true
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - type
        - detail
        - status
    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
        status:
          type: string
          description: >-
            The current transaction status (subset of OnRamp statuses, specific
            OffRamp statuses to be confirmed from full API spec if different).
        txnHash:
          type: string
          description: The transaction hash for the on-chain operation (crypto deposit).
        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.
      required:
        - transactionId
        - createdAt
        - customerId
        - quoteId
        - fromCurrency
        - toCurrency
        - amount
        - chain
        - status
  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>`.

````