Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
V1Transactions

ListPayments

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.

get/v1/{location_id}/payments

Path parameters

location_idstring 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

orderstring

The order in which payments are listed in the response.

begin_timestring

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_timestring

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.

limitinteger

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

batch_tokenstring

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

include_partialboolean

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

Success

created_atstring

The time when the payment was created, in ISO 8601 format. Reflects the time of the first payment if the object represents an incomplete partial payment, and the time of the last or complete payment otherwise.

creator_idstring

The unique identifier of the Square account that took the payment.

idstring

The payment's unique identifier.

is_partialboolean

Indicates whether or not the payment is only partially paid for. If true, this payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

merchant_idstring

The unique identifier of the merchant that took the payment.

payment_urlstring

The URL of the payment's detail page in the merchant dashboard. The merchant must be signed in to the merchant dashboard to view this page.

receipt_urlstring

The URL of the receipt for the payment. Note that for split tender payments, this URL corresponds to the receipt for the first tender listed in the payment's tender field. Each Tender object has its own receipt_url field you can use to get the other receipts associated with a split tender payment.