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

Retrieves a specific Refund using the refund_id

Required permissions PAYMENTS_READ

Path Parameters

Name Description
refund_id
string

Required

Unique ID for the desired PaymentRefund.

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

refund
Payment​Refund

The requested PaymentRefund.

Examples

You are viewing an old version of the API
GET /v2/refunds/{refund_id}
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/refunds/{refund_id} \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
Response JSON
{
  "refund": {
    "id": "O2QAAhTYs7rUfzlxT38GMO7LvaB_q7JwCHtxmgXrh8fAhV468WQ44VxDtL7CU4yVRlsbXmI",
    "created_at": "2019-07-06T18:01:22.123Z",
    "updated_at": "2019-07-06T18:06:03.874Z",
    "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"
        }
      }
    ]
  }
}

Share Feedback

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