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

The node integrates with the Cash App API to manage customer profiles and related data. Specifically, the List Customers operation retrieves a list of recent customer profiles from the Cash App system. This is useful for workflows that need to process or analyze customer data in bulk, such as syncing customer lists to a CRM, generating marketing segments, or auditing customer information.

Typical use cases include:

  • Fetching a paginated list of customers for reporting or export.
  • Searching customers by name or other query parameters.
  • Iterating through all customers using pagination cursors.

Properties

Name Meaning
Limit Number of customers to retrieve in one request (pagination size). Default is 50.
Cursor Pagination cursor string to fetch the next page of results. Used for paginated requests.
Query Search query string to filter customers by name or other criteria.

Output

The output JSON contains the following fields:

  • success: Boolean indicating if the operation was successful.
  • creditsUsed: Number of API credits consumed by the request.
  • creditsRemaining: Number of API credits remaining after the request.
  • customers: An array of customer profile objects retrieved from the API.
  • cursor (optional): A pagination cursor string to be used for fetching the next page of results if more customers are available.

Each customer object typically includes standard customer profile details as returned by the Cash App API (e.g., customer ID, name, contact info), but exact structure depends on the API response.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the external Cash App API service.
  • The node uses an internal helper class to communicate with the Cash App API endpoints.
  • The node expects the API URL and API key to be configured in the credentials.
  • The node sends a validation request to the API before performing operations to ensure the credentials and requested operation are valid.

Troubleshooting

  • API Validation Failure: If the initial API validation fails, the node will throw an error indicating "N8N Tools API validation failed" with a message from the API. Check that the API key credential is correct and has permissions for customer operations.
  • Unknown Operation Error: If an unsupported operation is specified, the node throws an error like "Unknown customer operation: [operation]". Verify that the operation name matches supported options.
  • Pagination Issues: When using the Cursor property, ensure the cursor value is correctly passed from previous outputs to avoid empty or repeated results.
  • Rate Limits / Credits: The node tracks API credits used and remaining. If you encounter errors related to rate limits or credit exhaustion, check your API usage and consider increasing limits or reducing request frequency.

Links and References

This summary focuses exclusively on the Customer - List Customers operation as requested, based on static analysis of the provided source code and input properties.

Discussion