BridgeUser actionStable

Collect payment (Bridge)

Collects a Bridge bank payment from an existing `platform.psp_payment` and resumes the process according to the selected completion policy.

PSP payment

Collecter un paiement (Bridge)

Payment link Bridge

PSP payment

Vue d’ensemble

Collect Bridge payment is the recommended high-level node for interactive bank payments. It always starts from an already-created platform.psp_payment, so the designer does not enter an amount or currency in Bridge.

The node orchestrates bank authorization, the payer's return, and synchronization of the Ormuz payment. The process resumes only at the level defined by completion_policy.

PDNG means the initiation is in progress or accepted, not that funds have been received.
initiated is the recommended choice when the bank does not consistently provide a final execution status.
A Payment Link already associated with the same psp_payment is reused rather than recreated.

Typical scenario

A checkout creates a psp_payment for EUR 1,250.00 and then calls this node. The payer selects a bank and confirms the transfer. With completion_policy = initiated, the checkout can resume as soon as initiation is confirmed while the Ormuz payment remains pending until a final Bridge state is received.

Quick start

Prepare the Ormuz PSP payment first, then explicitly choose the confirmation level required before the process resumes.

Minimum requis

Active Bridge configuration
psp_payment of type payment with amount and currency
A payer identity: company or first name + last name

Recommended policy

initiated for a smooth checkout
executed only when your use case requires a final result and the targeted banks expose one

Configuration example

Parameter	Binding	Role
`psp_payment`	`nodes.create_psp_payment.psp_payment`	Financial source of truth
`completion_policy`	`initiated`	Recommended for most journeys
`payer_company_name`	`buyer.legal_name`	Or first name + last name for a natural person

Key point Do not duplicate amount or currency in Bridge variables: they are always derived from the supplied psp_payment.

Process example

PSP payment

Collecter un paiement (Bridge)

Payment link Bridge + PSP payment

Exemple simplifié d’utilisation de Collecter un paiement (Bridge) dans un processus Ormuz.

Data resolution

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

Data	Source or rule
Amount	`psp_payment.amount`; Ormuz converts it to the format expected by Bridge only at the provider boundary.
Currency	`psp_payment.currency`.
Payment reference	`psp_payment.id` as the Bridge `client_reference`.
Payer identity	`payer_company_name` ou couple `payer_first_name` + `payer_last_name`.
Payer reference	`payer_external_reference` → `psp_payment.buyer_id` → `psp_payment.id`.
Return URL	Handled automatically by the user action; no `callback_url` is requested.
Banque	`provider_id` if a bank must be enforced; otherwise the payer selects the bank.

Parameters 17

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.

psp_paymentRequisPSP payment

Existing Ormuz PSP payment already created and belonging to the process. For Bridge payment nodes, its amount and currency are the source of truth and are not requested again as separate parameters.

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 : Continue to my bank.

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 choose your bank and authorize the payment..

Payer or user identity

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

payer_first_nameOptionnelstring

First name of the natural person making the payment. Use with payer_last_name when the payer is a natural person; these fields are unnecessary when payer_company_name identifies a company.

payer_last_nameOptionnelstring

Last name of the natural person making the payment. Use with payer_first_name when the payer is not specified as a company.

payer_company_nameOptionnelstring

Legal name of the company making the payment. Use this field instead of the payer_first_name / payer_last_name pair when the payer is a legal entity.

payer_emailOptionnelemail

Payer email address sent to Bridge when available. It helps identify the payer in the banking journey without modifying the Ormuz contact.

payer_external_referenceOptionnelstring

Payer business reference sent to Bridge. If absent, Ormuz uses psp_payment.buyer_id when available, then falls back to the psp_payment identifier.

Payment options

Choices applied to bank initiation and return from the Bridge experience.

completion_policyRequisenum

Determines when Ormuz considers the payment action complete. initiated resumes the process as soon as bank initiation is confirmed, even if the payment remains pending; executed waits for a final Bridge status of ACSC or RJCT. Default: initiated.

