Skip to main content
GET
Get the native Open Payments setup and supported Finnish banks

Authorizations

Authorization
string
header
required

Firebase ID token from an interactive portal session. Required for interactive operations (payroll, company settings, API-key management) and invoice decisions allowed by the member's review permissions.

Query Parameters

customer_id
string

Target company. Optional — API keys are pinned to one company, and single-company sessions default to it.

Response

Paying account, current terms/KYC status, and banks that currently advertise SEPA payment initiation. The selected bank is readiness-checked before it is saved.

can_change
boolean
required
can_verify
boolean
required
banks
object[]
required

The banks a company admin may choose as the paying bank: the provider lists them for the market and LAC has a route policy for them. route is how a payment reaches the bank (iso_corporate: a bank-side corporate agreement and the customer confirms the uploaded file in the bank; psd2_pis: payment initiation the customer authorises at release). readiness is live when LAC has proven the route end to end and releases money on it, provider_listed when the provider lists the bank but LAC has not verified the route yet: the account can be saved and the customer-side steps started, but nothing is released. activation names what marks the bank connection active and guide the setup guidance the portal renders for the bank. Live routes sort first.

terms
object
required
verification
object
required

Authoritative KYC UI state derived from LAC's hosted-flow attempt record and the provider's live status. started means LAC returned a hosted URL that remains the one actionable flow for 24 hours; retry means that URL expired or Open Payments answered Invalid; pending means a start has no recorded outcome and must not be repeated before the same 24-hour boundary. Only clear represents current provider validity.

setup
object