Object Index / Definition

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.

type
string

Required

The type of tender, such as CARD or CASH.

additional_recipients
Additional​Recipient [ ]

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

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.

card_details
Tender​Card​Details

The details of the card tender.

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

cash_details
Tender​Cash​Details

The details of the cash tender.

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

created_at
string

The time when the tender was created, in RFC 3339 format.

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.

location_id
string

The ID of the transaction's associated location.

note
string

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

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.

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.

tip_money
Money

The tip's amount of the tender.

transaction_id
string

The ID of the tender's associated transaction.

Share Feedback

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