Tender
September 24, 2019 ยท View on GitHub
Description
Represents a tender (i.e., a method of payment) used in a Square transaction.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| id | getId() | setId($value) | string | The tender's unique ID. | [optional] |
| location_id | getLocationId() | setLocationId($value) | string | The ID of the transaction's associated location. | [optional] |
| transaction_id | getTransactionId() | setTransactionId($value) | string | The ID of the tender's associated transaction. | [optional] |
| created_at | getCreatedAt() | setCreatedAt($value) | string | The time when the tender was created, in RFC 3339 format. | [optional] |
| note | getNote() | setNote($value) | string | An optional note associated with the tender at the time of payment. | [optional] |
| amount_money | getAmountMoney() | setAmountMoney($value) | \SquareConnect\Model\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. | [optional] |
| tip_money | getTipMoney() | setTipMoney($value) | \SquareConnect\Model\Money | The tip's amount of the tender. | [optional] |
| processing_fee_money | getProcessingFeeMoney() | setProcessingFeeMoney($value) | \SquareConnect\Model\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. | [optional] |
| customer_id | getCustomerId() | setCustomerId($value) | 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. | [optional] |
| type | getType() | setType($value) | string | The type of tender, such as `CARD` or `CASH`. See TenderType for possible values | |
| card_details | getCardDetails() | setCardDetails($value) | \SquareConnect\Model\TenderCardDetails | The details of the card tender. This value is present only if the value of `type` is `CARD`. | [optional] |
| cash_details | getCashDetails() | setCashDetails($value) | \SquareConnect\Model\TenderCashDetails | The details of the cash tender. This value is present only if the value of `type` is `CASH`. | [optional] |
| additional_recipients | getAdditionalRecipients() | setAdditionalRecipients($value) | \SquareConnect\Model\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] |
| payment_id | getPaymentId() | setPaymentId($value) | string | The ID of the `Payment` that corresponds to this tender. This value is only present for payments created with the v2 Payments API. | [optional] |
Note: All properties are protected and only accessed via getters and setters.