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

# List offramps

> List all offramp transactions for the authenticated client. Supports cursor-based pagination and filtering by source user, destination user, and status.



## OpenAPI

````yaml https://production.hifi.com/api/v3/openapi.json get /v3/offramps
openapi: 3.0.0
info:
  title: Hifi API
  version: 3.0.0
  description: API documentation for HIFI
servers:
  - url: https://production.hifi.com
    description: Production server
  - url: https://sandbox.hifi.com
    description: Sandbox server
security:
  - bearerAuth: []
tags:
  - name: Common
    description: Common endpoints
  - name: User
    description: User endpoints
  - name: Counter Party
    description: Counter party endpoints
  - name: Crypto Transfer
    description: Crypto transfer and batch transfer endpoints
  - name: Wallet
    description: Wallet and wallet offer endpoints
  - name: External Account
    description: External bank account endpoints (under a counter party)
  - name: External Wallet
    description: External wallet endpoints (under a counter party)
  - name: External Card
    description: External card endpoints (under a counter party)
  - name: Token Swap
    description: Token swap endpoints
  - name: Bridge
    description: Bridge endpoints
  - name: Virtual Account
    description: Virtual account endpoints
  - name: Compliance
    description: Compliance and compliance link endpoints
  - name: Webhook Endpoint
    description: Webhook endpoint endpoints
  - name: File
    description: File upload endpoints
  - name: Onramp
    description: Onramp (fiat to crypto) endpoints
  - name: Offramp
    description: Offramp (crypto to fiat) endpoints
  - name: Orchestration Address
    description: Orchestration (liquidation) address endpoints
  - name: KYC Link
    description: Hosted and custom KYC/KYB link endpoints
  - name: Transfer Approval
    description: Transfer approval endpoints
  - name: Corridor
    description: Supported fiat/crypto transfer corridor endpoints
  - name: Migration
    description: v2-to-v3 ID mapping endpoints
