OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

openbanking.accounts.get

Retrieve the canonical bank account record for the given account identifier.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @platform.finance
  • Tags: open-banking, powens, accounts
    • field.key.label
    openbanking.accounts.get
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    openbanking.accounts.get
    field.description.label

    Retrieve the canonical bank account record for the given account identifier.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @platform.finance
  • Tags: open-banking, powens, accounts
    • field.tags.label
    open-banking,powens,accounts
    field.owners.label
    @platform.finance
    field.stability.label
    experimental

    Retrieve the canonical bank account record for the given account identifier.

    Goal

    Allow user-facing experiences and automations to display up-to-date account metadata.

    Context

    Invoked by UI surfaces and workflow automation steps that require detailed metadata for a specific bank account.

    Source Definition

    import {
	type AnyOperationSpec,
	defineCommand,
	defineQuery,
} from '@lssm-tech/lib.contracts-spec/operations';
import type { OperationSpecRegistry } from '@lssm-tech/lib.contracts-spec/operations/registry';
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';
import { BankAccountRecord } from '../models';
import { OPENBANKING_TELEMETRY_EVENTS } from '../telemetry';

export const OpenBankingGetAccount = defineQuery({
	meta: {
		key: 'openbanking.accounts.get',
		version: '1.0.0',
		description:
			'Retrieve the canonical bank account record for the given account identifier.',
		goal: 'Allow user-facing experiences and automations to display up-to-date account metadata.',
		context:
			'Invoked by UI surfaces and workflow automation steps that require detailed metadata for a specific bank account.',
		owners: ['@platform.finance'],
		tags: ['open-banking', 'powens', 'accounts'],
		stability: 'experimental',
	},
	io: {
		input: OpenBankingGetAccountInput,
		output: BankAccountRecord,
	},
	policy: {
		auth: 'user',
	},
});