diff --git a/.changeset/pos-payment-validations-tender-confirm-docs.md b/.changeset/pos-payment-validations-tender-confirm-docs.md new file mode 100644 index 0000000000..99613dedb8 --- /dev/null +++ b/.changeset/pos-payment-validations-tender-confirm-docs.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Document `paymentvalidations` dispatch timing: fires when a tender is confirmed but not yet committed, once per tender attempt (split payments dispatch per tender). diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/events.ts b/packages/ui-extensions/src/surfaces/point-of-sale/events.ts index 35daaebb83..1bd42d4af4 100644 --- a/packages/ui-extensions/src/surfaces/point-of-sale/events.ts +++ b/packages/ui-extensions/src/surfaces/point-of-sale/events.ts @@ -96,7 +96,10 @@ export interface InterceptedPaymentMethod { } /** - * Dispatched when staff selects a payment method on the payments screen. + * Dispatched when a tender is confirmed but not yet committed — after the + * amount is entered, before the payment is recorded. One event per tender + * attempt; split payments dispatch one event per tender, each carrying its + * own amount. * * @private */