VoidType Property
Identifies the type of void to execute.
Syntax
public int getVoidType(); public void setVoidType(int voidType);
Enumerated values: public final static int vtRedemption = 0; public final static int vtLoad = 1; public final static int vtActivation = 2;
Remarks
This property is used by the VoidTransaction method to indicate the type of transaction which is to be voided. Valid void types include:
| vtRedemption (0) | This is used to void a purchase performed on a gift card using the RedeemCard method. It works to void regular redemptions, partial redemptions, and cashouts. A call to VoidTransaction will add the TransactionAmount back to the gift card balance. When voiding a partial redemption or cash out, the TransactionAmount must equal the actual value that was approved in the redemption, not the amount requested. |
| vtLoad (1) | This voids a load, reload, refund or adjustment that was made with the LoadCard method. The TransactionAmount is removed from the current balance of the gift card account. |
| vtActivation (2) | This voids the activation of the gift card made with ActivateCard, and changes the card's status back to inactive. If a financial transaction has been completed on the gift card (for instance, a redemption or load), the activation cannot be voided unless all transactions since the activation are also voided. |
Default Value
0