Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Developer blog
  • YouTube
  • X
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2026 Square, Inc.

  • Developer terms of service
  • Developer Integration and Marketing Agreement
  • Privacy policy
  • Partnerships
  • Sign In
  • Sign In

    Terminal

  • Create terminal action

  • Search terminal actions

  • Get terminal action

  • Cancel terminal action

  • Dismiss terminal action

  • Create terminal checkout

  • Search terminal checkouts

  • Get terminal checkout

  • Cancel terminal checkout

  • Dismiss terminal checkout

  • Create terminal refund

  • Search terminal refunds

  • Get terminal refund

  • Cancel terminal refund

  • Dismiss terminal refund

  • Webhooks

  • terminal.action.created

  • terminal.action.updated

  • terminal.checkout.created

  • terminal.checkout.updated

  • terminal.refund.created

  • terminal.refund.updated

<- Terminal webhooks

Terminal webhooks

All versions ->

terminal refund created

EVENT

 terminal.refund.created

Published when a Terminal API refund is created.

Permissions:PAYMENTS_READ
Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the target merchant associated with the event.

Link to section

type

string

The type of event this represents, "terminal.refund.created".

Link to section

event_id

string

A unique ID for the event.

Link to section

created_at

string

Read only RFC 3339 timestamp of when the event was created.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

Data associated with the event.

Link to section

Examples

All versions ->

Response JSON

{ "merchant_id": "7NZR58EPNGNPC", "type": "terminal.refund.created", "event_id": "9232cde1-6e72-4356-8b08-bd2af7bb87a2", "created_at": "2020-09-22T14:29:19.459Z", "data": { "type": "refund", "id": "S67MS3HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY", "object": { "refund": { "amount_money": { "amount": 100, "currency": "CAD" }, "app_id": "sq0idp-734Md5EcFjFmwpaR0Snm6g", "card": { "bin": "411111", "card_brand": "INTERAC", "card_type": "CREDIT", "exp_month": 12, "exp_year": 2020, "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw", "last_4": "1111" }, "card_details": { "avs_status": "AVS_NOT_CHECKED", "card": { "bin": "411111", "card_brand": "INTERAC", "card_type": "CREDIT", "exp_month": 12, "exp_year": 2020, "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw", "last_4": "1111" }, "cvv_status": "CVV_NOT_CHECKED", "entry_method": "EMV", "statement_description": "SQ *DEFAULT TEST ACCOUNT", "status": "CAPTURED" }, "created_at": "2020-09-22T14:29:19.459Z", "deadline_duration": "PT5M", "device_id": "907CS13101300122", "id": "S67MS3HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY", "location_id": "A6SYFRSV4WAFW", "order_id": "9VeViC6PeooYw4GVAgiuEMseV", "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", "reason": "Refund reason", "status": "PENDING", "updated_at": "2020-09-22T14:29:19.459Z" } } } }