Gift Card Attributes
| Name | Type | Description |
|---|---|---|
| object | string | Value is “GiftCard” |
| vid | string | A Globally Unique Identifier (GUID) for this object. Assigned by Subscribe. |
| last_digits | string | The last four digits of the pin. This is a read-only entry. |
| pin_length | integer | The length of the pin that was provided. This is a read-only entry |
| hash_type | enum | The type of encryption used for masking the pin. Can be md5 or sha1. |
| pin_hash | string | A hash of the gift card pin. The gift card’s pin number is a number on the card that is hidden and must be revealed for redemption. It is used to uniquely identify the gift card with the payment provider and is stored in the system as a secure encrypted number. |
| payment_provider | string | The payment processor responsible for gift card redemptions. This is a read-only entry returned by Vindicia based on Merchant configuration. |
| amount | decimal | The numerical value of the gift card. Together with the currency provides the worth of the gift card. |
| currency | string | ISO 4217 Currency Code of the gift card |
| Status | enum | The status of the gift card. Values can be:- Active: The gift card is active and the amount on it is available. - Redeemed: The gift card has been successfully redeemed. - Deactive: The gift card is inactive and cannot be redeemed. - Suspended: The gift card is suspended and cannot be redeemed. - RedemptionPending: The gift card is in a redemption process but has not yet been redeemed. |
| product_number | string | The gift card product number (account number). This number is visible on the gift card and is not considered a secure parameter. Note: This is a payment provider specific parameter and is not related to Vindicia’s (SKU) Product ID. |
Example Object
{
"object": "GiftCard",
"vid": "8d1ece91e44441c3d424717c561dc8df74c4b5e4",
"last_digits": "9FSE",
"pin_length": 16,
"hash_type": "sha1",
"pin_hash": "b535aae49e30398c710989a79d56306e9ec0f309",
"payment_provider": "Topps",
"status": "Active",
"amount": 500,
"currency": "MXN",
"product_number": "91422282643651081111"
}