Actions215
- V1 > Bank Billets Actions
- V1 > Bank Billet Accounts Actions
- V1 > Bank Billet Batches Actions
- V1 > Bank Billet Batch Exports Actions
- V1 > Bank Billet Discharges Actions
- V1 > Bank Billet Payments Actions
- V1 > Bank Billet Registrations Actions
- V1 > Bank Billet Remittances Actions
- V1 > Customers Actions
- V1 > Customer Subscriptions Actions
- V1 > Discharges Actions
- V1 > Email Deliveries Actions
- V1 > Events Actions
- V1 > Imports Actions
- V1 > Installments Actions
- V1 > Remittances Actions
- V1 > Reports Actions
- V1 > SMS Deliveries Actions
- V1 > User Info Actions
- V1 > Webhook Deliveries Actions
- V1 > Webhooks Actions
- Admin > Users Actions
- Admin > Connections Actions
- Admin > Certificates Actions
- Admin > Subaccounts Actions
- Charge > PIX Actions
- Charge > PIX Accounts Actions
- Data > Bank Billet Queries Actions
- EDI > EDI Boxes Actions
- Financial > Accounts Actions
- Financial > Balances Actions
- Financial > Commands Actions
- Financial > Statement Transactions Actions
- Financial > Transaction Imports Actions
- Financial > Providers Actions
- Payment > Bank Billets Actions
- Payment > Bank Billet Batches Actions
- Payment > Batches Actions
- Payment > DARFs Actions
- Payment > DARF Batches Actions
- Payment > PIX Actions
- Payment > PIX Batches Actions
- Payment > Utilities Actions
- Payment > Utility Batches Actions
- Transfer > Batches Actions
- Transfer > Internal Actions
- Transfer > Internal Batches Actions
- Transfer > PIX Actions
- Transfer > PIX Batches Actions
- Transfer > TED Actions
- Transfer > TED Batches Actions
Overview
This node interacts with the Kobana API to manage payment batches and other related resources. Specifically, for the Payment > Batches resource with the Get Many operation, it retrieves a list of payment batches from the Kobana system. This is useful for scenarios where you need to fetch multiple payment batch records for reporting, auditing, or further processing within an automation workflow.
Practical examples include:
- Retrieving all payment batches created within a certain period.
- Fetching a limited number of recent payment batches for review.
- Applying query filters to get batches matching specific criteria (e.g., status, date range).
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all available results or limit the output to a specified maximum number. |
| Limit | The maximum number of results to return when not returning all. Allowed values: 1 to 100. |
| Additional Fields | A JSON object allowing additional fields to be included in the request for extended filtering or options. |
| Query Parameters | A JSON object containing query parameters to filter or modify the request (e.g., pagination, filters). |
Output
The node outputs a JSON array where each element represents a payment batch object retrieved from the Kobana API. Each batch object contains details about the payment batch such as its ID, status, creation date, and other relevant metadata as provided by the API.
If the node supports binary data output for this operation (not indicated here), it would typically represent downloadable content like exported batch files, but for "Get Many" this is not applicable.
Dependencies
- Requires an active Kobana API credential configured in n8n with appropriate permissions.
- The node dynamically selects the API base URL depending on the environment (production or sandbox).
- Network connectivity to the Kobana API endpoints is necessary.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Exceeding API rate limits may result in errors or throttling.
- Providing malformed JSON in "Additional Fields" or "Query Parameters" can cause request errors.
- Requesting more items than allowed by the API limit may lead to truncated results or errors.
Error messages:
- Authentication errors: Verify that the API key or token is correctly set up and has required permissions.
- JSON parsing errors: Ensure that any JSON input fields are valid JSON strings.
- HTTP errors (4xx or 5xx): Check the API documentation for error codes and adjust requests accordingly.
Links and References
- Kobana API Documentation (official API docs for detailed endpoint info)
- n8n documentation on Using Credentials for setting up API keys
- General REST API best practices for pagination and filtering
