Actions13
- Check Actions
- Payment Actions
- Payee Actions
- Document Actions
Overview
This node integrates with an online payment processing suite focused on managing checks, payments, payees, and documents. Specifically, the Check - List operation allows users to retrieve a list of checks based on various filtering, sorting, and pagination options.
Typical use cases include:
- Retrieving all or a subset of issued checks for reconciliation or reporting.
- Filtering checks by status (e.g., pending, cashed, voided) or date ranges.
- Sorting checks by amount, date, or payee name to analyze payment patterns.
- Paginating through large sets of check data efficiently.
For example, a finance team could use this node to fetch all checks issued in the last month that are still pending, sorted by amount descending, to prioritize follow-up actions.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching checks or limit the number of results. |
| Limit | Maximum number of checks to return when not returning all. Minimum value is 1. |
| Filters | Collection of filters to narrow down the list of checks: |
| Bank Account Filter | Filter checks by a specific bank account ID. Example format: "bnk_1234567890". |
| End Date | Return checks created before this date/time. |
| Include Voided | Whether to include checks that have been voided in the results. |
| Offset | Number of checks to skip, useful for pagination. Minimum value is 0. |
| Sort By | Field to sort the results by. Options: Amount, Check Date, Date Created, Payee Name, Status. Default is Date Created. |
| Sort Order | Sort direction: Descending (newest first) or Ascending (oldest first). Default is Descending. |
| Start Date | Return checks created after this date/time. |
| Status | Filter checks by their status. Options include All, Cancelled, Cashed, Delivered, Draft, Failed, Mailed, Pending, Printed, Processed, Returned, Voided. Default is All. |
Output
The node outputs an array of JSON objects representing checks matching the specified criteria. Each object contains details about a single check, such as its amount, dates, payee information, status, and related metadata.
If binary data is returned (not indicated explicitly here), it would typically represent associated documents or images related to checks, but this operation primarily returns structured JSON data.
Dependencies
- Requires an API key credential for authenticating with the Online Check Writer service.
- The node depends on the external Online Check Writer API to fetch check data.
- No additional environment variables or configurations are explicitly required beyond the API credential.
Troubleshooting
Common Issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using invalid filter values (e.g., malformed bank account IDs or dates) may result in errors or empty results.
- Requesting too many records without enabling "Return All" might truncate results unexpectedly.
- Pagination parameters (offset and limit) must be used carefully to avoid skipping or duplicating records.
Error Messages:
- Authentication errors indicate issues with the provided API key; verify and update credentials.
- Validation errors on filters suggest incorrect input formats; ensure dates and IDs conform to expected formats.
- Unknown resource or operation errors occur if the node configuration is misconfigured; confirm that "Check" resource and "List" operation are selected.