Sale

post

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

Process Card Present Payment

This API endpoint allows you to initiate a payment transaction by processing a physical card through a payment device.

JSON Description

Section	Name		Type	Description	Required / Optional
Ticket
	id		String	The unique identifier of the ticket.	Required
	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
Customer
		customer_name	String	Name of the customer or guest for the transaction.	Optional
		customer_email	String	Email of the customer or guest for the transaction.	Optional
	totals				Optional
		discounts	Integer	Total discounts in cents.	Optional
		due	Integer	Unpaid total in cents.	Optional
		exclusive_tax	Integer	Taxes not included in prices (cents).	Optional
		inclusive_tax	Integer	Taxes included in prices (cents).	Optional
		items	Integer	Total cost of items (cents).	Optional
		other_charges	Integer	Other charges (taxed).	Optional
		paid	Integer	Total paid (cents).	Optional
		service_charges	Integer	Service charges (not taxed).	Optional
		sub_total	Integer	Subtotal before tax (cents).	Optional
		tax	Integer	Total tax (cents).	Optional
		tips	Integer	Total tips (cents).	Optional
		total	Integer	Final amount to pay (cents).	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	Payment amount in cents.	Required
	cashback		Integer	EBT cashback amount.	Optional
Root	user_id_external		Integer	Links external user to tokenized card.	Optional
Root	webhook_id		String	Unique webhook identifier.	Required
Root	terminal_id		String	POS terminal identifier.	Required
Root	ignoreAvsResult		Boolean	When set to `true`, the transaction will continue processing even if AVS validation fails.	Optional
embedded	ebt_type		String	FOOD_STAMP, CASH_BENEFIT, VOUCHER, INQUIRY_CASH, INQUIRY_FOOD	Optional
discounts			Array
		id	String	Discount ID	Optional
		comment	String	Discount comment	Optional
		name	String	Discount name	Optional
		value	Integer	Discount value (cents)	Optional
Items			Array
		id	String	Item ID	Optional
		inclusive_tax	Integer	Included tax (cents)	Optional
		name	String	Item name	Optional
		price	Integer	Item price (cents)	Optional
		quantity	Integer	Item quantity	Optional
		sent	Boolean	Sent for prep	Optional
		sent_at	Timestamp	Sent timestamp	Optional
		split	Integer	Split denominator	Optional
employee			Object
		check_name	String	Receipt name	Optional
		first_name	String	First name	Optional
		id	String	Employee ID	Optional
		last_name	String	Last name	Optional
		login	String	POS login	Optional
		middle_name	String	Middle name	Optional
		pos_id	String	POS employee ID	Optional
		start_date	String	Start date (YYYY-MM-DD)	Optional
order_type*			Object
		available	Boolean	Can open tickets	Optional
		id	String	Order type ID	Optional
		name	String	Order type name	Optional
		pos_id	String	POS order type ID	Optional
revenue_center			Object
		default	Boolean		Optional
		id	String	Revenue center ID	Optional
		name	String	Revenue center name	Optional
		pos_id	String	POS revenue center ID	Optional
table			Object		Optional
		available	Boolean	Table available	Optional
		id	String	Table ID	Optional
		Name	String	Table name	Optional
		number	Integer	Table number	Optional
		pos_id	String	POS table ID	Optional
		seats	Integer	Seat count	Optional