---
title: "List all offramps"
method: GET
path: "/v2/offramps"
tags: ["Offramp"]
---

# List all offramps

`GET /v2/offramps`

Returns a list of offramps associated with a user under your organization. The offramps are returned sorted by creation date, with the most recent offramps appearing first.

## Query parameters

- `userId` string
- `limit` string
- `createdBefore` string, date
- `createdAfter` string, date

## Response `200`

Success

- OfframpAllRecordsObject
  - `count` integer
  - `records` OfframpRecordObject[]
    - `transferType` string
    - `transferDetails` object
      - `id` string, uuid — unique identifier for the offramp
      - `requestId` string, uuid
      - `orchestrationAddressId` string, uuid, nullable — ID of the orchestration address that produced this offramp, or `null` for offramps created directly via `POST /v2/offramps`. Use this to pivot back to the originating orchestration address — fetch it via `GET /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}`.
      - `supportingInformation` SupportingInformation — Optional supporting information for the offramp. May include detailed purpose of payment, beneficiary details, and supporting documents. When provided, documents must reference files previously uploaded via the file upload API.
        - `detailedPurposeOfPayment` string — Detailed description of the purpose of the payment.
        - `beneficiaryDetails` SupportingInformationBeneficiaryDetails — Optional beneficiary details for the offramp.
          - `legalEntityName` string
          - `jurisdictionOfIncorporation` string — ISO 3166-1 alpha-3 country code.
          - `natureOfBusiness` string
          - `relationshipToBeneficiary` string
          - `website` string
        - `documents` SupportingInformationDocument[] — Supporting documents (e.g. invoice, contract). Each document must reference an uploaded file by fileId.
          - `fileId` string, uuid, required — Public file ID of an uploaded file.
          - `type` 'INVOICE' | 'CONTRACT' | 'AGREEMENT' | 'PURCHASE_ORDER' | 'OTHER', required — Type of supporting document.
          - `description` string — Optional description of the document.
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `status` 'NOT_INITIATED' | 'CREATED' | 'OPEN_QUOTE' | 'CRYPTO_INITIATED' | 'AWAITING_FUNDS' | 'CRYPTO_PENDING' | 'CRYPTO_PROCESSED' | 'FIAT_INITIATED' | 'FIAT_PENDING' | 'COMPLETED' | 'FIAT_FAILED' | 'CRYPTO_RETURNED' | 'CRYPTO_FAILED' | 'QUOTE_FAILED' | 'IN_REVIEW' | 'CANCELLED' — Refer to [here](https://docs.hifi.com/docs/transfers/offramps#transaction-status) for more details on each offramp status.
      - `failedReason` string
      - `error` string — Error code when the offramp transaction has failed (e.g. `QUOTE_EXPIRED`, `QUOTE_FAILED`, `QUOTE_NOT_AVAILABLE`, `BILLING_CONFIG_NOT_FOUND`, `INSUFFICIENT_BALANCE`, `FAILED_TO_CREATE_PAYMENT`, `INTERNAL_ERROR`, `TRANSACTION_REJECTED`). Present when status is a failed state such as `QUOTE_FAILED` or `CRYPTO_FAILED`.
      - `errorDetails` string — Human-readable error details when the offramp transaction has failed. Present when status is a failed state.
      - `source` object
        - `userId` string, uuid
        - `chain` string
        - `currency` string
        - `amount` number
        - `walletAddress` string
        - `user` object
          - `email` string
          - `lastName` string, nullable
          - `firstName` string, nullable
          - `businessName` string, nullable
      - `destination` object
        - `userId` string, uuid
        - `amount` number
        - `currency` string
        - `user` object
          - `email` string
          - `lastName` string, nullable
          - `firstName` string, nullable
          - `businessName` string, nullable
        - `accountId` string, uuid — destination offramp account ID
        - `sameDayAch` boolean — same day ACH offramp for a $1 additional fee
      - `receipt` object
        - `transactionHash` string, nullable
        - `paymentTracking` OfframpPaymentTrackingObject
          - `fedBatchId` string — Fedwire or ACH batch ID used for settlement tracking
          - `imad` string — Input Messaging Accountability Data. A combination of a date, source identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application. Unique to the payment.
          - `omad` string — Output Messaging Accountability Data. A combination of a date, destination identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application.
          - `traceNumber` string — Unique ACH trace number for the transaction
          - `paymentRail` 'wire' | 'ach' | 'rtp' | 'swift'
      - `developerFee` object
        - `id` string, uuid — unique identifier for the developer fee record
        - `transactionHash` string, nullable — transaction hash of the fee transfer
        - `fees` object[]
          - `type` 'PERCENTAGE' | 'FLAT', required
          - `value` string, required — fee amount as string, for percentage represents decimal (e.g. "0.0005" = 0.05%)
          - `amount` string, required — actual fee amount charged
          - `walletAddress` string, required — wallet address receiving the fee
      - `quoteInformation` object
        - `sendGross` object
          - `amount` string
          - `currency` string
        - `sendNet` object
          - `amount` string
          - `currency` string
        - `receiveGross` object
          - `amount` string
          - `currency` string
        - `receiveNet` object
          - `amount` string
          - `currency` string
        - `rate` string
        - `expiresAt` string, date-time
      - `depositInformation` object[]
        - `id` string, uuid
        - `fromAddress` string
        - `toAddress` string
        - `currency` string
        - `contractAddress` string
        - `rawAmount` string
        - `amount` number
        - `chain` string
        - `collected` boolean
        - `collectable` boolean
        - `expiresAt` string, date-time
        - `transactionHash` string, nullable
  - `nextCursor` string — The `createdAt` timestamp of the last record in the current page. Pass this as `createdBefore` in the next request to retrieve the next page of results.

## Other responses

- `401` — Unauthorized
- `404` — Resource not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/hifi/apis/hifi-api.md) · [All operations](https://skmtc.net/hifi/apis/hifi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hifi/hifi-api/revisions/15a39c342fd1/schema)