Object Index / Definition

You are viewing an old version of the API
Tender
V1

Note We recommend using the Square API (V2) for all new development when possible.

Deprecated

A tender represents a discrete monetary exchange.

Properties

Name Description
id
string

The tender's unique ID.

type
string

The type of tender. See V1TenderType for possible values

name
string

A human-readable description of the tender.

employee_id
string

The ID of the employee that processed the tender.

receipt_url
string

The URL of the receipt for the tender.

card_brand
string

The brand of credit card provided. See V1TenderCardBrand for possible values

pan_suffix
string

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

entry_method
string

The tender's unique ID. See V1TenderEntryMethod for possible values

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.

total_money
Money

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

tendered_money
Money

The amount of total_money applied to the payment.

tendered_at
string

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

settled_at
string

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

change_back_money
Money

The amount of total_money returned to the buyer as change.

refunded_money
Money

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

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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?