N8N Tools - Cash AppInstall

Overview

The node integrates with the Cash App Pay system via an extensible Square API, enabling users to retrieve various types of reports related to payments, settlements, item sales, and customer sales. Specifically, for the Report resource and Get Payment Reports operation, it fetches payment transaction reports within a specified date range, optionally filtered by location and sorted in ascending or descending order.

This node is beneficial for businesses that want to automate the retrieval of financial transaction data from Cash App for reconciliation, analytics, or reporting purposes. For example, a user can schedule this node to run daily to collect all payment transactions from the previous day, helping maintain up-to-date financial records.

Properties

Output

The output JSON contains a reports field holding the payment transaction report data retrieved from the API. This data typically includes details about each payment transaction within the specified date range and filters.

Example structure of the output JSON:

{
  "json": {
    "resource": "report",
    "operation": "getPaymentReports",
    "success": true,
    "creditsUsed": 1,
    "creditsRemaining": 99,
    "reports": {
      // Payment report data as returned by the external API
    }
  }
}

• resource: Indicates the resource type ("report").
• operation: Indicates the operation performed ("getPaymentReports").
• success: Boolean indicating if the operation succeeded.
• creditsUsed and creditsRemaining: Information about API usage credits.
• reports: Contains the actual payment report data fetched.

The node does not output binary data.

Dependencies

• Requires an API key credential for authentication with the external Cash App API service.
• Needs configuration of the API base URL and API key in the node credentials.
• Uses HTTP POST requests to validate operations and fetch report data.
• Relies on the external "n8nToolsApi" service endpoint to perform validation and data retrieval.

Troubleshooting

• Common Issues:

  • Invalid or missing API key credential will cause authentication failures.
  • Incorrect date formats or missing required parameters (startDate, endDate) will result in errors.
  • Specifying an invalid or non-existent locationId may return empty or error responses.
  • Network connectivity issues to the external API endpoint can cause request failures.

• Error Messages:

  • "N8N Tools API validation failed": Indicates the API rejected the request during validation; check credentials and parameter correctness.
  • "Unknown report operation: getPaymentReports": Should not occur if using the correct operation name; indicates possible misconfiguration.
  • "Cash App operation failed: <message>": General failure message wrapping underlying API or node errors.

• Resolution Tips:

  • Verify API credentials and ensure they have sufficient permissions.
  • Confirm date inputs are valid ISO 8601 strings.
  • Check network access and API endpoint availability.
  • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch processing.

Links and References

• Cash App Pay Developer Documentation
• Square API Reference
• n8n Documentation - Creating Custom Nodes
• ISO 8601 Date Format