Complete Payment - Automate.ax

square.completePayment completes (captures) a payment.

Example

automations/square-complete-payment.automation.ts

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

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

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

Inputs

Every input accepts a compatible signal. It requires PAYMENTS_WRITE.

Field	Type	Required	Default	Description
`paymentId`	`string`	Yes	—	The unique ID identifying the payment to be completed.
`versionToken`	`string \| null`	No	—	Used for optimistic concurrency. This opaque token identifies the current `Payment` version that the caller expects. If the server has a different version of the Payment, the update fails and a response with a VERSION_MISMATCH error is returned.

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

Output

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