countryOptionnelenum

Country used to guide the Bridge bank-selection experience. Set it when the journey must be limited to a supported market (fr, es, de, or gb).

provider_idOptionnelinteger

Numeric Bridge banking-provider identifier to enforce. Leave this field empty to let the payer choose a bank in the Bridge journey.

labelOptionnelstring

Transfer label sent to Bridge and, depending on the bank, visible on the banking transaction. Use a business label understandable to both payer and beneficiary.

end_to_end_idOptionnelstring

End-to-end reference for the bank payment. Set it only if your system already has a stable payment reference that must be propagated to the bank.

expired_atOptionneldatetime

Date and time after which the Bridge payment link must no longer be usable. Use an ISO 8601 date consistent with the checkout validity period or business due date.

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 7

Payment

Objects and state resulting from the payment lifecycle.

payment_linkBridge payment link

Current Bridge payment link, with its identifier, statuses, and payment information. Its hosted URL is classified as secret when present.

payment_requestBridge payment request

Bridge Payment Request associated with the payment, including its state and known transactions. It may be absent until Bridge has created the corresponding request.

payment_transactionBridge payment transaction

Bridge transaction representing the bank initiation and its execution state (CREA, ACTC, PDNG, ACSC, or RJCT).

psp_paymentPSP payment

Ormuz PSP payment after synchronization with Bridge state. Its amount and currency remain those of the original Ormuz payment.

completion_policyenum

Payment-action policy actually applied: initiated or executed.

Session and traceability

Session identifiers, mappings, and creation indicators.

extension_object_mappingextension object mapping

Traceability link between the primary Bridge object produced by the node and the Ormuz object with which it is associated.

payment_link_mappingOptionnelextension object mapping

Traceability link between the Bridge Payment Link and the Ormuz psp_payment. This output is present when a mapping for the link is available.

Behavior

Validate the payment

Verifies that the psp_payment is usable and the payer data is sufficient to create the Bridge initiation.

Create or reuse the Payment Link

Reuses the link already associated with the Ormuz payment or creates a new one with the supplied references and options.

Have the payment authorized

The participant is redirected to Bridge and then returns to the journey without the provider URL becoming durable process data.

Apply the completion policy

initiated accepts a sufficiently advanced initiation; executed waits for ACSC or RJCT.

Synchronize the PSP payment

The current Bridge status is applied to the Ormuz payment before final outputs become available.

Limits and responsibilities

The node covers a single payment: one Ormuz psp_payment corresponds to one Bridge initiation, not a bulk payment.
PDNG is never converted to succeeded; the Ormuz payment remains pending until Bridge reports ACSC.
With executed, some banks may not expose a final execution status. In that case, the node requires initiated rather than inventing a success.
The node does not reconcile the payment with an invoice or receivable; use the appropriate Ormuz reconciliation nodes afterward.

Troubleshooting

Incomplete payer identity

Renseignez soit payer_company_name, soit les deux champs payer_first_name et payer_last_name.

The payment remains pending

Check the Bridge status. PDNG is deliberately preserved as pending in Ormuz until a final result is available.

The executed policy does not complete

The bank may not provide a final status. Switch to initiated if your process does not need to wait for bank execution.

The expected bank does not appear

Check country and, when enforcing a bank, make sure provider_id identifies a Bridge provider compatible with the payment journey.

Reference

Bridge status	Ormuz PSP status	Sens
`CREA`	`pending`	Initiation created.
`ACTC`	`pending`	Initiation technically accepted.
`PDNG`	`pending`	Payment initiated/in progress; execution not confirmed.
`ACSC`	`succeeded`	Execution confirmed by Bridge.
`RJCT`	`failed`	Payment rejected.

completion_policy	When the node may complete	Recommended use
`initiated`	After initiation is confirmed (`PDNG`, `ACSC`, `RJCT`, or completed link).	Checkout and journeys where final execution may arrive later.
`executed`	Only on `ACSC` or `RJCT`.	Processes that require a terminal bank result before continuing.