• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Get payment refund

GET /v2/refunds/{refund_id}

Retrieves a specific refund using the refund_id.

Name Description
refund_id
string

Required

The unique ID for the desired PaymentRefund.

Response Fields

Name Description
errors
Error [ ]

Information about errors encountered during the request.

refund
PaymentRefund

The requested PaymentRefund.

Examples

You are viewing an old version of the API
GET /v2/refunds/{refund_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/refunds/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd \
  -H 'Square-Version: 2022-11-16' \
  -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"
  }
}