Reversal

Use Reversal to undo a prior impact transaction when a customer refund or cancellation occurs. A reversal call creates a linked record that negates the original amounts for clear, auditable reconciliation.

In post‑purchase implementations (ImpactPay), ekko processes the payment and will handle any reversals on your behalf.

ℹ️

See the API reference for example payloads.

What it does

• Reverses a previous compensation or contribution made via the Funds endpoint
• Returns a new referenceId for the reversal event
• Links the reversal to the original transaction for end‑to‑end auditability (see Impact Records).

Key fields explained

• Request reference → The ekko transaction reference from the original funds call you are reversing.
• Response reference → The new reference for the reversal record.

Behaviour in Impact Records

• Reversal entries are returned alongside regular impact transactions.
• Reversals carry negative values for monetary fields (e.g., impactAmount, serviceFee, fee shares) so sums net out correctly.
• Each reversal includes originalTransactionReferenceId to tie it back to the source transaction.

Best practices

• Only reverse what happened: Trigger reversals after you refund/void the underlying payment to keep finance and impact ledgers aligned.
• Preserve references: Store both the original reference and the reversal’s new reference for reconciliation and support.
• Rely on hosted flows: If you use ImpactPay hosted journeys, let ekko manage reversals.