Voids and Reversals

How to undo a load, redeem or activation with the eCard Systems REST API, and how to tell whether a transaction was already reversed.

There are two ways to undo a transaction: reverse it by its request ID, or send a void. Reverse by request ID is the preferred method. This page explains how each works and how to check whether a transaction was already reversed.

Reverse by Request ID (Preferred)

Call POST /v1/{id}/reverse, where {id} is the X-Request-Id you sent on the original transaction. Send a new X-Request-Id header on the reverse request itself.

  • Full amount: the reversal undoes the full amount of the original transaction.
  • Linked to the original: the reversal is tied to the transaction it undoes.
  • Once only: a transaction can be reversed once. A second attempt returns 409.
  • Covers every type: loads, redeems and activations. Void Activation is only available this way.

Void Endpoints

  • POST /v1/gift/load/void voids a load.
  • POST /v1/gift/redeem/void voids a redeem.

A void creates a new transaction for an amount you specify. It is not linked to the original, so it suits partial adjustments.

If your integration uses both reversals and voids, guard against voiding a transaction that was already reversed. The platform does not stop the second correction.

Check Whether a Transaction Was Reversed

Look up the original transaction with GET /v1/{id}, using its X-Request-Id as {id}.

  • current_status shows reversed.
  • reversed_by is also returned.
  • response_status on the original stays approved.

Which Method to Use

SituationUse
Undo a whole load, redeem or activationPOST /v1/{id}/reverse
Undo an activationPOST /v1/{id}/reverse (the only option)
Adjust part of a load or redeemPOST /v1/gift/load/void or POST /v1/gift/redeem/void

For where reversals fit in the full transaction flow, see POS Transaction Flow: End to End.


Did this page help you?