Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 4.49 KB

tender.md

File metadata and controls

44 lines (35 loc) · 4.49 KB
Raw

Tender

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

Structure

Tender

Fields

Name Type Tags Description
id String Optional The tender's unique ID. It is the associated payment ID.
Constraints: Maximum Length: 192
location_id String Optional The ID of the transaction's associated location.
Constraints: Maximum Length: 50
transaction_id String Optional The ID of the tender's associated transaction.
Constraints: Maximum Length: 192
created_at String Optional The timestamp for when the tender was created, in RFC 3339 format.
Constraints: Maximum Length: 32
note String Optional An optional note associated with the tender at the time of payment.
Constraints: Maximum Length: 500
amount_money Money Hash Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
tip_money Money Hash Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
processing_fee_money Money Hash Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
customer_id String Optional If the tender is associated with a customer or represents a customer's card on file,
this is the ID of the associated customer.
Constraints: Maximum Length: 191
type String (Tender Type) Required Indicates a tender's type.
card_details Tender Card Details Hash Optional Represents additional details of a tender with type CARD or SQUARE_GIFT_CARD
cash_details Tender Cash Details Hash Optional Represents the details of a tender with type CASH.
bank_account_details Tender Bank Account Details Hash Optional Represents the details of a tender with type BANK_ACCOUNT.

See BankAccountPaymentDetails
for more exposed details of a bank account payment.
buy_now_pay_later_details Tender Buy Now Pay Later Details Hash Optional Represents the details of a tender with type BUY_NOW_PAY_LATER.
square_account_details Tender Square Account Details Hash Optional Represents the details of a tender with type SQUARE_ACCOUNT.
additional_recipients Array<Additional Recipient Hash> Optional 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 Optional The ID of the Payment that corresponds to this tender.
This value is only present for payments created with the v2 Payments API.
Constraints: Maximum Length: 192

Example (as JSON)

{
  "id": "id8",
  "location_id": "location_id2",
  "transaction_id": "transaction_id6",
  "created_at": "created_at6",
  "note": "note4",
  "type": "SQUARE_ACCOUNT"
}