GET /v2/refunds
Retrieves a list of refunds for the account making the request.
Results are eventually consistent, and new refunds or changes to refunds 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 all locations associated with the seller. |
begin_time |
String | No |
The timestamp for the beginning of the requested reporting period, in RFC 3339 format. 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. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100 |
source_type |
String | No |
If provided, only refunds with the given source type are returned.
Default: If omitted, refunds are returned regardless of the source type. |
status |
String | No |
If provided, only refunds with the given status are returned. For a list of refund status values, see PaymentRefund. Default: If omitted, refunds are returned regardless of their status. |
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. |
end_time |
String | No |
The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. |
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.