Skip to main content
GET
List rails
List rails returns the rails supported by each ramp type (on-ramp and off-ramp), or by the given rampType only, using the same filters (type, network, method and asset) as List rails in the Core API. Each rail has the same schema as in the Core API, plus its rampType. The features field indicates whether a rail can be used as the order origin (deposit) or destination (withdraw): It needs no specific scope. If the subject calling the endpoint is a user, the response will be contextualized accordingly. Rails that are not available, for the ramp type, your organization or the user, are returned with empty features. Filtering by a method the ramp type doesn’t support (e.g. bank-transfer) returns no rails for it.

Why not use the Core API rails

List rails in the Core API returns the rails for Core transactions, which move funds into and out of the accounts of a user. Its features don’t tell you what an order can do, because:
  • The rails of each ramp type are enabled separately. Your organization’s rails for on-ramp and off-ramp orders are configured independently of its Core API rails, and of each other. A rail can be available for orders but not for Core transactions, or the other way around.
  • An order uses each rail in one direction only. For example, a Core crypto rail can have both deposit and withdraw, but an on-ramp order only withdraws to it, and an off-ramp order only deposits from it. Off-ramp orders only pay out to debit cards.
  • Rails that orders don’t support are left out. Methods no ramp type uses, such as bank-transfer, are never returned.
Use this endpoint, not the Core one, to decide which payment methods, assets and networks to offer for an order.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication

Query Parameters

rampType
enum<string>

Filter rails by ramp type. Without it, the rails of every ramp type are listed. Whether the order is an on-ramp (fiat to crypto) or off-ramp (crypto to fiat) order.

Available options:
on-ramp,
off-ramp
type
enum<string>[]

Filter rails by type.

Maximum array length: 25
Available options:
crypto,
card,
bank,
apm
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,
apple-pay,
google-pay,
paypal,
venmo
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 | Alternative payment method · object)[]