Cancel Payment - Automate.ax

square.cancelPayment cancels (voids) a payment.

Example

automations/square-cancel-payment.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Cancel Square Payment", () => {
  onDashboardRun({ title: "Cancel Square Payment" })

  square.cancelPayment({
    paymentId: "payment_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires PAYMENTS_WRITE.

Field	Type	Required	Default	Description
`paymentId`	`string`	Yes	—	The ID of the payment to cancel.

Use the official CancelPayment reference for provider field semantics and limits.

Output

Returns the official Square.CancelPaymentResponse response as a codec-safe object. Square integer money amounts remain bigint values.