V1List payments

GET

/v1/{location_id}/payments

Provides summary information for all payments taken for a given Square account during a date range.

Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates.

Note*: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a created_at value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request.

Permissions:PAYMENTS_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

location_id

string

Required

The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.

Link to section

Query parameters

Link to section

order

string

The order in which payments are listed in the response.

Link to section

begin_time

string

The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

Link to section

end_time

string

The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

Link to section

limit

integer(32-bit)

The maximum number of payments to return in a single response. This value cannot exceed 200.

Link to section

batch_token

string

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Link to section

include_partial

boolean

Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

Link to section

Response fields

Link to section

{items}