Webhook Refund

post

https://sandbox-api.softpoint.io/interface/{version}/locations/{location_id}/webhook/refund

This API endpoint allows you to process a refund for a previously authorized or completed payment. By providing the original transaction details, this call will refund the payment by returning the specified amount back to the customer's card.

The refund can be a full or partial.

Json Description:

Section	Name		Type	Description	Required / optional
Ticket
	id		String	The unique identifier of the ticket.	Optional
	name		String	The name of the ticket.	Optional
	open		Boolean	Indicates whether the ticket is still open or not	Optional
	opened_at		Timestamp	The timestamp at which the ticket was opened.	Optional
	closed_at		Timestamp	The timestamp at which the ticket was closed.	Optional
	ticket_number		Integer	The ticket number.	Optional
	totals				Optional
		discounts	Integer	The sum total value in cents of all ticket-level discounts.	Optional
		due	Integer	The unpaid total in cents of the ticket (total - paid).	Optional
		exclusive_tax	Integer	The sum total cost in cents of all taxes not included in item or service charge prices on the ticket.	Optional
		inclusive_tax	Integer	The sum total cost in cents of all taxes included in item or service charge prices on the ticket.	Optional
		Items	Integer	The sum total cost in cents of all items on the ticket.	Optional
		other_charges	Integer	The sum total cost in cents of all other charges on the ticket. Other charges are taxed.	Optional
		paid	Integer	The total amount in cents paid.	Optional
		service_charges	Integer	The sum total cost in cents of all service charges on the ticket. Service charges are not taxed.	Optional
		sub_total	Integer	The subtotal in cents before tax (items + other_charges - discounts).	Optional
		tax	Integer	The total tax in cents on the ticket.	Optional
		tips	Integer	The total value in cents of applied tips.	Optional
		total	Integer	The final amount in cents to be paid (subtotal + service_charges + exclusive_tax).	Optional
	void		Boolean	Whether or not the ticket is voided.	Optional
	_embedded		Array		Optional
payment
	id		String	Unique identifier for the payment.	Required
	amount		Integer	The amount in cents for the payment.	Required
webhook_id			String	Unique identifier for the webhook.	Required
terminal_id			String	Unique identifier for the POS terminal.	Required

embedded		Type	Description	Required / optional
discounts		Array
	id	String	The unique identifier of the discount.	Optional
	comment	String	The comment on the discount	Optional
	name	String	The discount name as it appears on the ticket.	Optional
	value	Integer	The value of the discount, in cents.	Optional
Items		Array
	id	String	The unique identifier of the item.	Optional
	inclusive_tax	Integer	The tax amount included in the price of the item in cents.	Optional
	name	String	The name of the item.	Optional
	price	Integer	The full cost of the item in cents, including quantity and all modifiers and discounts.	Optional
	quantity	Integer	The numerator of the quantity of items on the ticket.	Optional
	sent	Boolean	Whether the item has been sent for prep.	Optional
	sent_at	Timestamp	The timestamp when the item was sent for prep.	Optional
	split	Integer	The denominator of the quantity of items on the ticket.	Optional
	Item_embedded	Array		Optional
employee		object
	check_name	String	The name of the employee as it appears on receipts.	Optional
	first_name	String	The first name of the employee.	Optional
	id	String	The unique identifier of the employee.	Optional
	last_name	String	The last name of the employee.	Optional
	login	String	The pin the employee uses to log into the POS terminal.	Optional
	middle_name	String	The middle name of the employee.	Optional
	pos_id	String	The Employee ID as it appears to POS admins.	Optional
	start_date	String	The date the employee started work, formatted as "YYYY-MM-DD"	Optional
order_type*		object
	available	Boolean	Whether or not tickets can be opened under the order type.	Optional
	id	String	The unique identifier of the Order Type.	Optional
	name	String	The name of the order type.	Optional
	pos_id	String	The Order Type ID as displayed to POS admins.	Optional
revenue_center		object
	default	Boolean		Optional
	id	String	The unique identifier of the Revenue Center.	Optional
	name	String	The Revenue Center name.	Optional
	pos_id	String	The Revenue Center ID displayed to POS admins.	Optional
table		object	Optional
	available	Boolean	Whether or not the table is available for seating	Optional
	id	String	The unique identifier of the table.	Optional
	Name	String	The table name	Optional
	number	Integer	The table number	Optional
	pos_id	String	The Table displayed to POS admins.	Optional
	seats	Integer	The number of seats at the table.	Optional
payment*		Array
	id	String	The unique identifier of the payment.(if any)	Optional
	amount	Integer	The payment amount in case there is any	Optional
	tender_types_id	Integer	The ternder id that was applied	Optional
	tip	Integer	The tip that was paid	Optional

Item embedded		Type	Description	Required / optional
modifier		Array
	id	Integer	The unique identifier of the modifier.	Optional
	name	String	The name of the modifier	Optional
	price	Integer	The price of the modifier	Optional
	quantity	Integer	The quantity of the modifiers	Optional
	comment	String	The comment attached to the modifier	Optional