Pinch icon

Pinch

Node for interacting with the Pinch Payments API

Actions9

Payer → List

AI-generated

Summary

List payers from the Pinch Payments API with optional pagination and filtering.

Inputs

  • Page — Specify the page number of results to retrieve, defaults to 1.
  • Page Size — Limit how many payer records to return in one page, with a maximum of 500.
  • Filter — Optionally filter the list by a search string matching payer Name or Email address.

Output shape

a paginated list of payer records in JSON format

Results may be paginated using the 'page' and 'pageSize' parameters. The output is an array of payer objects matching the optional filter criteria, or an empty array if no payers match.

Examples

Example 1: Retrieve the first page of payers with up to 50 entries, filtering by the name containing 'John'.

Set 'Page' to 1, 'Page Size' to 50, and 'Filter' to 'John'. The output will be a list of up to 50 payer objects whose name or email address contains 'John'.

Links

Discussion