GET /v2/payments
Retrieves a list of payments taken by the account making the request.
Results are eventually consistent, and new payments or changes to payments might take several seconds to appear.
The maximum results per page is 100.
Servers
- https://connect.squareup.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | No |
Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller. |
begin_time |
String | No |
The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. |
sort_order |
String | No |
The order in which results are listed:
|
limit |
Integer | No |
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: |
last_4 |
String | No |
The last four digits of a payment card. |
cursor |
String | No |
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. |
card_brand |
String | No |
The brand of the payment card (for example, VISA). |
end_time |
String | No |
The timestamp for the end of the reporting period, in RFC 3339 format. Default: The current time. |
total |
Integer | No |
The exact amount in the |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.