Kobana icon

Kobana

Interact with Kobana API - Quick access to common operations
Join our community

Actions215

Overview

This node interacts with the Kobana API to manage PIX payment batches under the "Payment > PIX Batches" resource, specifically supporting the "Get Many" operation. It allows users to retrieve multiple PIX batch records from their Kobana account efficiently.

Common scenarios where this node is beneficial include:

  • Fetching a list of PIX payment batches for reconciliation or reporting.
  • Automating workflows that require processing or analyzing multiple PIX batches at once.
  • Integrating Kobana PIX batch data into other systems or dashboards.

For example, a finance team could use this node to automatically pull all PIX payment batches created in the last month and generate summary reports or trigger follow-up actions based on batch statuses.

Properties

Name Meaning
Return All Whether to return all available PIX batch results or limit the number of returned records.
Limit The maximum number of PIX batch records to return when "Return All" is set to false (1-100).
Additional Fields JSON object with additional fields to customize the request (optional).
Query Parameters JSON object with query parameters to filter or modify the list request (optional).

Output

The node outputs an array of JSON objects representing PIX payment batches retrieved from the Kobana API. Each object contains details about a single PIX batch, such as its ID, creation date, status, and other relevant metadata provided by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kobana API.
  • The node dynamically selects the API base URL depending on whether the environment is production or sandbox.
  • No additional external dependencies are required beyond the Kobana API access.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid JSON in the "Additional Fields" or "Query Parameters" properties may result in request errors.
    • Exceeding the allowed limit (max 100) for the "Limit" property will be rejected by the API.

  • Error Messages:

    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • JSON parsing errors suggest malformed JSON input in properties; ensure valid JSON syntax.
    • Rate limiting or quota exceeded errors may occur if too many requests are made; consider enabling "Return All" cautiously or adding delays.

Links and References

Discussion