Cancel Payment By Idempotency Key - Automate.ax

square.cancelPaymentByIdempotencyKey cancels (voids) a payment identified by the idempotency key that is specified in the request.

Example

automations/square-cancel-payment-by-idempotency-key.automation.ts

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

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

  square.cancelPaymentByIdempotencyKey({
    idempotencyKey: "a7e36d40-d24b-11e8-b568-0800200c9a66",
  })
})

Inputs

Every input accepts a compatible signal. It requires PAYMENTS_WRITE.

Field	Type	Required	Default	Description
`idempotencyKey`	`string`	Yes	—	The `idempotency_key` identifying the payment to be canceled.

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

Output

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