v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

Terminal

CreateTerminalRefund

Creates a request to refund an Interac payment completed on a Square Terminal.

post/v2/terminals/refunds

Request body

idempotency_keystring required

A unique string that identifies this CreateRefund request. Keys can be any valid string but must be unique for every CreateRefund request.

See Idempotency keys for more information.

Example request

{
  "request_body": {
    "idempotency_key": "402a640b-b26f-401f-b406-46f839590c04",
    "refund": {
      "amount_money": {
        "amount": 111,
        "currency": "CAD"
      },
      "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
      "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
      "reason": "Returning items"
    }
  }
}

Response

Success

Example response

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