Retrieve Dispute - Automate.ax

square.retrieveDispute returns details about a specific dispute.

Example

automations/square-retrieve-dispute.automation.ts

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

export default automation("Retrieve Square Dispute", () => {
  onDashboardRun({ title: "Retrieve Square Dispute" })

  square.retrieveDispute({
    disputeId: "dispute_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires DISPUTES_READ.

Field	Type	Required	Default	Description
`disputeId`	`string`	Yes	—	The ID of the dispute you want more details about.

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

Output

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