paths:
  /v3/offramps:
    get:
      tags:
        - Offramp
      summary: List offramps
      description: >-
        List all offramp transactions for the authenticated client. Supports
        cursor-based pagination and filtering by source user, destination user,
        and status.
      operationId: v3ListOfframps
      parameters:
        - $ref: '#/components/parameters/LimitParameter'
        - $ref: '#/components/parameters/StartingAfterParameter'
        - $ref: '#/components/parameters/EndingBeforeParameter'
        - $ref: '#/components/parameters/OfframpSourceUserIdQueryParameter'
        - $ref: '#/components/parameters/OfframpDestinationUserIdQueryParameter'
        - $ref: '#/components/parameters/OfframpStatusQueryParameter'
      responses:
        '200':
          $ref: '#/components/responses/ListOfframpsResponse'
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
components:
  parameters:
    LimitParameter:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
      description: default to 10, maximum to 100
      required: false
    StartingAfterParameter:
      name: startingAfter
      in: query
      schema:
        type: string
      description: Return records after this cursor.
      required: false
    EndingBeforeParameter:
      name: endingBefore
      in: query
      schema:
        type: string
      description: Return records before this cursor.
      required: false
    OfframpSourceUserIdQueryParameter:
      name: sourceUserId
      in: query
      required: false
      schema:
        type: string
      description: Filter offramps by source user public ID (prefixed with `usr_`).
      example: usr_3Kf9dQ2mNpXwZ7bV1aLcs
    OfframpDestinationUserIdQueryParameter:
      name: destinationUserId
      in: query
      required: false
      schema:
        type: string
      description: Filter offramps by destination user public ID (prefixed with `usr_`).
      example: usr_7dLpR2mNpXwZ7bV1aQz3x
    OfframpStatusQueryParameter:
      name: status
      in: query
      required: false
      schema:
        type: string
        enum:
          - NOT_INITIATED
          - CREATED
          - PENDING_APPROVAL
          - OPEN_QUOTE
          - CRYPTO_INITIATED
          - AWAITING_FUNDS
          - CRYPTO_PENDING
          - CRYPTO_PROCESSED
          - FIAT_INITIATED
          - FIAT_PENDING
          - COMPLETED
          - FIAT_FAILED
          - FIAT_RETURNED
          - CRYPTO_RETURNED
          - CRYPTO_FAILED
          - QUOTE_FAILED
          - IN_REVIEW
          - REJECTED
          - EXPIRED
          - CANCELLED
      description: Filter offramps by transaction status.
  responses:
    ListOfframpsResponse:
      description: A cursor-paginated list of offramps.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OfframpListObject'
    BadRequestResponse:
      description: Bad Request — the request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: VALIDATION_ERROR
            message: One or more fields are invalid or missing.
            fields:
              - code: invalid_value
                message: Must be a valid email address
                field: email
    UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    InternalServerErrorResponse:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
  schemas:
    OfframpListObject:
      type: object
      description: Cursor-paginated list of offramp transactions.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OfframpObject'
        pagination:
          $ref: '#/components/schemas/Pagination'
    ApiError:
      type: object
      description: >-
        Standard v3 error shape, returned by validation failures and
        business-logic errors alike.
      properties:
        type:
          type: string
          description: >-
            Machine-readable error type, e.g. VALIDATION_ERROR,
            ACTION_NOT_ALLOWED, RESOURCE_CONFLICT.
          example: VALIDATION_ERROR
        message:
          type: string
          description: Human-readable error message.
          example: One or more fields are invalid or missing.
        fields:
          type: array
          description: >-
            Present on field-level validation errors. One entry per problem
            field.
          items:
            type: object
            properties:
              code:
                type: string
                description: Error code related to the field issue.
              message:
                type: string
                description: Error message for the specific issue.
              field:
                type: string
                description: The name of the field that has an issue.
    Unauthorized:
      type: object
      properties:
        type:
          type: string
          description: Unauthorized enum
          example: UNAUTHORIZED
        message:
          type: string
          description: Unauthorized message
          example: Authentication required
    InternalServerError:
      type: object
      properties:
        type:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: Internal server error enum
        message:
          type: string
          example: An internal server error occurred
          description: Internal server error message
    OfframpObject:
      type: object
      description: An offramp transaction.
      properties:
        id:
          type: string
          description: Public ID of the offramp (prefixed with `offramp_`).
          example: offramp_9dQ2mNpXwZ7bV1aLcs3Kf
        requestId:
          type: string
          format: uuid
          description: Client-supplied idempotency key.
          example: 8f3a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8
        status:
          type: string
          enum:
            - NOT_INITIATED
            - CREATED
            - PENDING_APPROVAL
            - OPEN_QUOTE
            - CRYPTO_INITIATED
            - AWAITING_FUNDS
            - CRYPTO_PENDING
            - CRYPTO_PROCESSED
            - FIAT_INITIATED
            - FIAT_PENDING
            - COMPLETED
            - FIAT_FAILED
            - FIAT_RETURNED
            - CRYPTO_RETURNED
            - CRYPTO_FAILED
            - QUOTE_FAILED
            - IN_REVIEW
            - REJECTED
            - EXPIRED
            - CANCELLED
          example: OPEN_QUOTE
        failedReason:
          type: string
          nullable: true
          description: Machine-readable failure reason. Null unless the offramp failed.
          example: null
        error:
          type: string
          nullable: true
          description: User-facing error summary. Null unless the offramp failed.
          example: null
        errorDetails:
          type: string
          nullable: true
          description: User-facing error details. Null unless the offramp failed.
          example: null
        source:
          $ref: '#/components/schemas/OfframpSourceObject'
        destination:
          $ref: '#/components/schemas/OfframpDestinationObject'
        receipt:
          $ref: '#/components/schemas/OfframpReceiptObject'
        quote:
          type: object
          nullable: true
          description: Conversion quote for this offramp.
          example:
            sourceCurrency: USDC
            destinationCurrency: USD
            rate: '0.9985'
        depositInfo:
          type: array
          description: Deposit instructions, when applicable.
          items:
            type: object
          example: []
        sameDayAch:
          type: boolean
          example: false
        achMessage:
          type: string
          nullable: true
          example: null
        sepaMessage:
          type: string
          nullable: true
          example: null
        wireMessage:
          type: string
          nullable: true
          example: null
        swiftMessage:
          type: string
          nullable: true
          example: null
        purposeOfPayment:
          type: string
          nullable: true
          example: Supplier payment
        returnAddress:
          type: string
          nullable: true
          description: >-
            Address to which source stablecoins are returned if the offramp
            fails.
          example: '0x1234567890abcdef1234567890abcdef12345678'
        developerFee:
          $ref: '#/components/schemas/OfframpDeveloperFeeObject'
        description:
          type: string
          nullable: true
          example: July settlement
        createdAt:
          type: string
          format: date-time
          example: '2026-07-01T10:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-07-01T10:30:00.000Z'
    Pagination:
      type: object
      properties:
        hasMore:
          type: boolean
        startCursor:
          type: string
          nullable: true
        endCursor:
          type: string
          nullable: true
      required:
        - hasMore
        - startCursor
        - endCursor
    OfframpSourceObject:
      type: object
      description: Resolved source of the offramp.
      properties:
        chain:
          type: string
          enum:
            - POLYGON
            - ETHEREUM
            - SOLANA
            - BASE
            - FLOW_EVM
            - BSC
            - TRON
            - CANTON
          example: POLYGON
        amount:
          type: number
          example: 100
        currency:
          type: string
          enum:
            - USDC
            - USDT
            - USDG
            - PYUSD
            - PYUSD0
            - USDCX
          example: USDC
        userId:
          type: string
          description: Public ID of the source user (prefixed with `usr_`).
          example: usr_3Kf9dQ2mNpXwZ7bV1aLcs
        walletId:
          type: string
          description: Public ID of the source custodial wallet (prefixed with `wlt_`).
          example: wlt_1aLcs3Kf9dQ2mNpXwZ7bV
        externalWalletId:
          type: string
          nullable: true
          description: Public ID of the source external wallet (prefixed with `extw_`).
          example: null
        walletAddress:
          type: string
          example: '0x1234567890abcdef1234567890abcdef12345678'
    OfframpDestinationObject:
      type: object
      description: Resolved fiat payout destination.
      properties:
        amount:
          type: number
          example: 99.5
        currency:
          type: string
          enum:
            - USD
            - PHP
            - AED
            - EUR
            - BRL
            - HKD
            - CNY
            - MXN
            - COP
            - ARS
            - NGN
            - KES
            - BWP
            - ZAR
            - TZS
            - UGX
            - XAF
            - MWK
            - RWF
            - ZMW
            - XOF
            - SGD
            - GBP
            - INR
          example: USD
        userId:
          type: string
          description: Public ID of the destination user (prefixed with `usr_`).
          example: usr_7dLpR2mNpXwZ7bV1aQz3x
        externalAccountId:
          type: string
          nullable: true
          description: >-
            Public ID of the destination external account (prefixed with
            `extacct_`).
          example: extacct_9aB0xY4mNpXwZ7bV1aLdt
        externalCardId:
          type: string
          nullable: true
          description: >-
            Public ID of the destination external card (prefixed with
            `extcrd_`).
          example: null
    OfframpReceiptObject:
      type: object
      description: On-chain and payout tracking references.
      properties:
        transactionHash:
          type: string
          nullable: true
          description: Hash of the on-chain stablecoin transfer.
          example: '0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890'
        paymentTracking:
          nullable: true
          description: Fiat payout tracking details, when available.
          example: null
    OfframpDeveloperFeeObject:
      type: object
      nullable: true
      description: Developer fee charged on the offramp, if any.
      properties:
        id:
          type: string
          example: fee_9dQ2mNpXwZ7bV1aLcs3Kf
        transactionHash:
          type: string
          nullable: true
          example: '0xdef4567890abc123def4567890abc123def4567890abc123def4567890abc123'
        fees:
          type: string
          example: '0.5'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````