Event - Gift Card Auto Reload
This event is generated when a user's gift card is auto reloaded. These events are triggered as they happen in the Punchh system based on configuration.
Users' gift cards are auto-reloaded if the auto-reload setting for gift cards is enabled for the business, and the reload threshold amount and reload default amount values are configured in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration. For more information, see Reload Gift Card.
{
"content_id": "CONTENT_ID_GOES_HERE",
"timestamp": 1619693178,
"business_id": 6,
"business_uuid": "BUSINESS_UUID_GOES_HERE",
"business_slug": "slugname",
"event_name": "transactional_notifications",
"event_type": "gift_card_auto_reload",
"action": "create",
"payload": {
"user_name": "USER_NAME_GOES_HERE",
"gift_card_balance": "$0.0",
"gift_card_number": null,
"owner_name": "OWNER_NAME_GOES_HERE",
"amount": null,
"reloaded_amount": 0,
"receiver_name": null,
"sender_name": null,
"sender_email": null,
"reloader_name": null,
"receiver_email": null,
"payment_id": 0,
"gc_user_auto_reload_default_amount": 4,
"gc_user_auto_reload_threshold_amount": 6,
"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": "DECLINED",
"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"
},
"external_source_id": "",
"external_source": "",
"user_id": 123456789
}
}
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 | Integer | Payment amount that is not updated in the system |
| user_name | String | Username that identifies the user in the system |
| gc_user_auto_reload_default_amount | Float | Default amount with which a gift card will be auto reloaded if its balance is less than the threshold amount set for the gift card |
| gc_user_auto_reload_threshold_amount | Float | Threshold amount represents the minimum gift card balance below which the gift card is eligible for auto-reloading |
| 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_id | Integer | User ID of the user generated in Punchh |
| external_source_id | String | Returns the ID stored in Punchh against the external source. If external_source is not being used or is blank, then it will return Punchh user_id by default. |
| external_source | String | Signifies the external source user identifier ingested from |