Object Index
/ Definition
You are viewing an old version of the API
Tender
V1
Object Index / Definition
Note We recommend using the Square API (V2) for all new development when possible.
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 receipturl 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 receipturl 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 | Description |
|---|---|
id
|
The tender's unique ID. |
card_brand
|
The brand of credit card provided. |
change_back_money
|
The amount of total_money returned to the buyer as change. |
employee_id
|
The ID of the employee that processed the tender. |
entry_method
|
The tender's unique ID. |
is_exchange
|
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. |
name
|
A human-readable description of the tender. |
pan_suffix
|
The last four digits of the provided credit card's account number. |
payment_note
|
Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. |
receipt_url
|
The URL of the receipt for the tender. |
refunded_money
|
The total of all refunds applied to this tender. This amount is always negative or zero. |
settled_at
|
The time when the tender was settled, in ISO 8601 format. |
tendered_at
|
The time when the tender was created, in ISO 8601 format. |
tendered_money
|
The amount of total_money applied to the payment. |
total_money
|
The total amount of money provided in this form of tender. |
type
|
The type of tender. |