You are viewing an old version of the API

All Versions

Cancel terminal refund

POST /v2/terminals/refunds/{terminal_refund_id}/cancel

Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.

Permissions

PAYMENTS_WRITE

Guide

Cancel a Terminal refund Try in API Explorer

Path Parameters

Example code

Name	Description
`terminal_refund_id string` Required	The unique ID for the desired `TerminalRefund`.

Request Body

Name	Description

Response Fields

Name	Description
`errors Error [ ]`	Information about errors encountered during the request.
`refund TerminalRefund`	The updated `TerminalRefund`.

Examples

POST /v2/terminals/refunds/{terminal_refund_id}/cancel

curl https://connect.squareup.com/v2/terminals/refunds/terminal_refund_id0/cancel \
  -X POST \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

{
  "refund": {
    "id": "g6ycb6HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY",
    "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
    "amount_money": {
      "amount": 100,
      "currency": "CAD"
    },
    "reason": "reason",
    "device_id": "42690809-faa2-4701-a24b-19d3d34c9aaa",
    "deadline_duration": "PT5M",
    "status": "CANCELED",
    "cancel_reason": "SELLER_CANCELED",
    "created_at": "2020-10-21T22:47:23.241Z",
    "updated_at": "2020-10-21T22:47:30.096Z",
    "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"
  }
}