<- Object

Object

All versions ->

V1TenderDeprecated

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.

Link to section

Properties

Link to section

id

string

The tender's unique ID.

Link to section

type

string

The type of tender.

Link to section

name

string

A human-readable description of the tender.

Link to section

employee_id

string

The ID of the employee that processed the tender.

Link to section

receipt_url

string

The URL of the receipt for the tender.

Link to section

card_brand

string

The brand of credit card provided.

Link to section

pan_suffix

string

The last four digits of the provided credit card's account number.

Link to section

entry_method

string

The tender's unique ID.

Link to section

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.

Link to section

total_money

The total amount of money provided in this form of tender.

Link to section

tendered_money

The amount of total_money applied to the payment.

Link to section

tendered_at

string

The time when the tender was created, in ISO 8601 format.

Link to section

settled_at

string

The time when the tender was settled, in ISO 8601 format.

Link to section

change_back_money

The amount of total_money returned to the buyer as change.

Link to section

refunded_money

The total of all refunds applied to this tender. This amount is always negative or zero.

Link to section

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.