• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Refund updated

EVENT refund.updated

Published when a Refund is updated. Typically the refund.status changes when a refund is completed.

Required permissions: PAYMENTS_READ

Event payload

Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents, "refund.updated".

event_id
string

A unique ID for the webhook event.

created_at
string

Timestamp of when the webhook event was created, in RFC 3339 format.

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

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

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

data
RefundUpdatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "6SSW7HV8K2ST5",
  "type": "refund.updated",
  "event_id": "bc316346-6691-4243-88ed-6d651a0d0c47",
  "created_at": "2020-02-06T22:14:16.421Z",
  "data": {
    "type": "refund",
    "id": "KkAkhdMsgzn59SM8A89WgKwekxLZY_ptNBVqHYxt5gAdfcobBe4u1AZsXhoz06KTtuq9Ls24P",
    "object": {
      "refund": {
        "id": "KkAkhdMsgzn59SM8A89WgKwekxLZY_ptNBVqHYxt5gAdfcobBe4u1AZsXhoz06KTtuq9Ls24P",
        "created_at": "2020-02-06T21:27:41.836Z",
        "updated_at": "2020-02-06T22:14:16.381Z",
        "amount_money": {
          "amount": 1000,
          "currency": "USD"
        },
        "status": "COMPLETED",
        "processing_fee": [
          {
            "effective_at": "2020-02-06T23:27:31.000Z",
            "type": "INITIAL",
            "amount_money": {
              "amount": -59,
              "currency": "USD"
            }
          }
        ],
        "location_id": "NAQ1FHV6ZJ8YV",
        "order_id": "haOyDuHiqtAXMk0d8pDKXpL7Jg4F",
        "payment_id": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
        "version": 10
      }
    }
  }
}

Share Feedback

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