Skip to main content
GET
/
core
/
rails
List rails
curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/rails \
  --header 'Authorization: Bearer <token>'
{
  "rails": [
    {
      "type": "crypto",
      "network": "bitcoin",
      "method": "crypto-transaction",
      "asset": "BTC",
      "decimals": 8,
      "features": [
        "deposit",
        "withdraw"
      ]
    },
    {
      "type": "crypto",
      "network": "ethereum",
      "method": "crypto-transaction",
      "asset": "USDC",
      "decimals": 6,
      "features": [
        "deposit",
        "withdraw"
      ],
      "contractAddress": "0xd6d663b601D63a0d1A651D61847Ec8134Eb3a3CF"
    },
    {
      "type": "card",
      "network": "visa",
      "method": "debit-card",
      "asset": "USD",
      "decimals": 2,
      "features": [
        "deposit",
        "withdraw"
      ]
    },
    {
      "type": "bank",
      "network": "ach",
      "method": "bank-transfer",
      "asset": "USD",
      "decimals": 2,
      "features": [
        "deposit",
        "withdraw"
      ],
      "constraints": [
        {
          "rule": "allowed-deposit-accounts",
          "allowed": "default-only"
        }
      ]
    },
    {
      "type": "bank",
      "network": "fps",
      "method": "bank-transfer",
      "asset": "GBP",
      "decimals": 2,
      "features": [
        "deposit",
        "withdraw"
      ]
    }
  ]
}
If the subject calling the endpoint is a user, the response will be contextualized accordingly. As an example, the features field will indicate the available features for the user.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Query Parameters

​
type
enum<string>[]

Filter rails by type.

Maximum array length: 25
Available options:
crypto,
card,
bank
​
network
string[]

Filter rails by network code.

Maximum array length: 25
Minimum string length: 1
​
method
enum<string>[]

Filter rails by method.

Maximum array length: 25
Available options:
crypto-transaction,
credit-card,
debit-card,
bank-transfer
​
asset
string[]

Filter rails by asset code.

Maximum array length: 100
Minimum string length: 1

Response

200 - application/json

Rails retrieved.

​
rails
(Crypto · object | Card · object | Bank · object)[]