Skip to main content
Vindicia Knowledge Center

GiftCard Object

GiftCard Object

GiftCard Object

The GiftCard object encapsulates information about a gift card offered by a merchant as a means of paying for a recurring subscription (AutoBill) or a one-time transaction. Payment with a gift card does not involve a monetary transaction. Instead, when you successfully redeem a gift card, CashBox adds credit to an Account or AutoBill. With the credit available to an Account, you can conduct a one-time transaction for that Account. Similarly, an AutoBill deducts credit available to it for every periodically recurring transaction it generates. The AutoBill offers entitlements to the subscriber as long as enough credit is available to sustain the offer. For more information, see the Account.grantCredit method. For more information on how gift cards work within the CashBox system, see Credit Grants and Gift Cards in the CashBox Programming Guide. 

With the redeemGiftCard() method of both the Account and AutoBill objects, you can redeem a gift card against those objects. For example, if you call redeemGiftCard() on an AutoBill object, the credit will be added to the AutoBill. See the Account.redeemGiftCard and AutoBill.redeemGiftCard methods.

CashBox determines how much credit to grant to an AutoBill or an Account by looking up a Product object. Create the Product object in advance in CashBox. The merchantProductId of this Product object should match the SKU (UPC) number returned by the gift card processor company (for example, InComm). The SKU/UPC number the processor returns when a gift card is redeemed is decided by a prior agreement between you and the gift card processor company. Before you start accepting gift cards from your customers, create a Product object in CashBox with a matching merchantProductId. When you create the Product, set its creditsGranted attribute to the amount of credit you want granted when the corresponding gift card is redeemed. See The Product Object for more information.

As discussed in Working with Gift Cards in the CashBox Programming Guide, gift card redemption is a two-step process. In step 1, determine the status of the gift card by calling the statusInquiry() method, discussed below. If the status is Active, in the second step, redeem the card by calling redeemGiftCard() from the Account or AutoBill object.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top