Reference data

List virtual-account banks

Every bank a virtual account can be opened at, as a bare array in display order: the banks that accept third-party payments first, then the ones that accept only the holder's own payment. Render the list in the order it arrives.

This is the whole catalog, not what one customer can select. GET /v0/customers/{id}/virtual-account-banks narrows it to the banks a given customer is cleared for in a currency, in this same order. Unauthenticated.

get/v0/virtual-account-banks

Request

  • Base URL
    https://orchestration.seismic.systems/api
  • Auth
    none required

Response

Bank catalog.

bankstring required

Identifier for the bank. This is the value to send as bank when creating a virtual account.

countrystring required

ISO 3166-1 alpha-2 country an account at this bank is domiciled in.

namestring required

Name of the institution, for display. Two entries can share a name when the same institution offers both a first- and a third-party bank — party is what separates them, and bank is what selects one.

party'third_party' | 'first_party' required

Who may pay into a bank's virtual accounts.

third_party accepts a payment from anyone, including the account holder. first_party accepts only the holder's own payment and rejects a payment from anyone else, so third party is a superset of first party.

Example response

[
  {
    "bank": "PORTAGE_BANK",
    "country": "US",
    "name": "Portage Bank"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.