Payments

Add a payment to an order

Field	Type	Required	Description
method_id	integer	Yes	The payment method used for the payment. See Payment Methods. Note: You don’t need to include a method_id if your application is an active payment method (configurable in Kounta by Lightspeed’s Add-ons page).
amount	float	Yes	The amount of the payment. Use a negative amount to add a refund.
tip	float	No	* The tip amount.
ref	string	No	A reference for the payment. For examples: Transaction ID: "ref":"INV2-8M9F-B8UN-YQ5S-2G7K" Transaction Information: "ref":"{\"status\":\"APPROVED\",\"referenceId\":\"a888113133\"}"
credit_card_surcharge	float	No	The credit card surcharge amount.

The URI returned in the Location header can only be used to update the payment, as GET and DELETE are not allowed on payments.

* Tip/Service

• A tip/service charge may be applied to an order on POS. This amount will be applied as part of full payment on the order.
• Each payment on the order will automatically contribute an amount towards the tip/service charge. The minimum contribution is based on the tip/service charge as a percentage of the order total.
• Examples
• A $10 order with a 10% tip/service charge for a total of $11. The payments below are for separate orders.
• - A payment of $5 with no tip: $0.45 from the $5 payment will contribute towards the tip/service charge. This leaves $6 remaining to be paid on the order.
• - A payment of $4 with a $0.10 tip (below the minimum contribution): $0.37 from the $4.10 payment will contribute towards the tip/service charge. This leaves $6.90 remaining to be paid on the order.
• - A payment of $4 with a $2 tip (above the maximum tip/service charge owed): $1 of the tip will contribute towards the tip/service charge, and the other $1 will be a standard tip. This leaves $6 remaining to be paid on the order.

Update a payment

This action allows you to add/update reference, a tip or credit_card_surcharge. You may add them in the same API call.

Field	Type	Required
ref	string	No
tip	float	No
credit_card_surcharge	float	No

The 1 in the URI is the number of the payment (see get orders).

Since payments that are already created cannot have their prices modified, a new payment will be created with the amount of $0.00 and the tip amount.