Actions13
- Check Actions
- Payment Actions
- Payee Actions
- Document Actions
Overview
This node integrates with an online payment processing system to create and manage payees. Specifically, the Payee - Create operation allows users to add a new payee—either an individual or a business—to their payment system. This is useful in scenarios where you need to automate vendor or recipient management before issuing payments such as checks, wire transfers, or virtual cards.
Practical examples include:
- Adding a new contractor or freelancer as a payee for payroll automation.
- Registering a supplier or service provider as a business payee to streamline invoice payments.
- Maintaining an up-to-date list of payees with contact and tax information for compliance and notification purposes.
Properties
| Name | Meaning |
|---|---|
| Payee Name | Full name of the individual or business to be added as a payee. |
| Payee Type | Type of payee being created: either "Individual" (personal payee) or "Business" (company/organization). |
| Email address of the payee for sending notifications. | |
| Phone | Contact phone number of the payee. |
| Additional Information | A collection of optional fields providing more details about the payee: |
| Address Line 1 | Primary street address line. |
| Address Line 2 | Secondary street address line (e.g., suite or apartment number). |
| City | City of the payee's address. |
| Company Name | Legal company name (only shown if Payee Type is Business). |
| Country | Two-letter country code (default is "US"). |
| Notes | Internal notes about the payee. |
| State | Two-letter state code. |
| Tax ID / EIN | Tax identification number or Employer Identification Number used for tax reporting. |
| ZIP Code | Postal ZIP or postal code. |
Output
The node outputs JSON data representing the newly created payee record. This typically includes all submitted fields along with any additional metadata or identifiers assigned by the payment system.
If the node supports binary data output (not indicated here), it would generally relate to documents or files associated with the payee, but this operation focuses on JSON data only.
Dependencies
- Requires an API key credential for authenticating with the online payment processing service.
- The node depends on the external payment platform’s API to create and manage payees.
- Proper configuration of the API credentials within n8n is necessary for successful execution.
Troubleshooting
Common issues:
- Missing required fields such as "Payee Name" or "Payee Type" will cause errors.
- Invalid email or phone formats may lead to validation failures.
- Incorrect or missing API credentials will prevent communication with the payment service.
- Providing inconsistent data, e.g., a company name when the payee type is "Individual," might cause unexpected behavior.
Error messages:
- Errors related to authentication usually indicate invalid or expired API keys; reconfigure credentials accordingly.
- Validation errors will specify which input field is incorrect or missing; review and correct inputs.
- Network or API errors suggest connectivity issues or service downtime; retry after some time or check network settings.
Links and References
- Refer to the official documentation of the integrated payment platform for detailed API specifications and payee management guidelines.
- n8n documentation on creating custom nodes for further customization options.