You are viewing an old version of the API
List payment refunds

Retrieves a list of refunds for the account making the request

Max results per page: 100

Required permissions PAYMENTS_READ

Query Parameters

Name Description
begin_time
string

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

Default: The current time minus one year.

end_time
string

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

Default: The current time.

sort_order
string

The order in which results are listed.

  • ASC - oldest to newest
  • DESC - newest to oldest (default).
cursor
string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.

See Pagination for more information.

location_id
string

ID of location associated with payment.

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 status.

source_type
string

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

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

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

Response Fields

Name Description
cursor
string

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

See Pagination for more information.

errors
Error [ ]

Information on errors encountered during the request.

refunds
Payment​Refund [ ]

The list of requested refunds.

Examples

You are viewing an old version of the API
GET /v2/refunds
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/refunds \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
Response JSON
{
  "refunds": [
    {
      "id": "O2QAAhTYs7rUfzlxT38GMO7LvaB_q7JwCHtxmgXrh8fAhV468WQ44VxDtL7CU4yVRlsbXmI",
      "created_at": "2019-07-06T18:01:22.335Z",
      "updated_at": "2019-07-06T18:06:04.653Z",
      "status": "COMPLETED",
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "payment_id": "O2QAAhTYs7rUfzlxT38GMO7LvaB",
      "order_id": "2duiyoqbfeXY0DBi15GEyk5Epa4F",
      "location_id": "XK3DBG77NJBFX",
      "processing_fee": [
        {
          "effective_at": "2019-07-06T20:01:12.000Z",
          "type": "INITIAL",
          "amount_money": {
            "amount": -59,
            "currency": "USD"
          }
        }
      ]
    },
    {
      "id": "8TDIQvFw8PeDIxhSfd5yyX7GuaB_13px5Vrz01qzzuoGzmjsZIxDjfHhbkm2XppBUX1dW7I",
      "created_at": "2019-07-06T17:01:54.232Z",
      "updated_at": "2019-07-06T17:21:04.684Z",
      "status": "COMPLETED",
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "payment_id": "8TDIQvFw8PeDIxhSfd5yyX7GuaB",
      "order_id": "w6EXfEwS03oTQsnZTCqfE6f67e4F",
      "processing_fee": [
        {
          "effective_at": "2019-07-06T19:01:45.000Z",
          "type": "INITIAL",
          "amount_money": {
            "amount": -59,
            "currency": "USD"
          }
        }
      ],
      "location_id": "XK3DBG77NJBFX"
    }
  ],
  "cursor": "5evquW1YswHoT4EoyUhzMmTsCnsSXBU9U0WJ4FU4623nrMQcocH0RGU6Up1YkwfiMcF59ood58EBTEGgzMTGHQJpocic7ExOL0NtrTXCeWcv0UJIJNk8eXb"
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?