Actions55
- Webhooks Actions
- Payments Actions
- Products Actions
- Plans Actions
- Partner Referrals Actions
- Reporting Actions
- Orders Actions
- Subscriptions Actions
- Invoicing Actions
- Disputes Actions
Reporting → Get Balance
AI-generatedOverview
The "Get Balance" operation under the "Reporting" resource in this node retrieves the current PayPal account balance information. This is useful for financial monitoring, reconciliation, and reporting purposes within automated workflows. For example, a business can use this node to periodically check their PayPal balance and trigger alerts or update accounting systems accordingly.
Properties
| Name | Meaning |
|---|---|
| Additional Options | Collection of optional parameters: - Environment: Choose between "Sandbox" or "Live" PayPal environment. - Page Size: Number of items per page for list operations (not applicable for Get Balance but available). - Start Time: Start date filter in ISO 8601 format (not applicable for Get Balance). - End Time: End date filter in ISO 8601 format (not applicable for Get Balance). |
Note: For the "Get Balance" operation specifically, only the "Environment" option is relevant since it determines which PayPal environment to query.
Output
The output JSON contains:
resource: The resource name, here always"reporting".operation: The operation name, here"getBalance".success: Boolean indicating if the API call was successful.- PayPal balance data fields as returned by the PayPal API under
/v1/reporting/balances. This typically includes currency balances and related details. creditsUsed: Number of API credits consumed by the request (usually 1).creditsRemaining: Remaining API credits after the request.timestamp: ISO string timestamp when the response was generated.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for the external "N8N Tools API" service used for validation.
- Requires OAuth2 credentials for PayPal API access, including an access token and environment setting.
- The node dynamically selects the PayPal API base URL based on the environment ("sandbox" or "live").
- Proper configuration of these credentials in n8n is necessary for successful execution.
Troubleshooting
- Validation Failure: If the node throws an error about validation failure from the external API, ensure that the API key credential is valid and the N8N Tools API service is reachable.
- Invalid Credentials: Errors related to PayPal OAuth2 tokens usually indicate expired or misconfigured credentials; refresh or reconfigure them.
- Unknown Operation or Resource: If the node reports unknown operation/resource errors, verify that the selected resource is "Reporting" and operation is "Get Balance".
- Network Issues: Connectivity problems with PayPal endpoints or the external validation API will cause failures; check network and proxy settings.
- JSON Parsing Errors: Not applicable for this operation since no request body is required.