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 various financial and business operations, including payments, customers, products, subscriptions, invoices, loyalty programs, gift cards, inventory, and reports. Specifically, for the Gift Card - Get Balance operation, it retrieves the current balance of a specified gift card.

This node is beneficial in scenarios where businesses want to automate checking gift card balances within their workflows, such as verifying available funds before processing transactions or reporting on gift card usage.

Example use case:
A retail store uses this node to automatically check the balance of a customer's gift card during checkout to ensure sufficient funds are available before completing a sale.

Properties

Name Meaning
Gift Card ID The unique identifier of the gift card whose balance you want to retrieve. Example format: giftcard_123456789. This property is required.

Output

The node outputs a JSON object containing the result of the gift card balance query under the field balance. This typically includes details about the current balance amount and possibly related metadata returned by the Cash App API.

The output structure looks like:

{
  "success": true,
  "creditsUsed": <number>,
  "creditsRemaining": <number>,
  "resource": "giftCard",
  "operation": "getBalance",
  "balance": {
    // gift card balance details from the API
  }
}

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the external Cash App API service.
  • The node expects configuration of the API URL and API key through credentials.
  • The node internally validates each operation via a POST request to a validation endpoint before executing the main API call.
  • Uses an internal helper class (CashAppApi) to interact with the Cash App endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing Gift Card ID will cause the operation to fail.
    • API authentication errors if the API key credential is not set up correctly.
    • Network or connectivity issues when calling the external API.
    • Exceeding API rate limits or credit usage may cause failures.

  • Error messages:

    • "N8N Tools API validation failed" indicates that the initial validation request to the API did not succeed; check API key and permissions.
    • "Unknown gift card operation: getBalance" would indicate a code mismatch but should not occur in normal use.
    • Errors mentioning "Cash App operation failed" include the underlying API error message; verify input parameters and API status.

  • Resolution tips:

    • Ensure the Gift Card ID is correct and exists in the Cash App system.
    • Verify API credentials and permissions.
    • Check network connectivity.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion