v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

Refunds

ListPaymentRefunds

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.

get/v2/refunds

Query parameters

begin_timestring

The timestamp for the beginning of the requested reporting period, in RFC 3339 format.

Default: The current time minus one year.

end_timestring

The timestamp for the end of the requested reporting period, in RFC 3339 format.

Default: The current time.

sort_orderstring

The order in which results are listed:

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

cursorstring

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.

location_idstring

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

statusstring

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.

source_typestring

If provided, only refunds with the given source type are returned.

CARD - List refunds only for payments where CARD was specified as the payment source.

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

limitinteger

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

Response

Success

cursorstring

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

For more information, see Pagination.

Example response

{
  "cursor": "5evquW1YswHoT4EoyUhzMmTsCnsSXBU9U0WJ4FU4623nrMQcocH0RGU6Up1YkwfiMcF59ood58EBTEGgzMTGHQJpocic7ExOL0NtrTXCeWcv0UJIJNk8eXb",
  "refunds": [
    {
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "created_at": "2019-07-06T18:01:22.335Z",
      "id": "O2QAAhTYs7rUfzlxT38GMO7LvaB_q7JwCHtxmgXrh8fAhV468WQ44VxDtL7CU4yVRlsbXmI",
      "location_id": "XK3DBG77NJBFX",
      "order_id": "2duiyoqbfeXY0DBi15GEyk5Epa4F",
      "payment_id": "O2QAAhTYs7rUfzlxT38GMO7LvaB",
      "processing_fee": [
        {
          "amount_money": {
            "amount": -59,
            "currency": "USD"
          },
          "effective_at": "2019-07-06T20:01:12.000Z",
          "type": "INITIAL"
        }
      ],
      "status": "COMPLETED",
      "updated_at": "2019-07-06T18:06:04.653Z"
    },
    {
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "created_at": "2019-07-06T17:01:54.232Z",
      "id": "8TDIQvFw8PeDIxhSfd5yyX7GuaB_13px5Vrz01qzzuoGzmjsZIxDjfHhbkm2XppBUX1dW7I",
      "location_id": "XK3DBG77NJBFX",
      "order_id": "w6EXfEwS03oTQsnZTCqfE6f67e4F",
      "payment_id": "8TDIQvFw8PeDIxhSfd5yyX7GuaB",
      "processing_fee": [
        {
          "amount_money": {
            "amount": -59,
            "currency": "USD"
          },
          "effective_at": "2019-07-06T19:01:45.000Z",
          "type": "INITIAL"
        }
      ],
      "status": "COMPLETED",
      "updated_at": "2019-07-06T17:21:04.684Z"
    }
  ]
}