OnlineCheckWriter icon

OnlineCheckWriter

Complete payment processing suite - checks, ACH, wire transfers, virtual cards, and document mailing

Actions13

Overview

The node integrates with an online payment and document mailing service, focusing here on the Document resource with the Mail Document operation. It allows users to send PDF documents via postal mail by either providing a URL to the PDF or supplying binary PDF data from a previous workflow node.

This node is beneficial in scenarios where automated physical mailing of documents is required, such as sending contracts, invoices, statements, or official notices directly from an automated workflow without manual intervention.

Practical examples:

  • Automatically mailing signed contracts stored as PDFs in cloud storage by providing their URLs.
  • Sending personalized invoices generated in a prior step of the workflow as binary PDF data.
  • Mailing marketing brochures or flyers by linking to hosted PDF files.

Properties

Name Meaning
Document Source Selects the source of the PDF document to mail. Options:
• URL — Provide a direct link to the PDF document.
• Binary Data — Use PDF data from a previous node's binary output.
Document URL The full URL of the PDF document to mail. Required if Document Source is set to URL. Example: https://example.com/document.pdf.
Binary Property The name of the binary property containing the PDF data. Required if Document Source is set to Binary Data. Default is "data".
Recipient Name Full name of the person who will receive the mailed document. Example: "John Smith".
Recipient Address The physical mailing address of the recipient, consisting of:
• Line 1 (required)
• Line 2 (optional)
• City (required)
• State (required)
• ZIP Code (required)
Mail Options Additional mailing preferences:
• Mail Type — Choose delivery speed and cost:
 – First Class (3-5 business days)
 – Priority Mail (1-3 business days)
 – Express Mail (overnight)
• Color Printing — Print in color (adds cost)
• Double-Sided — Print on both sides
• Include Return Envelope — Adds a return envelope (adds cost)

Output

The node outputs JSON data representing the result of the mail document request. This typically includes confirmation details such as:

  • Status of the mailing request
  • Tracking or reference numbers
  • Any errors or warnings returned by the mailing service

If the node supports binary output (not explicitly shown here), it would represent any returned files or receipts related to the mailing process.

Dependencies

  • Requires an API key credential for the online payment and document mailing service.
  • Needs network access to fetch documents from URLs if using the URL document source.
  • Proper configuration of the API authentication within n8n credentials is necessary.

Troubleshooting

  • Common issues:

    • Invalid or inaccessible Document URL leading to failure fetching the PDF.
    • Incorrect binary property name causing missing PDF data.
    • Incomplete or invalid recipient address fields causing mailing errors.
    • Insufficient permissions or invalid API credentials resulting in authorization failures.

  • Error messages:

    • "Unknown resource" — Occurs if the resource parameter is incorrect; ensure "Document" is selected.
    • "Missing required parameter" — Check that all required fields like recipient name and address are filled.
    • "Failed to fetch document" — Verify the URL is correct and publicly accessible or that binary data is properly passed.
    • "API authentication error" — Confirm the API key credential is valid and configured correctly.

Resolving these usually involves verifying input parameters, ensuring proper credential setup, and confirming network accessibility.

Links and References

Discussion