Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
20 lines (15 loc) · 1.83 KB

ListPaymentsRequest.md

File metadata and controls

20 lines (15 loc) · 1.83 KB

SquareConnect.ListPaymentsRequest

Description

Retrieves a list of payments taken by the account making the request. The maximum results per page is 100.

Properties

Name Type Description Notes
begin_time String The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. [optional]
end_time String The timestamp for the end of the reporting period, in RFC 3339 format. Default: The current time. [optional]
sort_order String The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default). [optional]
cursor String A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see Pagination. [optional]
location_id String Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller. [optional]
total Number The exact amount in the `total_money` for a payment. [optional]
last_4 String The last four digits of a payment card. [optional]
card_brand String The brand of the payment card (for example, VISA). [optional]
limit Number The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100` [optional]