SquareConnect::V1Tender

Description

A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The tender field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. A note on gift cards*: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A Tender object with a type of SQUARE_GIFT_CARD indicates a gift card was used for some or all of the associated payment.

Properties

Name	Type	Description	Notes
id	String	The tender's unique ID.	[optional]
type	String	The type of tender. See V1TenderType for possible values	[optional]
name	String	A human-readable description of the tender.	[optional]
employee_id	String	The ID of the employee that processed the tender.	[optional]
receipt_url	String	The URL of the receipt for the tender.	[optional]
card_brand	String	The brand of credit card provided. See V1TenderCardBrand for possible values	[optional]
pan_suffix	String	The last four digits of the provided credit card's account number.	[optional]
entry_method	String	The tender's unique ID. See V1TenderEntryMethod for possible values	[optional]
payment_note	String	Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER.	[optional]
total_money	V1Money	The total amount of money provided in this form of tender.	[optional]
tendered_money	V1Money	The amount of total_money applied to the payment.	[optional]
tendered_at	String	The time when the tender was created, in ISO 8601 format.	[optional]
settled_at	String	The time when the tender was settled, in ISO 8601 format.	[optional]
change_back_money	V1Money	The amount of total_money returned to the buyer as change.	[optional]
refunded_money	V1Money	The total of all refunds applied to this tender. This amount is always negative or zero.	[optional]
is_exchange	BOOLEAN	Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange.	[optional]