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

Invoice refunded BETA

EVENT invoice.refunded

Published when a refund is applied towards a payment of an Invoice.


Permissions
INVOICES_READ
Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents, "invoice.refunded".

event_id
string

A unique ID for the webhook event.

created_at
string

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

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

data
InvoiceRefundedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "031FEV2Q6VMPK",
  "location_id": "ES0RJRZYEC39A",
  "type": "invoice.refunded",
  "event_id": "aedeb1fb-6c7d-4484-8106-866d97652388",
  "created_at": "2020-06-18T18:23:11Z",
  "data": {
    "type": "invoice",
    "id": "gt2zv1z6mnUm1V7KMxxf3w",
    "object": {
      "invoice": {
        "id": "gt2zv1z6mnUm1V7KMxxf3w",
        "version": 4,
        "location_id": "ES0RJRZYEC39A",
        "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
        "payment_requests": [
          {
            "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355",
            "request_type": "BALANCE",
            "due_date": "2030-01-24",
            "tipping_enabled": false,
            "automatic_payment_source": "NONE",
            "computed_amount_money": {
              "amount": 10000,
              "currency": "USD"
            },
            "total_completed_amount_money": {
              "amount": 10000,
              "currency": "USD"
            }
          }
        ],
        "invoice_number": "inv-100",
        "title": "Event Planning Services",
        "description": "We appreciate your business!",
        "delivery_method": "EMAIL",
        "status": "REFUNDED",
        "timezone": "America/Los_Angeles",
        "created_at": "2020-06-18T17:45:13Z",
        "updated_at": "2020-06-18T18:23:11Z",
        "primary_recipient": {
          "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
          "given_name": "Amelia",
          "family_name": "Earhart",
          "email_address": "Amelia.Earhart@example.com",
          "phone_number": "1-212-555-4240"
        },
        "custom_fields": [
          {
            "label": "Event Reference Number",
            "value": "Ref. #1234",
            "placement": "ABOVE_LINE_ITEMS"
          },
          {
            "label": "Terms of Service",
            "value": "The terms of service are...",
            "placement": "BELOW_LINE_ITEMS"
          }
        ]
      }
    }
  }
}

Share Feedback

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