Event - Payment Refunded
This event is generated when a payment is refunded to a guest who reloads an amount to a gift card, but for some reason it does not go through and the amount is not credited to the card. This includes user payment refunded events 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": "payment_refunded",
"action": "create",
"payload": {
"amount": 30,
"payment_id": 34,
"payment_transaction_type": "Gift Card",
"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"
},
"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 | Integer | Value of the refunded amount |
| payment_id | Integer | Unique ID of the payment generated in the system |
| payment_transaction_type | String | Payment transaction type for recording purposes (i.e., 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 |