HelperStable

Refund payment

Creates a refund intent for an existing bank or open-banking Payment without claiming that the funds have already been returned.

Contexte financier

Refund payment

Finance

Typed result

Vue d’ensemble

Creates a refund intent for an existing bank or open-banking Payment without claiming that the funds have already been returned.

Exemple

Prepare a bank-transfer refund after resolving a customer dispute.

Parameters 5

paymentRequisPayment

Canonical received payment or payment to refund according to the operation.

amountOptionnelamount

Operation amount in minor monetary units. When optional, the node may use the residual amount defined by its contract.

sourceOptionnelenum

Channel planned for bank-refund execution: manual or open banking according to the contract.

reasonOptionnelstring

Business reason for the refund or applied classification.

metadataOptionnelmetadata

Free-form integration metadata associated with the resource according to the flat common.metadata contract.

Outputs 1

payment_refundPayment

Bank/open-banking refund intent created in draft status.

Behavior

The persisted intent captures the parent payment, amount, planned channel, and reason. It can then be executed through the appropriate bank channel.

Key point Always distinguish the canonical object created by Ormuz from any external effect. A payment or refund intent in draft status does not prove that a provider executed the movement of funds.

Limits and responsibilities

The output represents an intent in draft status, not an executed cash movement.
The manual or open_banking channel describes the expected execution mode and must not be chosen independently from your real capabilities.