SquareConnect::Transaction

April 10, 2019 ยท View on GitHub

Description

Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale. The tenders field of this object lists all methods of payment used to pay in the transaction.

Properties

NameTypeDescriptionNotes
idStringThe transaction's unique ID, issued by Square payments servers.[optional]
location_idStringThe ID of the transaction's associated location.[optional]
created_atStringThe time when the transaction was created, in RFC 3339 format.[optional]
tendersArray<Tender>The tenders used to pay in the transaction.[optional]
refundsArray<Refund>Refunds that have been applied to any tender in the transaction.[optional]
reference_idStringIf the transaction was created with the Charge endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set.[optional]
productStringThe Square product that processed the transaction. See TransactionProduct for possible values[optional]
client_idStringIf the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale. This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode). It is not currently possible with the Connect API to perform a transaction lookup by this value.[optional]
shipping_addressAddressThe shipping address provided in the request, if any.[optional]
order_idStringThe order_id is an identifier for the order associated with this transaction, if any.[optional]