<- Object

Object

All versions ->

TransactionDeprecated

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.

Link to section

Properties

Link to section

id

string

The transaction's unique ID, issued by Square payments servers.

Link to section

location_id

string

The ID of the transaction's associated location.

Link to section

created_at

string

The timestamp for when the transaction was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

tenders

The tenders used to pay in the transaction.

Link to section

refunds

Refunds that have been applied to any tender in the transaction.

Link to section

reference_id

string

If 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.

Link to section

product

string

The Square product that processed the transaction.

Link to section

client_id

string

If 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.

Link to section

shipping_address

The shipping address provided in the request, if any.

Link to section

order_id

string

The order_id is an identifier for the order associated with this transaction, if any.