List Payment Links - Automate.ax

square.listPaymentLinks lists all payment links.

Example

automations/square-list-payment-links.automation.ts

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

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

  square.listPaymentLinks({
    cursor: "cursor",
    limit: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires ORDERS_READ.

Field	Type	Required	Default	Description
`cursor`	`string \| null`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.
`limit`	`number \| null`	No	—	A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. If the supplied limit is negative, zero, or greater than the maximum limit of 1000, it is ignored. Default value: `100`

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

Output

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