Customers

List selectable virtual-account banks

The banks this customer can be issued a virtual account at in currency, right now, in display order. Send one of these as bank when creating the virtual account to choose where it is held; omit bank and a bank is chosen for you.

The order is the same one GET /v0/virtual-account-banks serves the whole catalog in — render the list as it arrives.

Only banks the customer is already cleared for are listed, so an empty list is a normal answer. It can mean there is no choice to make for this customer and currency, or that the customer's virtual-account review has not cleared any bank yet — in which case a create naming no bank is refused with VirtualAccountNotApproved, naming where the review stands. GET /v0/customers/{id}/virtual-account-approvals shows where each clearance stands. Clearances are cached for up to an hour, and a currency's own virtual-account review for 45 seconds to 5 minutes depending on where it stands, so a freshly granted one can take that long to appear.

get/v0/customers/{id}/virtual-account-banks

Request

  • Base URL
    https://orchestration.seismic.systems/api
  • Auth
    API key in header Api-Key

Path parameters

idstring uuid required

Customer id.

Query parameters

currencystring required

Currency the account would collect in (e.g. USD). Case-insensitive.

Response

Banks the customer can select.

Example response

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

Changes

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