Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
24 lines (17 loc) · 2.13 KB

Transaction.md

File metadata and controls

24 lines (17 loc) · 2.13 KB

Transaction

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. Note: This model is deprecated.

Properties

Name Type Description Notes
id String The transaction's unique ID, issued by Square payments servers. [optional]
locationId String The ID of the transaction's associated location. [optional]
createdAt String The time when the transaction was created, in RFC 3339 format. [optional]
tenders List<Tender> The tenders used to pay in the transaction. [optional]
refunds List<Refund> Refunds that have been applied to any tender in the transaction. [optional]
referenceId 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. [optional]
product String The Square product that processed the transaction. See TransactionProduct for possible values [optional]
clientId 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. [optional]
shippingAddress Address The shipping address provided in the request, if any. [optional]
orderId String The order_id is an identifier for the order associated with this transaction, if any. [optional]