Refund PSP payment
Creates a PSP-refund intent in `draft` status linked to a successful PSP payment.
Contexte financier
Refund PSP payment
Finance
Typed result
Vue d’ensemble
Creates a PSP-refund intent in draft status linked to a successful PSP payment.
Exemple
After issuing a credit note, prepare a refund for the corresponding amount on the original card payment.
Parameters 5
psp_payment
Successful PSP payment to which the refund intent is attached.
credit_note
Optional issued credit note used to justify and attach the refund to the corresponding commercial document.
amount
Operation amount in minor monetary units. When optional, the node may use the residual amount defined by its contract.
reason
Business reason for the refund or applied classification.
metadata
Free-form integration metadata associated with the resource according to the flat
common.metadata contract.Outputs 1
psp_refund
PSP-refund intent created in
draft status, still distinct from the actual provider refund.Behavior
The node bounds the refund by the parent PSP payment and, when provided, the associated credit note. When the amount is omitted, the contract may use the available refundable capacity.
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 refund has not yet been executed by the PSP: a separate provider step must materialize the external movement.
- The amount cannot exceed the available refundable capacity of the parent payment.