---
title: "List rails"
method: GET
path: "/core/rails"
tags: ["Assets"]
---

# List rails

`GET /core/rails`

## Request

- Base URL: `https://api.enterprise.sandbox.uphold.com`
- URL: `https://api.enterprise.sandbox.uphold.com/core/rails`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/core/oauth2/token`
- TypeScript: <https://skmtc.dev/uphold/apis/core-api/docs/core/rails/get.ts> (a function with typed inputs; its response is checked against the schema)

List rails supported by the platform.

## Query parameters

- `type` RailType[]
- `network` string[]
- `method` RailMethod[]
- `asset` string[]

## Headers

- `X-On-Behalf-Of` string
- `X-Uphold-User-Ip` union
  - string, ipv4
  - string, ipv6
- `X-Uphold-User-Agent` string
- `X-Uphold-User-Origin` string
- `X-Uphold-User-Country` string
- `X-Uphold-User-Subdivision` string
- `X-Uphold-User-City` string

## Response `200`

Rails retrieved.

- object
  - `rails` Rail[]
    - union
      - object
        - `type` 'crypto', required: The type of the rail.
        - `network` string, required: The network code of the rail.
        - `method` 'crypto-transaction', required: The method through which operations are carried over the network.
        - `asset` string, required: The asset code of the rail.
        - `decimals` integer, required: The number of decimal places for the asset within the network.
        - `features` string[], required: The features of the asset within the network.
        - `contractAddress` string: The contract address for the asset within the network.
      - object
        - `type` 'card', required: The type of the rail.
        - `network` string, required: The network code of the rail.
        - `method` 'credit-card' | 'debit-card', required: The method through which operations are carried over the network.
        - `asset` string, required: The asset code of the rail.
        - `decimals` integer, required: The number of decimal places for the asset within the network.
        - `features` string[], required: The features of the asset within the network.
      - object
        - `type` 'bank', required: The type of the rail.
        - `network` string, required: The network code of the rail.
        - `method` 'bank-transfer', required: The method through which operations are carried over the network.
        - `asset` string, required: The asset code of the rail.
        - `decimals` integer, required: The number of decimal places for the asset within the network.
        - `features` string[], required: The features of the asset within the network.
        - `constraints` RailBankConstraint[]: The constraints for the rail.
          - `rule` 'allowed-deposit-accounts', required
          - `allowed` 'default-only', required
      - object
        - `type` 'apm', required: The type of the rail.
        - `network` string, required: The network code of the rail.
        - `method` 'apple-pay' | 'google-pay' | 'paypal' | 'venmo', required: The method through which operations are carried over the network.
        - `asset` string, required: The asset code of the rail.
        - `decimals` integer, required: The number of decimal places for the asset within the network.
        - `features` string[], required: The features of the asset within the network.

## Other responses

- `401`: Unauthorized.
- `429`: Too Many Requests.

---

[API](https://skmtc.dev/uphold/apis/core-api.md) - [All operations](https://skmtc.dev/uphold/apis/core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uphold/apis/core-api/revisions/6c663575c57a?raw)