SEseismic
Accounts

Update an external bank account's holder

Record the holder's relationship to the customer or the holder business's industry on an existing external bank account, for one created without them, or correct whether the account belongs to a third party. Send any of the fields; an omitted field is left unchanged, except that correcting is_third_party without a new relationship clears the old one. The account is then submitted again wherever it could not be registered before, which can open more routes to it; registrations that already exist are not changed. The response reflects the account as soon as those submissions answer or a short wait elapses.

patch/v0/customers/{id}/accounts/fiat/{account_id}/holder

Request

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

Path parameters

idstring uuid required

Customer id.

account_idstring uuid required

External fiat account id.

Request body

industrystring nullable

The six-digit NAICS code of the holder business's industry, from GET /v0/industries/account-holder; any other code is rejected. Business holders only.

is_third_partyboolean nullable

Corrects whether the account belongs to someone other than the customer. Changing it discards the relationship the account was created with, since that was given for the other party, unless this request sends a new one.

relationship'PART' | 'CHIL' | 'SPOU' | 'CUST' | 'EMPL' | 'EXSP' | 'FREN' | 'CONT' | 'LAND' | 'OTHR' | 'PARE' | 'RELA' | 'SELF' | 'SIBL' | 'VEND' | 'BRAN' | 'FRAN' | 'HOLD' | 'SUBS' | 'SUPP'

Who an external account's holder is to the customer, as a four-letter code. The set accepted depends on the holder's type.

Response

The account, with the holder updated.

asset_contract_addressstring nullable

Token contract pinned to a crypto account when it is created.

asset_standardstring nullable

Token interface used by a crypto account, such as erc20 or src20.

available_balancestring nullable

Portion of balance spendable right now (total minus holds/pending). Absent when the distinction doesn't exist for the account.

balancestring nullable

Funds held in the account, in currency major units, as of balance_as_of. Seismic keeps this in sync as funds move (deposits, payments, account updates). Present on virtual accounts once the first sync lands; always absent on external accounts (their funds sit at the partner's own bank/wallet).

balance_as_ofstring date-time nullable

When Seismic last refreshed balance.

can_enable_liquidationboolean nullable

Whether auto-liquidation can be enabled on this account via PUT /v0/accounts/{id}/liquidation. Present only on virtual bank accounts that don't auto-liquidate; where false (or absent), a liquidation target can only be attached when a virtual account is created.

chain_idinteger nullable

Numeric network identifier pinned when a crypto account is created.

created_atstring date-time required
currencystring required
customer_idstring uuid required
developer_fee_supportedboolean nullable

Whether liquidation.developer_fee_bps is accepted on this account, when enabling or retargeting auto-liquidation. Present only on virtual bank accounts; absent while the account is still provisioning.

idstring uuid required
kind'fiat' | 'crypto' required

Top-level kind of the account — fiat vs crypto. Carried explicitly on ApiAccount and ApiAccountCreationRequest so callers can branch without parsing shape (and because details is an untagged enum that won't help them dispatch).

liquidation_can_turn_offboolean nullable

Whether auto-liquidation on this account, once on, can be turned off via DELETE /v0/accounts/{id}/liquidation. Present only on virtual bank accounts; absent while the account is still provisioning.

origin'external' | 'virtual' required
railsstring[] required
status'pending' | 'active' | 'failed' | 'closed' | 'paused' required

Lifecycle a partner-visible account can be in. pending and failed occur only for crypto accounts whose setup is still running or failed; every other account is active until closed. paused is a reversible hold on a fiat account whose holder's verification is paused: it clears on unpause.

updated_atstring date-time required

Changes

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