Skip to main content
GET
/
v1
/
payouts
/
available-rails
List available payout rails for an account
curl --request GET \
  --url https://api.example.com/v1/payouts/available-rails \
  --header 'Authorization: Bearer <token>'
[
  {
    "available": true,
    "etaCopy": "1-3 business days",
    "feeFrom": "$20.00",
    "icon": "🌐",
    "label": "SWIFT International",
    "unavailableReason": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Query Parameters

​
accountId
string<uuid>
required

Payout account UUID

Response

List of rails (may include unavailable entries with explanation)

​
available
boolean
required

Whether this rail is currently available for the account

​
etaCopy
string
required

ETA display string

Example:

"1-3 business days"

​
feeFrom
string
required

Minimum fee display string

Example:

"$20.00"

​
icon
string
required

Icon character or emoji for this rail

Example:

"🌐"

​
label
string
required

Human-readable label for this rail

Example:

"SWIFT International"

​
route
enum<string>
required

Payment route identifier

Available options:
sepa_inst,
sepa_credit,
paysend,
bank_transfer,
ach,
fedwire,
swift,
crypto
​
unavailableReason
string

Why this rail is unavailable for this account