You are viewing an old version of the API
List payments
V1

Note We recommend using the Square API (V2) for all new development when possible.

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.

Required permissions PAYMENTS_READ

Path Parameters

Name Description
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.

Query Parameters

Name Description
order
string

The order in which payments are listed in the response.

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.

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.

limit
integer

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

batch_token
string

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

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.

Response Fields

Name Description
{items}
V1​Payment [ ]

Root array of on V1Payment objects on the response

Examples

You are viewing an old version of the API
GET /v1/{location_id}/payments
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/payments \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

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