Overview
This node, named "Payment Kit," integrates with the Payment Kit API to perform operations related to customers. Specifically, the "Get Customer" operation retrieves detailed information about a customer by their unique ID. This node is useful in scenarios where you need to fetch customer data from the Payment Kit system for further processing, reporting, or integration with other services.
Practical examples include:
- Retrieving customer details to display in a CRM dashboard.
- Fetching customer information before processing payments or refunds.
- Synchronizing customer data between Payment Kit and other platforms.
Properties
| Name | Meaning |
|---|---|
| Customer ID | The unique identifier of the customer whose details you want to retrieve. This is a required string input. |
Output
The node outputs JSON data representing the customer's details as returned by the Payment Kit API. The structure typically includes all relevant customer information such as name, contact details, status, and any other metadata provided by the API.
If an error occurs during the request (e.g., invalid ID or network issues), the output will contain an error field with the corresponding error message.
The node does not output binary data.
Dependencies
- Requires access to the Payment Kit API endpoint
/api/customers/{customerId}. - Optionally uses an API authentication token or key configured in the node's credentials (referred to generically as an API key credential).
- No additional environment variables are explicitly required beyond standard n8n setup.
Troubleshooting
Common Issues:
- Providing an invalid or non-existent Customer ID will result in an error response from the API.
- Network connectivity problems can cause request failures.
- Missing or incorrect API authentication credentials may lead to authorization errors.
Error Messages:
- Errors returned from the API are captured and included in the output under an
errorproperty. - If the node is set to continue on failure, it will output the error message per item; otherwise, it will stop execution.
- Errors returned from the API are captured and included in the output under an
Resolution Tips:
- Verify that the Customer ID is correct and exists in the Payment Kit system.
- Ensure that the API key or authentication token is properly configured and valid.
- Check network connectivity and API endpoint availability.
Links and References
- Payment Kit API Documentation (Replace with actual URL if available)
- n8n Documentation on Creating Custom Nodes