---
title: "List all onramps"
method: GET
path: "/v2/onramps"
tags: ["Onramp"]
---

# List all onramps

`GET /v2/onramps`

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

## Query parameters

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

## Response `200`

Success

- OnrampAllRecordsObject
  - `count` integer
  - `records` OnrampRecordObject[]
    - `transferType` string
    - `transferDetails` object
      - `id` string, uuid
      - `requestId` string, uuid
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `status` 'NOT_INITIATED' | 'CREATED' | 'OPEN_QUOTE' | 'FIAT_INITIATED' | 'AWAITING_FUNDS' | 'FIAT_PENDING' | 'FIAT_PROCESSED' | 'CRYPTO_INITIATED' | 'CRYPTO_PENDING' | 'COMPLETED' | 'FIAT_FAILED' | 'FIAT_RETURNED' | 'CRYPTO_FAILED' | 'QUOTE_FAILED' | 'EXPIRED' | 'CANCELLED' | 'UNKNOWN' — Refer to [here](https://docs.hifi.com/docs/transfers/onramps#transaction-status) for more details on each onramp status.
      - `failedReason` string
      - `error` string — Error code when the onramp transaction has failed (e.g. `INTERNAL_ERROR`, `EXPIRED`, `AMOUNT_TOO_LOW`, `TRANSACTION_REJECTED`). Present when status is a failed state such as `FIAT_FAILED`, `CRYPTO_FAILED`, or `QUOTE_FAILED`.
      - `errorDetails` string — Human-readable error details when the onramp transaction has failed. Present when status is a failed state.
      - `source` object
        - `userId` string, uuid
        - `currency` string
        - `amount` number, float
        - `accountId` string
        - `user` object
          - `email` string
          - `lastName` string
          - `firstName` string
          - `businessName` string
        - `bankInfo` InboundObject
          - `bankName` string
          - `senderName` string
          - `routingNumber` string
          - `accountNumber` string
          - `accountType` string
          - `fedBatchId` string
          - `imad` string
          - `omad` string
          - `traceNumber` string
          - `bankAddress` string
          - `description` string
          - `paymentRail` 'ach' | 'wire' | 'rtp'
      - `destination` object
        - `userId` string, uuid
        - `currency` string
        - `chain` string
        - `walletAddress` string
        - `externalWalletId` string
        - `amount` number, float
        - `user` object
          - `email` string
          - `lastName` string
          - `firstName` string
          - `businessName` string
      - `receipt` object
        - `transactionHash` string
      - `developerFee` object
      - `quoteInformation` object
        - `sendGross` object
          - `amount` string
          - `currency` string
        - `sendNet` object
          - `amount` string
          - `currency` string
        - `railFee` object
          - `amount` string
          - `currency` string
        - `receiveGross` object
          - `amount` string
          - `currency` string
        - `receiveNet` object
          - `amount` string
          - `currency` string
        - `rate` string
        - `expiresAt` string, date-time
      - `depositInfo` OnrampDepositInfoObject
        - `bankName` string
        - `bankAddress` string
        - `swiftCode` string
        - `beneficiary` object
          - `name` string
          - `address` string
        - `ach` object
          - `routingNumber` string
          - `accountNumber` string
        - `wire` object
          - `routingNumber` string
          - `accountNumber` string
        - `rtp` object
          - `routingNumber` string
          - `accountNumber` string
        - `reference` string
        - `depositBy` string, date-time
        - `instruction` string
  - `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/versions/15a39c342fd1/schema)