KobanaInstall

Overview

The "Mark as Paid" operation for the "V1 > Bank Billets" resource in this node allows users to mark a specific bank billet (a type of payment slip commonly used in Brazil) as paid via the Kobana API. This is useful in financial workflows where you need to update the status of a bank billet after receiving payment confirmation, ensuring your records and downstream processes reflect the payment status accurately.

Practical examples include:

• Automatically marking a bank billet as paid once a payment notification is received.
• Reconciling payments in accounting systems by updating the payment status of issued bank billets.
• Triggering follow-up actions or notifications after confirming payment.

Properties

The "Additional Fields" property accepts a JSON object allowing you to specify extra parameters supported by the API for this operation.

Output

The output of this operation is a JSON object representing the updated bank billet resource as returned by the Kobana API after marking it as paid. It typically includes details such as the billet's ID, status (now paid), payment date, and any other relevant metadata.

No binary data output is produced by this operation.

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).
• The node uses HTTP methods and endpoints defined by the Kobana API for bank billets.

Troubleshooting

• Common issues:
  • Invalid or missing bank billet ID will cause the API call to fail.
  • Insufficient permissions or invalid API credentials can result in authentication errors.
  • Providing malformed JSON in "Additional Fields" may cause request parsing errors.
• Error messages:
  • Errors from the API are returned as JSON with error messages; these should be inspected to understand the failure reason.
  • If the node throws an error about authentication, verify that the API key credential is correctly set up.
  • For JSON parsing errors, ensure the "Additional Fields" input is valid JSON.

Links and References

• Kobana API Documentation (general reference for API endpoints and payloads)
• Bank Billet Payment Concepts (background on bank billets)

This summary focuses specifically on the "Mark as Paid" operation under the "V1 > Bank Billets" resource based on the provided source code and properties.