Get Payment Refund - Automate.ax

square.getPaymentRefund retrieves a specific refund using the refund_id.

Example

automations/square-get-payment-refund.automation.ts

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

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

  square.getPaymentRefund({
    refundId: "refund_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires PAYMENTS_READ.

Field	Type	Required	Default	Description
`refundId`	`string`	Yes	—	The unique ID for the desired `PaymentRefund`.

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

Output

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