Get terminal refundBeta

GET

/v2/terminals/refunds/{terminal_refund_id}

Retrieves an Interac terminal refund object by ID.

Permissions:PAYMENTS_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

terminal_refund_id

string

Required

Beta

Unique ID for the desired TerminalRefund

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

refund

The requested Refund

Link to section

Examples

All versions ->

GET /v2/terminals/refunds/{terminal_refund_id}

curl https://connect.squareup.com/v2/terminals/refunds/terminal_refund_id0 \
  -H 'Square-Version: 2020-10-28' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "refund": {
    "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY",
    "refund_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb",
    "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
    "amount_money": {
      "amount": 111,
      "currency": "CAD"
    },
    "reason": "Returning item",
    "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
    "deadline_duration": "PT5M",
    "status": "COMPLETED",
    "created_at": "2020-09-29T15:21:46.771Z",
    "updated_at": "2020-09-29T15:21:48.675Z",
    "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ",
    "card": {
      "card_brand": "INTERAC",
      "last_4": "1111",
      "exp_month": 1,
      "exp_year": 2022,
      "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw",
      "card_type": "CREDIT",
      "bin": "411111"
    },
    "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY",
    "location_id": "76C9W6K8CNNQ5"
  }
}