Tender

September 24, 2019 ยท View on GitHub

Description

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

Properties

NameTypeDescriptionNotes
idStringThe tender's unique ID.[optional]
locationIdStringThe ID of the transaction's associated location.[optional]
transactionIdStringThe ID of the tender's associated transaction.[optional]
createdAtStringThe time when the tender was created, in RFC 3339 format.[optional]
noteStringAn optional note associated with the tender at the time of payment.[optional]
amountMoneyMoneyThe 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.[optional]
tipMoneyMoneyThe tip's amount of the tender.[optional]
processingFeeMoneyMoneyThe 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.[optional]
customerIdStringIf the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer.[optional]
typeStringThe type of tender, such as `CARD` or `CASH`. See TenderType for possible values
cardDetailsTenderCardDetailsThe details of the card tender. This value is present only if the value of `type` is `CARD`.[optional]
cashDetailsTenderCashDetailsThe details of the cash tender. This value is present only if the value of `type` is `CASH`.[optional]
additionalRecipientsList<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.[optional]
paymentIdStringThe ID of the `Payment` that corresponds to this tender. This value is only present for payments created with the v2 Payments API.[optional]