Skip to main content
Vindicia Knowledge Center

GiftCard Data Members

GiftCard Data Members

GiftCard Data Members

The following table lists and describes the data members of the GiftCard object.

Data Members

Data Type

Description

hashType

HashType

(This data member is not in use.)

lastDigits

string

Read-only. Last four digits of a gift card’s PIN. Do not populate this attribute; CashBox may populate this attribute when it returns a GiftCard object to you. For security, use this field for display to avoid displaying the entire PIN.

paymentProvider

string

Gift card processor company that CashBox should contact to check the status of a gift card and redeem the gift card. If left blank, this field defaults to InComm.CashBox supports only gift cards redeemable by InComm, Inc.

pin

string

Unique number associated with each gift card. A customer redeeming a gift card must give you this number. Populate this attribute in the GiftCard object when you check the status of the card for the first time. CashBox then creates a new record for this card in its system and assigns it a VID. For your subsequent calls that need to refer to this gift card, you need not populate the pin. Specifying only the VID will suffice.

pinHash

string

(This data member is not in use.)

pinLength

integer

Read-only. Number of characters or digits in the PIN of the gift card. Do not populate this attribute; CashBox may populate this attribute when it returns a GiftCard object to you.

product

Product

Read-only. Credit to add to the AutoBill or Account for which the card was redeemed, as specified by the Product object’s creditsGranted attribute. CashBox populates this attribute in the GiftCard object it returns to you in response to a successful redeemGiftCard() call. The merchantProductId of this object matches the SKU/UPC returned by the gift card processor.

See Product Data Members.

sku

string

Read-only. Unique ID (UPC) the gift card processor returns when CashBox redeems a specific type of gift card. Do not populate this attribute; CashBox may populate this attribute when it returns a GiftCard object to you when you call redeemGiftCard().

You must have previously created a Product object in CashBox with a merchantProductId matching each SKU you expect the processor to return, before redeeming gift cards.

status

GiftCardStatus

Read-only. Status of this gift card. CashBox populates this attribute in the GiftCard object returned to you when GiftCard is queried or changed as a result of calling statusInquiry, redeemGiftCard, or reverse.

See the GiftCardStatus Subobject.

VID

string

Vindicia's Globally Unique Identifier (GUID) for this object. When creating a new GiftCard object, leave this field blank; it will be automatically populated by CashBox.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top