Event - Gift Card Redeemed
This event is generated when a guest redeems a gift card by making a payment using the gift card at the POS. These events are triggered as they happen in the Punchh system based on configuration.
{
"content_id": "CONTENT_ID_GOES_HERE",
"timestamp": 1619693178,
"business_id": 6,
"business_uuid": "BUSINESS_UUID_GOES_HERE",
"business_slug": "slugname",
"event_name": "_notifications",
"event_type": "gift_card_redeemed",
"action": "create",
"payload": {
"amount": 0,
"gift_card_balance": "$0.0",
"gift_card_number": null,
"owner_name": "OWNER_NAME_GOES_HERE",
"payment_id": 0,
"receiver_email": null,
"receiver_name": null,
"reloaded_amount": 0,
"reloader_name": null,
"sender_email": null,
"sender_name": null,
"user": {
"account_balance": {
"banked_currency": null,
"current_membership_level_name": "Gold",
"last_visit": "2023-04-29T07:00:33Z",
"loyalty_points": 60,
"net_balance": 20,
"net_debits": 100,
"pending_points": 0,
"total_credits": 120,
"total_debits": "100.0",
"total_lifetime_points": 120,
"total_point_credits": 120,
"total_redeemable_visits": null,
"total_visits": 3,
"unbanked_points": null,
"unredeemed_cards": null,
"user_id": 111111111
},
"anniversary": null,
"avatar_remote_url": null,
"birthday": null,
"email": "test@example.com",
"external_source": "",
"external_source_id": "SOURCE_ID_GOES_HERE",
"first_name": "FIRST_NAME_GOES_HERE",
"gender": "Male",
"guest_type": "Loyalty",
"last_activity_at": "2023-04-29T07:00:33Z",
"last_name": "LAST_NAME_GOES_HERE",
"marketing_email_subscription": true,
"marketing_pn_subscription": true,
"phone": "1111111111",
"preferred_locale": null,
"secondary_email": "test1@example.com",
"signup_channel": "MobileEmail",
"sms_subscription": false,
"unsubscribe_reason": null,
"unsubscribed": false,
"user_id": 111111111,
"user_status": "active"
},
"user_name": "USER_NAME_GOES_HERE"
}
}
Meta Fields
Meta Fields are common attributes such as content_id, timestamp, etc. that are returned in event responses, providing additional information about events. Click here to view the descriptions of the attributes.
Response Parameters
| Payload | ||
| amount | String | Payment made using the gift card |
| gift_card_balance | String | Balance amount on the gift card |
| gift_card_number | String | Unique gift card number as issued by the gift card processor (e.g., Aloha, Valutec, etc.) used by the business |
| owner_name | String | Name of the user who owns the gift card |
| payment_id | String | Unique ID of the payment generated in the system |
| receiver_email | String | Email address of the user |
| receiver_name | String | Name of the gift card user |
| reloaded_amount | Integer | Balance amount added to the gift card |
| reloader_name | String | Name of the user who reloaded the gift card |
| sender_email | String | Email address of the sender of the gift card |
| sender_name | String | Name of the sender of the gift card |
| User | Object | See the user object in Event - Rewards Expiry Reminder |
| user.account_balance | Object | See the account_balance object in Event - Guest |
| user_name | String | Username that identifies the user in the system |