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

# Create Off-Ramp Session

> Initiates an off-ramp session for a customer, specifying their fiat account. Returns session details and cryptocurrency deposit addresses.



## OpenAPI

````yaml ramps-api/openapi.json POST /api/v1/offrampSession/
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/offrampSession/:
    post:
      tags:
        - Off-Ramp
      summary: Create Off-Ramp Session
      description: >-
        Initiates an off-ramp session for a customer, specifying their fiat
        account. Returns session details and cryptocurrency deposit addresses.
      operationId: createOffRampSession
      requestBody:
        required: true
        description: Details for creating an off-ramp session.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OffRampSessionCreationRequest'
      responses:
        '201':
          description: Off-Ramp session created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OffRampSessionResponse'
        '400':
          description: >-
            Bad Request - e.g., invalid fiatAccountId, or user already has an
            active session.
          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
        '404':
          description: >-
            Not Found - e.g., Fiat Account not found or belongs to an inactive
            customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 40004
                type: NotFound
                detail:
                  message: Not found.
                  code: not_found
                status: 404
components:
  schemas:
    OffRampSessionCreationRequest:
      type: object
      properties:
        fiatAccountId:
          type: string
          format: uuid
          description: Unique identifier for the customer's chosen fiat account.
          example: fca6d32f-2f7e-4f7e-b224-8be0b92fa3f1
      required:
        - fiatAccountId
    OffRampSessionResponse:
      type: object
      properties:
        sessionId:
          type: string
          format: uuid
          description: Unique identifier for the created off-ramp session.
        customerId:
          type: string
          format: uuid
          description: Unique identifier for the customer associated with the session.
        createdAt:
          type: string
          format: date-time
          description: Date and time the off-ramp session was created.
        toCurrency:
          type: string
          description: >-
            The target fiat currency for every off-ramp transaction performed
            with the created session.
        paymentMethodType:
          type: string
          description: >-
            The fiat payment method through which the transactions will be
            performed.
        fiatAccountId:
          type: string
          format: uuid
          description: Unique identifier for the customer's chosen fiat account.
        depositAddresses:
          type: array
          description: >-
            A list containing cryptocurrency deposit addresses for supported
            blockchains.
          items:
            $ref: '#/components/schemas/OffRampDepositAddressItem'
        transactions:
          type: array
          description: >-
            A list containing every transaction that has been either started or
            completed through this session. On creation, will always be empty.
          items:
            $ref: '#/components/schemas/OffRampOrderTransactionDetail'
      required:
        - sessionId
        - customerId
        - createdAt
        - toCurrency
        - paymentMethodType
        - fiatAccountId
        - depositAddresses
        - orders
    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
    OffRampDepositAddressItem:
      type: object
      properties:
        chain:
          type: string
          description: The cryptocurrency blockchain for the deposit address.
          example: ETHEREUM
        address:
          type: string
          description: The deposit address for the corresponding blockchain.
          example: '0x1234567890AbCdEf1234567890AbCdEf1234567890'
      required:
        - chain
        - address
    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>`.

````