N8N Tools - Cash App icon

N8N Tools - Cash App

Accept payments and manage transactions through Cash App Pay with extensible Square API integration
Join our community

Actions38

Overview

This node integrates with the Cash App API via an external service to retrieve various types of reports, including settlement reports. Specifically, for the Report resource and Get Settlement Reports operation, it fetches settlement report data within a specified date range, optionally filtered by location and sorted in ascending or descending order.

Use cases include:

  • Financial reconciliation by retrieving detailed settlement reports for a given period.
  • Filtering settlement data by specific locations to analyze performance regionally.
  • Sorting results to view the most recent or oldest settlements first.

Example: A business can automate fetching daily settlement reports from Cash App to update their accounting system or generate financial summaries.

Properties

Name Meaning
Start Date The start date/time (ISO 8601) for the settlement report period to retrieve. Required.
End Date The end date/time (ISO 8601) for the settlement report period to retrieve. Required.
Location ID Optional identifier to filter the settlement reports by a specific location.
Sort Order The order to sort the results: either "Ascending" (ASC) or "Descending" (DESC). Default is DESC.

Output

The node outputs JSON data under the reports field containing the settlement reports retrieved from the external Cash App API. The structure of this data depends on the API response but generally includes details about settlements such as amounts, dates, and possibly location information.

No binary data output is produced by this operation.

Example output snippet:

{
  "success": true,
  "creditsUsed": 1,
  "creditsRemaining": 99,
  "reports": [
    {
      "settlementId": "settlement_123",
      "locationId": "location_123456789",
      "amount": 100000,
      "currency": "USD",
      "startDate": "2025-01-01T00:00:00Z",
      "endDate": "2025-01-01T23:59:59Z",
      "status": "COMPLETED"
    },
    ...
  ]
}

Dependencies

  • Requires an API key credential for authentication with the external Cash App API service.
  • The node uses an HTTP POST request to validate the operation before execution.
  • The external API URL and API key must be configured in the node credentials.
  • No additional environment variables are required beyond the API credentials.

Troubleshooting

  • Validation Failure: If the API validation fails, the node throws an error indicating "N8N Tools API validation failed". Ensure the API key is valid and has permissions for report retrieval.
  • Missing Required Parameters: Both Start Date and End Date are mandatory. Omitting them will cause errors.
  • Invalid Date Range: Providing an invalid or reversed date range may result in empty or error responses.
  • Location ID Filter Issues: If filtering by Location ID returns no data, verify that the location exists and has settlement data in the specified period.
  • API Rate Limits: The node tracks credits used and remaining; hitting limits may cause failures. Monitor usage accordingly.

Links and References

Discussion