List payments
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.
Path Parameters
| Name | Description |
|---|---|
location_id
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
|
The order in which payments are listed in the response. |
begin_time
|
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
|
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
|
The maximum number of payments to return in a single response. This value cannot exceed 200. |
batch_token
|
A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
include_partial
|
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}
|
Root array of on V1Payment objects on the response |
Examples
- cURL
curl https://connect.squareup.com/v1/{location_id}/payments \
-H 'Authorization: Bearer ACCESS_TOKEN'