Ranking Partner Action icon

Ranking Partner Action

Consume RankingPartner API

Actions2

Overview

This node interacts with the RankingPartner API to retrieve payment-related data, specifically focusing on "Sale Payments" when the Payment resource is selected. It allows users to fetch sale payment records optionally filtered by a status filter. This can be useful in scenarios where you want to automate workflows based on payment statuses, such as monitoring completed payments, pending transactions, or failed payments.

For example, you might use this node to:

  • Retrieve all sale payments with a specific status (e.g., "completed") to trigger follow-up actions.
  • Integrate payment status checks into your order processing pipeline.
  • Generate reports or notifications based on payment statuses.

Properties

Name Meaning
Status Filter Name or ID Choose a predefined status filter from a list or specify a custom ID via an expression. This filter limits the sale payments returned to those matching the selected status.

Output

The node outputs an array of JSON objects representing the sale payments retrieved from the API. Each object corresponds to a payment record and includes details as provided by the RankingPartner API.

  • The output is structured as a JSON array under the json field.
  • No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the RankingPartner API.
  • Uses internal methods to load options dynamically for status filters.
  • The node makes HTTP requests to the RankingPartner API endpoints.

Troubleshooting

  • Empty results: If no sale payments are returned, verify that the status filter is correctly set and that there are payments matching that status.
  • Authentication errors: Ensure the API key credential is valid and has the necessary permissions.
  • Invalid status filter: If specifying a custom status filter ID, confirm it exists and is supported by the API.
  • Network issues: Check connectivity to the RankingPartner API endpoint.

Common error messages will typically relate to authentication failures, invalid parameters, or network timeouts. Resolving these involves verifying credentials, input values, and network access.

Links and References

  • n8n Expressions Documentation — for using expressions in property fields.
  • RankingPartner API documentation (not included in source) — consult for detailed API usage and status filter definitions.

Discussion