Object Index / Definition

You are viewing an old version of the API
Transaction

Deprecated

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

Name Description
id
string

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

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.

created_at
string

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

location_id
string

The ID of the transaction's associated location.

order_id
string

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

product
string

The Square product that processed the transaction.

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.

refunds
Refund [ ]

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

shipping_address
Address

The shipping address provided in the request, if any.

tenders
Tender [ ]

The tenders used to pay in the transaction.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?