<- Refunds API

Refunds API

All versions ->

List payment refunds

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.

Permissions:PAYMENTS_READ

Guide

Retrieve Payments and Refunds

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

begin_time

string

Indicates the start of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the created_at field for each PaymentRefund.

Default: The current time minus one year.

Link to section

end_time

string

Indicates the end of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the created_at field for each PaymentRefund.

Default: The current time.

Link to section

sort_order

string

The order in which results are listed by PaymentRefund.created_at:

  • ASC - Oldest to newest.
  • DESC - Newest to oldest (default).
Link to section

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.

Link to section

location_id

string

Limit results to the location supplied. By default, results are returned for all locations associated with the seller.

Link to section

status

string

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.

Link to section

source_type

string

If provided, only returns refunds whose payments have the indicated source type. Current values include CARD, BANK_ACCOUNT, WALLET, CASH, and EXTERNAL. For information about these payment source types, see Take Payments.

Default: If omitted, refunds are returned regardless of the source type.

Link to section

limit

integer(32-bit)

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

Link to section

updated_at_begin_time

string

Indicates the start of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the updated_at field for each PaymentRefund.

Default: If omitted, the time range starts at begin_time.

Link to section

updated_at_end_time

string

Indicates the end of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the updated_at field for each PaymentRefund.

Default: The current time.

Link to section

sort_field

string

The field used to sort results by. The default is CREATED_AT.

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

refunds

The list of requested refunds.

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

For more information, see Pagination.