• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Tender

Represents a tender (i.e., a method of payment) used in a Square transaction.

Properties

Name Description
id
string

The tender's unique ID.

Max Length 192
location_id
string

The ID of the transaction's associated location.

Max Length 50
transaction_id
string

The ID of the tender's associated transaction.

Max Length 192
created_at
string

Read only The timestamp for when the tender was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Max Length 32
note
string

An optional note associated with the tender at the time of payment.

Max Length 500
amount_money
Money

The total amount of the tender, including tip_money. If the tender has a payment_id, the total_money of the corresponding Payment will be equal to the amount_money of the tender.

tip_money
Money

The tip's amount of the tender.

processing_fee_money
Money

The amount of any Square processing fees applied to the tender.

This field is not immediately populated when a new transaction is created. It is usually available after about ten seconds.

customer_id
string

If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer.

Max Length 191
type
string

Required

The type of tender, such as CARD or CASH.

card_details
TenderCardDetails

The details of the card tender.

This value is present only if the value of type is CARD.

cash_details
TenderCashDetails

The details of the cash tender.

This value is present only if the value of type is CASH.

additional_recipients
AdditionalRecipient [ ]

Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration.

payment_id
string

The ID of the Payment that corresponds to this tender. This value is only present for payments created with the v2 Payments API.

Max Length 192

Share Feedback

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