GET /virtual-account-banks

The bank catalog: every bank a virtual account can be opened at, each with the country it is domiciled in and who may pay into it. Fetch it once and drive your bank picker from it.

Unauthenticated. No Api-Key or Authorization header required.

This is the whole catalog, not what one customer can select today. For that, read GET /customers/:id/virtual-account-banks, which narrows this list to the banks a given customer is cleared for in a currency — and serves them in this same order.

Display order

The list arrives in display order and carries no sort key, so render it as it arrives:

1. banks that accept third-party payments,
2. banks that accept only the account holder's own payment.

Third party is the superset, so it leads. Re-sorting the list — alphabetically, say — buries the banks that accept the widest set of payments.

Response 200

A bare array, in display order (truncated here):

[
  {
    "bank": "PORTAGE_BANK",
    "name": "Portage Bank",
    "country": "US",
    "party": "third_party"
  },
  {
    "bank": "ZAND_BANK",
    "name": "Zand Bank PJSC",
    "country": "AE",
    "party": "third_party"
  },
  {
    "bank": "SSB_FIRST_PARTY",
    "name": "Slovak Savings Bank",
    "country": "US",
    "party": "first_party"
  }
]

VirtualAccountBank

Treat bank as an open set: banks are added over time, so render the list you are served rather than a list of your own. Two entries can share a name when one institution offers both a first- and a third-party bank — party is what separates them, and bank is what selects one.

party

Who may pay into a virtual account at this bank:

• third_party — accepts a payment from anyone, the account holder included.
• first_party — accepts only the account holder's own payment, and rejects a payment from anyone else.

Third party is a superset of first party. If your customers are paid by someone other than themselves, a first_party bank will reject those payments.

Example

curl "$SEISMIC_ORCHESTRATION_URL/v0/virtual-account-banks"

See also

• GET /customers/:id/virtual-account-banks: the banks one customer can select in a currency.
• POST /customers/:id/accounts/fiat/virtual: where bank is sent.
• GET /currencies: the currencies a virtual account can collect in.