invoice.payment_made

A Square invoice transitioned to PAID (customer-level invoice payment received)

Category: Billing

Emitted when: After SquarePaymentWebhookHandler commits the invoice.PAID state and _update_tour_paid_status completes

Envelope

Every delivery wraps the event-specific data block in the canonical envelope documented on the webhook overview page. The body carries SIX keys; the HMAC signature is delivered as the X-Webhook-Signature request header on the inbound POST to your endpoint (NOT as a body field; including it in the body would make the HMAC a function of its own output).

Field	Type	Description
event_id	string	ULID; globally unique. Safe to persist as the dedup key.
event_type	string	Always invoice.payment_made for this event.
api_version	string	Payload schema version (YYYY-MM-DD).
timestamp	integer	Unix epoch seconds at dispatch time.
nonce	string	ULID; unique per delivery, used for replay rejection.
data	object	Event-specific payload (see below).

Delivery also sets three HTTP headers on the inbound POST:

Header	Meaning
X-Webhook-Event-Id	Mirrors event_id; cheaper than parsing the body to dedup.
X-Webhook-Timestamp	Mirrors timestamp for replay-window checks.
X-Webhook-Signature	sha256=<hex> HMAC over timestamp.body.

Data schema

Field	Type	Required	Description
agency_id	string	yes	Agency Id
invoice_id	string	yes	Internal invoice identifier (LinkedInvoice _id or the Square invoice id when no internal record exists). Opaque to receivers.
square_invoice_id	string	yes	Square invoice id with the inv: prefix. Receivers correlating against Square directly use this value.
listing_number	string | null	no	Tour/listing number when the invoice is tied to a tour; None for subscription-only invoices. Receivers MUST tolerate None.
amount	integer	yes	Amount in cents. Integer only - Square v44 money.amount is int64. Never represent as float.
currency	string	yes	ISO-4217 currency code (e.g. USD)
payment_method	"card" | "bank" | "cash" | "other"	yes	Payment Method
payment_layer	"platform" | "owner"	yes	Payment Layer
paid_at	string	yes	Paid At

Sample payload

The sample below is a live fixture. Feed the exact body bytes shown plus the timestamp into the HMAC-SHA256 recipe from the webhook overview using the documented test-vector secret (test_secret_001 ) and you will recover the signature header value printed below.

Body (delivered as the HTTP request body):

{
  "event_id": "evt_22YE5XMAB73CE1VVTQ0G9DVZ6K",
  "event_type": "invoice.payment_made",
  "api_version": "2026-04-17",
  "timestamp": 1745339401,
  "nonce": "70FF4Z0FBKXSHPXMRMADE962Q8",
  "data": {
    "agency_id": "user_01HXAGENCY0000000000000",
    "invoice_id": "inv_01HXINVOICE00000000000000",
    "square_invoice_id": "01HX5Y7Z2M3N4P5Q6R7S8T9U0V",
    "listing_number": "abc1234",
    "amount": 0,
    "currency": "USD",
    "payment_method": "card",
    "payment_layer": "platform",
    "paid_at": "2026-05-29T12:00:00Z"
  }
}

Signature header (delivered as X-Webhook-Signature on the same request):

sha256=5dd3b571a4d1333320f3527a8e2508ba24c4774763b9b0043f29b51feca7edb5

Retry behaviour

Failed deliveries retry on the sequence 2, 4, 8, 16, 32 seconds (five attempts plus the initial call for a total of six over approximately 62 seconds of wall clock). After the final attempt the delivery lands in the dead-letter queue and the dashboard operator can replay it from Settings > API Keys > Webhook Endpoint > Deliveries. See the webhook overview for the full rules.

Verification

Every receiver MUST verify the X-Webhook-Signature header using the recipe in the webhook overview. Rejecting deliveries whose timestamp is more than 5 minutes off your wall clock (after NTP correction on your side) or whose nonce has already been consumed in the last 10 minutes is part of the contract.