Void Transaction

POST /client/users/:correlation_id/void

This request completely voids a given transaction. Note that currently, only ADHOC_REWARD and ADHOC_REDEEM transaction types can be voided.

Request

Attribute	Definition	Format	Notes
originalTransactionId	Original transaction ID	String	Required
externalReferenceId	Reference identifier for this transaction in client’s system.	Enum: "EXTERNAL_ID"	Optional
channel	The channel value with which this transaction should be associated.	String	Optional. For example, "SYSTEM", "CONSOLE", "POS", "STORE", "APP", "ONLINE", "PARTNER", "WEBSITE"

Attribute	Definition	Format	Notes
transactionId	Unique identifier for the void transaction	String
message	Success message	String

statusCode	errorMessage	errorCode	Definition
400 Bad Request	Void transactions not supported	INVALID_REQUEST	Void transactions are not enabled.
400 Bad Request	originalTransactionId is mandatory and required to be non-empty.	MISSING_REQUIRED_FIELDS_ERROR	originalTransactionId must be included in request and must contain a valid identifier for the original transaction.
400 Bad Request	Original transaction belongs to another member	INVALID_REQUEST	The original transaction provided belongs to another member.
400 Bad Request	Original transaction was already voided	INVALID_REQUEST	The given original transaction was already voided.
400 Bad Request	Void transaction not allowed	INVALID_REQUEST	Void is not allowed for the request action of the given original transaction. For example, void is allowed for ADHOC_REWARD and ADHOC_REDEEM transactions, but the original transaction has request action 'FINALIZE'.
400 Bad Request	Transaction is older than {adjustmentPeriod} days.	INVALID_REQUEST	The void transaction date is after the allowed adjustment period for the original transaction.

400 - Void Not Allowed for Original Transaction's Request Action