BridgeUser actionStable

Connect bank accounts (Bridge)

Opens the Bridge experience that lets a user add, renew, or manage bank connections, then returns the visible banking state.

Vue d’ensemble

Connect Bridge bank accounts lets a user already represented by a bridge_user manage bank connections in the Bridge experience.

On return, the node rereads accessible connections and accounts. Accounts with data_access = disabled are excluded from this initial result.

  • The Bridge authorization token remains temporary and is never exposed as a process output.
  • The output may be partial: check items_has_more and accounts_has_more.
  • The node does not guarantee that a new account was added; the user may only manage or renew an existing connection.

Typical scenario

During onboarding, the primary contact is first associated with a Bridge user through bridge.ensure_user. The user then opens this node to connect a bank. On return, the process immediately has the first accessible connections and accounts.

Quick start

Create or resolve the bridge_user first, then provide the email of the person who will actually interact with Bridge.

Recommended sequence

  • bridge.ensure_user
  • bridge.connect_bank_accounts
  • bridge.list_accounts or bridge.list_transactions when an exhaustive read is needed

Choix UX

  • show_add_item_button = true to allow adding a new bank
  • false to restrict the session to managing existing connections
Configuration example
ParameterBindingRole
bridge_usernodes.ensure_user.bridge_userBridge user for the contact
user_emailcontact.emailEmail of the person acting
show_add_item_buttontrueAllows adding a bank
Key point The items and accounts outputs support fast continuation of the journey; if *_has_more is true, use the list nodes afterward to browse remaining pages.

Process example

User Bridge + E-mail de l’utilisateur
Connecter des comptes bancaires (Bridge)
Item Bridge + Account Bridge

Exemple simplifié d’utilisation de Connecter des comptes bancaires (Bridge) dans un processus Ormuz.

Data resolution

The node resolves this data from its inputs and Bridge context.

DataSource or rule
Banking userbridge_user.uuid, generally obtained through bridge.ensure_user.
Session emailuser_email supplied to the node.
Return URLHandled automatically by the user action.
Returned accountsFirst Bridge page, limited to accounts whose data_access is not disabled.
Access tokenCreated temporarily for the session and reads, never exposed as a process input or output.

Parameters 8

Contexte principal

Objects and configuration that determine the Bridge operation.

extension_config_idRequisref(extension_config:bridge)
Active Bridge configuration used for this operation. It determines the Bridge API credentials and environment; the merchant remains the merchant of the current process.
bridge_userRequisBridge user
Bridge user representing the person whose bank accounts must be connected, accessed, or verified. Usually obtain it with bridge.ensure_user rather than constructing the object manually.

Action presentation

Text visible to the participant before continuing to Bridge.

titleOptionnelstring
Titre affiché au participant pour présenter l’action Bridge. Utilisez un libellé court qui décrit clairement l’action attendue, par exemple poursuivre vers sa banque ou vérifier son compte. Valeur par défaut : Manage my bank accounts.
descriptionOptionnelstring
Texte d’accompagnement affiché avec le titre de l’action Bridge. Utilisez-le pour expliquer au participant pourquoi il est redirigé vers Bridge et ce qu’il devra y faire. Valeur par défaut : Continue securely with Bridge to connect or maintain your bank accounts..

Payer or user identity

Information used to identify the person or company interacting with Bridge.

user_emailRequisemail
Email address presented to Bridge for the bank-connection or account-verification experience. Use the email of the contact actually performing the action.

Banking experience

Settings for the Bridge interface shown to the user.

show_add_item_buttonRequisboolean
Whether the user may add a new bank connection in the Bridge interface. Disable this option when the user should only manage or refresh existing connections. Default: true.

Process resumption

Advanced settings controlling replay of the user action.

allow_replay_from_hereOptionnelboolean
Allows an authorized operator to resume the process later from this user action. Leave this disabled unless your resume policy explicitly permits replaying the Bridge interaction.
replay_boundaryOptionnelboolean
Marks this action as a point of no return for process resumption. Enable it when replaying previous steps could recreate a payment initiation or repeat a sensitive bank connection.

Outputs 6

Banking data

Bank-aggregation or verification objects available to subsequent steps.

bridge_userBridge user
Bridge user representing the Ormuz contact for bank-aggregation and account-verification operations.
itemsBridge item[]
Bridge bank connections visible to the user after the operation. Each item represents a relationship with a financial institution.
accountsBridge account[]
Bridge bank accounts accessible to the user or matching the requested filter. Banking information in these objects is classified as sensitive.

Session and traceability

Session identifiers, mappings, and creation indicators.

banking_session_idOptionnelstring
Identifier of the Bridge session used for connecting or managing banks. The hosted URL and authorization token are not exposed as process outputs.

Pagination

Indicators used to continue a Bridge list.

items_has_moreboolean
Whether Bridge has additional items beyond the page returned by the bank-connection action.
accounts_has_moreboolean
Whether Bridge has additional accounts beyond the page returned by the bank-connection action.

Behavior

Temporarily authorize the user

Ormuz obtains the required Bridge authorization from the bridge_user without exposing the token to the process.

Open bank management

The participant is redirected to Bridge to add, renew, or manage bank connections.

Return to the journey

The Bridge return completes the action without retaining the session URL as business data.

Reread items and accounts

The node returns up to the first pages of accessible connections and accounts, together with the *_has_more indicators.

Limits and responsibilities

  • The participant's return does not prove that a new bank was added; use the outputs to observe the state that is actually available.
  • The initial outputs may be paginated. They do not replace bridge.list_items / bridge.list_accounts for an exhaustive read.
  • The node does not return bank transactions; use bridge.list_transactions after selecting the desired scope.
  • Disabled accounts are not included in this action's accounts output.

Troubleshooting

No account after return

Check that the user actually connected a bank and that the relevant accounts do not have data_access = disabled.

The list appears incomplete

Check items_has_more and accounts_has_more, then use the list nodes to continue pagination.

The wrong person sees the session

Check that bridge_user and user_email refer to the same business contact in your process.