Overview
This node interacts with the Pinch Payments API to retrieve information about payers. Specifically, the "Get" operation under the "Payer" resource fetches detailed data for a single payer identified by their unique payer ID. This is useful in scenarios where you need to access or verify payer details such as billing information, payment history, or account status within an automated workflow.
Practical examples include:
- Retrieving payer details before processing a refund.
- Validating payer identity during subscription management.
- Fetching payer information to display in a customer support dashboard.
Properties
| Name | Meaning |
|---|---|
| Payer ID | The unique identifier of the payer to retrieve. It must be a string starting with "pyr_". |
Output
The node outputs JSON data representing the payer's details as returned by the Pinch Payments API. This typically includes all relevant information about the payer such as their ID, contact details, payment methods, and status.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Pinch Payments API.
- Needs an API authentication token configured in the node credentials to authorize requests.
- The node depends on helper functions 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:
- Errors from the API (e.g., "Payer not found") will be thrown if the payer ID does not exist.
- If the node is set to continue on failure, error details will be included in the output JSON for each failed item.