<- Transactions API

Transactions API

All versions ->

List transactions

DEPRECATED

 /v2/locations/{location_id}/transactions

Lists transactions for a particular location.

Transactions include payment information from sales and exchanges and refund information from returns and exchanges.

Max results per page: 50

Permissions:PAYMENTS_READ

Deprecation date

2019-08-15

Retirement date

TBD

Replaced by

SearchOrders

Migration guide
Link to section

Path parameters

Example code

Link to section

location_id

string

Required

The ID of the location to list transactions for.

Link to section

Query parameters

Link to section

begin_time

string

The beginning of the requested reporting period, in RFC 3339 format.

See Date ranges for details on date inclusivity/exclusivity.

Default value: The current time minus one year.

Link to section

end_time

string

The end of the requested reporting period, in RFC 3339 format.

See Date ranges for details on date inclusivity/exclusivity.

Default value: The current time.

Link to section

sort_order

string

The order in which results are listed in the response (ASC for oldest first, DESC for newest first).

Default value: DESC

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.

See Paginating results for more information.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

transactions

An array of transactions that match your query.

Link to section

cursor

string

A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the cursor parameter in a subsequent request to this endpoint.

See Paginating results for more information.