GET
/
rails
List available payment rails
curl --request GET \
  --url https://sandbox.api.openfx.com/v1/rails \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Signature: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "items": [
    {
      "id": "ach",
      "name": "ACH",
      "description": "US Automated Clearing House for domestic USD payments.",
      "status": "active",
      "supportedCurrencies": [
        "USD"
      ],
      "supportedCountries": [
        "US"
      ],
      "typicalSettlementTime": "1-2 business days",
      "cutoffTime": "21:00 UTC",
      "capabilities": [
        "inbound",
        "outbound",
        "return",
        "same_day"
      ],
      "requiredFields": [
        "routingNumber",
        "accountNumber",
        "bankAccountType"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key issued at onboarding. Passed as a Bearer token in the Authorization header: Authorization: Bearer <api-key>. Identifies the caller and determines organization scope. Invalid or revoked keys return 401 with error type authentication_error.

​
X-Signature
string
header
required

Ed25519 or RSA-SHA256 asymmetric signature over the request payload (ADR-0015). Provides request integrity and non-repudiation. The signature covers the HTTP method, path, query string, request body, and timestamp. Invalid signatures return 401 with error type authentication_error.

​
X-Timestamp
string
header
required

Unix timestamp (seconds) of when the request was signed. Server rejects requests where the timestamp drifts beyond +/-60 seconds from server time to prevent replay attacks. Must match the timestamp used in the signature computation.

Query Parameters

​
status
enum<string>

Filter by rail status.

Available options:
active,
limited,
maintenance
​
currency
string

Filter to rails that support this currency. ISO 4217 currency code for fiat (USD, EUR, GBP) or crypto asset ticker (USDC, BTC, ETH). Uppercase, 2-10 characters. Use this type in contexts where both fiat currencies and crypto assets are accepted.

Pattern: ^[A-Z]{2,10}$
Example:

"USD"

​
country
string

Filter to rails available in this country. ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$
Example:

"US"

Response

List of available payment rails.

​
items
object[]
required