Get payment refund

GET

/v2/refunds/{refund_id}

Retrieves a specific refund using the refund_id.

Permissions:PAYMENTS_READ

Guide

Retrieve refund information

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

refund_id

string

Required

The unique ID for the desired PaymentRefund.

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

refund

The requested PaymentRefund.

Link to section

Examples

GET /v2/refunds/{refund_id}

curl https://connect.squareup.com/v2/refunds/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "refund": {
    "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd",
    "status": "COMPLETED",
    "amount_money": {
      "amount": 555,
      "currency": "USD"
    },
    "payment_id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
    "order_id": "9ltv0bx5PuvGXUYHYHxYSKEqC3IZY",
    "created_at": "2021-10-13T19:59:05.073Z",
    "updated_at": "2021-10-13T20:00:02.442Z",
    "processing_fee": [
      {
        "effective_at": "2021-10-13T21:34:35.000Z",
        "type": "INITIAL",
        "amount_money": {
          "amount": -34,
          "currency": "USD"
        }
      }
    ],
    "location_id": "L88917AVBK2S5",
    "reason": "Example Refund"
  }
}