Transaction Events

When subscribed to the Transaction events webhook, the following event data will be received:

`event` object

Field name	Description	JSON Type	Data Type
`id`	The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout.	string
`createdDate`	A timestamp signifying when the event was generated. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`type`	Event type: `transaction`	string
`action`	Event action: `created`	string
`payload`	The payload of the event. The contents of this object depend on the type of event.	object	payload

`payload` object

Field name	Description	JSON Type	Data Type
`transactionDate`	The date/time that the transaction occurred at: `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`businessId`	The business Id of the transaction	string
`businessAlias`	The alias (nickname) of the business	string
`transactionId`	Matches deposit report transaction id. Records only have this column populated if was done using a Vagaro merchant account	string
`userPaymentId`	The unique identifier for the transaction item.	string
`userPaymentsMstId`	Defines unique transaction	string
`brandName`	The brand name of the item sold.	string
`itemSold`	The description of the item sold. Shows services and products	string
`purchaseType`	Purchase type: `Class` `Class Add-Ons` `Fees` `Gift Certificate` `IOU Cleared` `Membership` `Package` `Product` `Refund` `Rent & Fees` `Service` `Service Add-Ons` `Invoice` `Contactless Checkout` `Cancellation Fee` `No-Show Fee` `Vagaro Pay Later`	string
`quantity`	The quantity of items sold	numeric	long
`ccAmount`	Amount paid with credit card	numeric	currency
`cashAmount`	Amount paid with cash	numeric	currency
`checkAmount`	Amount paid with check	numeric	currency
`achAmount`	Amount paid with ACH	numeric	currency
`packageRedemption`	Amount redemption by package.	numeric	currency
`bankAccountAmount`	Amount paid by bank amount (VPL)	numeric	currency
`vagaroPayLaterAmount`	Amount paid with Vagaro Pay Later	numeric	currency
`otherAmount`	Amount paid by other payment method.	numeric	currency
`points`	Amount paid by points	numeric	long
`gcRedemption`	Amount redemption by gift certificate.	numeric	currency
`tax`	Tax amount	numeric	currency
`tip`	Tip amount given	numeric	currency
`discount`	Discount given for transaction:	numeric	currency
`memberShipAmount`	The membership discount amount	numeric	currency
`productDiscount`	Any discount given to a product	numeric	currency
`ccType`	Credit card type used: `Visa` `Master-Card` `Discover` `American Express` `Vagaro Pay Later` `Other`	string
`ccMode`	Credit card mode used: `C: Chip` `E: ACH` `I: Interac` `N: Tap/NFC` `P: Tap to Pay` `S: Swiped` `T: Typed`	string
`customerId`	The customer Id associated with this transaction	string
`serviceProviderId`	The service provider Id	string
`businessGroupId`	A unique identifier for a multilocation group.	string
`amountDue`	Amount due after transaction paid.	numeric	currency
`appointmentId`	The appointment Id associated with the transaction	string
`serviceCategory`	The service category	string
`createdBy`	User that created the transaction	string

Example

{
	"id": "254FA623-D2B0-4785-A07D-A1A7059C74FF",
	"createdDate": "2024-02-15T00:00:00Z",
	"type": "transaction",
	"action": "created",
	"payload": {
		"transactionDate": "2024-02-12T14:37:43.5Z",
		"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
		"transactionId": "a--PdjdyYWJSkudXA2BFK0TkRV7gN2yxC=",
		"userPaymentId": "ZOpfSwCHhVSl1UZJ2p3Pfw==",
		"userPaymentMstId": "ZOpfSwCHhVSl1UZJ2p3Pfw==",
		"brandName": "",
		"itemSold": "Color & Haircut",
		"purchaseType": "Service",
		"quantity": 1,
		"ccAmount": 0.0,
		"cashAmount": 0.0,
		"checkAmount": 0.0,
		"achAmount": 0.0,
		"bankAccountAmount": 0.0,
		"vagaroPayLaterAmount": 0.0,
		"otherAmount": 0.0,
		"pointsAmount": 0,
		"packageRedemption": 0.0,
		"gcRedemption": 0.0,
		"tax": 0.0,
		"tip": 0.0,
		"discount": 0.0,
		"memberShipAmount": 0.0,
		"productDiscount": 0.0,
		"ccType": "",
		"ccMode": "",
		"customerId": "681550E7A9CDA57700B419E351D50D80",
		"serviceProviderId": "D5532D70624D433AD5EA6B5B7A2E5D31",
		"businessGroupId": "tYKEZF-L445YEDnCx0TIfA==",
		"amountDue": 0.0,
		"appointmentId": "2dwfErtmMAFxe6hoCnQStw==",
		"serviceCategory": "Hair Care",
		"createdBy": "GVkX18zRbwyUxRZaHNTYGwjK"
	}
}

event object

payload object

Example

`event` object

`payload` object