api.eligibleRails

Resolve the rails eligible for an account being created with a given kind and currency. Works without credentials, returning every rail the currency can be settled over. When the client is authenticated and an organization is selected, the list is narrowed to the rails that organization is approved for. Drives an account-create rail picker. Render only the returned rails.

const { rails, fiat_shape, holder_address_required } = await api.eligibleRails({
  kind: "fiat",
  currency: "INR",
  bankCountry: "IN",
  holderCountry: "IN",
});
console.log(rails, fiat_shape, holder_address_required);
// ["imps"]  "in_ifsc"  false

Arguments: { kind: "fiat" | "crypto"; currency: string; bankCountry?: string; holderCountry?: string }.

Returns: Promise<{ rails: string[]; fiat_shape: string | null; holder_address_required: boolean }>.

REST endpoint: GET /eligible-rails.