Pinch icon

Pinch

Node for interacting with the Pinch Payments API

Actions3

Overview

This node integrates with the Pinch Payments API to retrieve payment information related to a specific payer. The "For Payer" operation under the "Payment" resource fetches all payments associated with a given payer ID. This is useful in scenarios where you want to list or analyze all transactions made by a particular customer or client.

Practical examples include:

  • Retrieving all payments for a customer to display their transaction history.
  • Auditing or reconciling payments linked to a specific payer.
  • Triggering workflows based on payments made by a certain payer.

Properties

Name Meaning
Payer ID The unique identifier of the payer whose payments you want to retrieve. It must be a string starting with pyr_.

Output

The node outputs an array of JSON objects representing the payments associated with the specified payer. Each object contains detailed information about a single payment as returned by the Pinch Payments API.

The output does not include binary data; it solely provides structured JSON data describing payments.

Dependencies

  • Requires an active connection to the Pinch Payments API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The node depends on the helper function pinchApiRequest to make HTTP requests to the Pinch API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing Payer ID: Ensure the payer ID is correctly provided and starts with pyr_.
    • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Network or API downtime: Check connectivity and Pinch Payments service status.

  • Error messages:

    • If the payer ID is invalid or not found, the API may return a 404 error. Confirm the payer ID exists.
    • Authentication failures will result in 401 or 403 errors. Recheck API credentials.
    • Unexpected errors from the API will be passed through; enabling "Continue On Fail" can help handle these gracefully in workflows.

Links and References

Discussion