Actions13
- Check Actions
- Payment Actions
- Payee Actions
- Document Actions
Overview
This node integrates with an online payment processing suite focused on handling checks, payments, payees, and document mailing. Specifically, the Check - Mail operation allows users to mail a physical check via USPS using various mail service options. This is useful for automating the dispatch of paper checks directly from workflows, eliminating manual mailing steps.
Common scenarios include:
- Automatically sending payroll or vendor payments as mailed checks.
- Mailing refund checks triggered by customer service workflows.
- Dispatching one-off or batch checks with specific delivery preferences.
Practical example: After generating a check in your accounting system, use this node to send it via USPS First Class Mail with tracking and signature required, ensuring secure and trackable delivery.
Properties
| Name | Meaning |
|---|---|
| Check ID | The unique identifier of the check to be mailed via USPS. Example: chk_1234567890. |
| Mail Type | USPS mail service type to use for sending the check. Options: |
| - First Class (Standard mail, 3-5 business days, $0.73) | |
| - First Class with Tracking (Standard mail with USPS tracking, $1.25) | |
| - Priority Mail (Expedited delivery, 1-3 business days, $8.95) | |
| - Express Mail (Overnight delivery, $28.95) | |
| Mail Options | Additional mailing options: |
| - Return Receipt | Request a return receipt for the mail (incurs additional fee). |
| - Certified Mail | Send the mail as certified mail (incurs additional fee). |
| - Signature Required | Require recipient's signature upon delivery (incurs additional fee). |
| - Special Instructions | Any special delivery instructions such as "Leave at door" or "Ring bell". |
Output
The node outputs JSON data representing the result of the mail operation for each input item. This typically includes confirmation details about the mailing request, such as status, tracking information (if applicable), and any errors encountered.
If the operation supports binary data (e.g., scanned mailing labels or documents), it would be included accordingly, but based on the provided code and properties, the primary output is JSON metadata about the mailing action.
Dependencies
- Requires an API key credential for the Online Check Writer service to authenticate requests.
- Depends on USPS mail services for physical delivery; the node abstracts USPS options but requires valid check IDs managed within the Online Check Writer platform.
- No additional environment variables are explicitly required beyond the API credential configuration.
Troubleshooting
Common issues:
- Invalid or missing Check ID: Ensure the check ID exists and is correctly formatted.
- Insufficient permissions or invalid API credentials: Verify that the API key is active and has rights to perform mailing operations.
- USPS service option mismatches or unsupported combinations may cause errors.
Error messages:
"Unknown resource: check"— indicates the resource parameter was not set correctly; ensure "check" is selected.- Errors related to mailing options usually specify which option caused the failure; review the selected mail type and options.
- Network or authentication errors will indicate issues connecting to the external API; verify credentials and network access.
Resolving these generally involves verifying input parameters, checking API credentials, and confirming the check exists in the system.
Links and References
- USPS Mail Services: Details on USPS mail types and pricing.
- Online Check Writer official documentation (not publicly linked here) for API usage and check management.
- n8n documentation on creating custom nodes for further customization guidance.