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 charges under the "Charge > PIX" resource, specifically supporting the "Get Many" operation. It allows users to retrieve multiple PIX charge records from their Kobana account efficiently.

Common scenarios where this node is beneficial include:

  • Fetching a list of PIX charges for reconciliation or reporting.
  • Retrieving recent PIX charge transactions for auditing or monitoring.
  • Integrating PIX charge data into workflows that automate financial processes.

For example, a user might use this node to pull all PIX charges created in the last month and then process them further in n8n for accounting or notification purposes.

Properties

Name Meaning
Return All Whether to return all PIX charge results or limit the number of results returned.
Limit Maximum number of PIX charge results to return (applicable only if "Return All" is false).
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).

Details:

  • Return All: If set to true, the node fetches all available PIX charges without limiting the number of results.
  • Limit: When "Return All" is false, this limits the number of PIX charges returned, with a minimum of 1 and maximum of 100.
  • Additional Fields: Allows passing extra JSON-formatted fields to the API request body for advanced customization.
  • Query Parameters: Enables specifying additional query parameters as a JSON object to filter or control the listing of PIX charges (e.g., date ranges, status filters).

Output

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

No binary data output is produced by this operation.

Example output structure (simplified):

[
  {
    "id": "charge_pix_123",
    "amount": 1500,
    "status": "paid",
    "created_at": "2024-05-01T12:00:00Z",
    "payer": {
      "name": "John Doe",
      "cpf_cnpj": "12345678900"
    },
    ...
  },
  ...
]

Dependencies

  • Requires an active Kobana API credential configured in n8n with appropriate permissions to access PIX charge data.
  • The node dynamically selects the API base URL depending on the environment (production or sandbox).
  • No additional external dependencies beyond the Kobana API and n8n's HTTP request helper.

Troubleshooting

  • Authentication Errors: Ensure the Kobana API credential is correctly configured and has valid authentication tokens.
  • Invalid JSON in Additional Fields or Query Parameters: The node expects valid JSON strings for these inputs; malformed JSON will cause errors.
  • API Rate Limits: Requesting too many records or frequent calls may hit Kobana API rate limits; consider using "Return All" judiciously or applying filters.
  • Empty Results: If no PIX charges are returned, verify that query parameters are correct and that there are existing PIX charges in the account.
  • Error Messages: Errors from the API are returned as JSON with an "error" field; check the message for details and adjust parameters accordingly.

Links and References

This summary focuses on the "Charge > PIX" resource and the "Get Many" operation as requested, based solely on static analysis of the provided source code and property definitions.

Discussion