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 DARF payment batches within the Payment resource. Specifically, the "Update" operation allows users to modify an existing DARF batch by specifying its ID and providing updated data in JSON format.
Common scenarios for this node include automating updates to DARF payment batches in financial workflows, such as correcting batch details, adding or modifying payment information, or adjusting batch metadata after creation.
Practical example: A finance team uses this node to update a DARF batch's payment details automatically when new tax information becomes available, ensuring that the batch reflects the latest data before processing payments.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the DARF batch to update. |
| Additional Fields | Optional JSON object containing extra fields to include in the request for customization. |
| Request Body | Required JSON object representing the updated data for the DARF batch. |
Output
The node outputs a JSON array where each item corresponds to the response from the Kobana API for the update request. The JSON structure reflects the updated DARF batch details as returned by the API.
If the API returns binary data (not typical for update operations), it would represent file contents or similar, but this operation primarily deals with JSON responses.
Dependencies
- Requires an API key credential for authenticating with the Kobana API.
- The node dynamically selects the API base URL depending on the environment (production or sandbox).
- No additional external dependencies are required beyond the Kobana API access.
Troubleshooting
- Invalid ID error: If the provided ID does not correspond to an existing DARF batch, the API will return an error. Verify the ID is correct.
- Malformed JSON in Request Body: Ensure the JSON provided in the "Request Body" property is valid and matches the expected schema for DARF batch updates.
- Authentication errors: Confirm that the API key credential is correctly configured and has sufficient permissions.
- Network issues: Check connectivity to the Kobana API endpoints, especially if using sandbox URLs.
- API rate limits: If many requests are sent rapidly, the API might throttle requests; implement retries or delays as needed.
Links and References
- Kobana API Documentation (general reference for API endpoints and payloads)
- DARF Payment Batches API section (specific details about DARF batch operations)
