Kobana icon

Kobana

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

Actions215

Overview

This node integrates with the Kobana API to manage PIX payments within the Payment resource. Specifically, the Update operation for the Payment > PIX resource allows users to update existing PIX payment records by specifying their ID and providing a JSON request body with the fields to modify.

Common scenarios where this node is beneficial include:

  • Adjusting details of a PIX payment after creation, such as updating amounts, status, or metadata.
  • Correcting information in a PIX payment record without needing to recreate it.
  • Automating updates to PIX payments based on external triggers or workflows.

Practical example:

  • A business receives a notification that a PIX payment needs to be updated with additional customer information or corrected amount. Using this node, the workflow can fetch the payment by ID and update the necessary fields programmatically.

Properties

Name Meaning
ID The unique identifier of the PIX payment to update.
Additional Fields JSON object containing any extra fields to include in the request (optional).
Request Body Required JSON object representing the data to update in the PIX payment record.

Output

The node outputs the JSON response from the Kobana API after performing the update operation. This typically includes the updated PIX payment object with all its properties reflecting the changes made.

If the API returns binary data (not typical for update operations), it would represent file content or attachments related to the payment, but this operation primarily deals with JSON data.

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 other external dependencies are required.

Troubleshooting

  • Invalid ID error: If the provided ID does not correspond to an existing PIX payment, 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 PIX payment updates.
  • Authentication errors: Confirm that the API key credential is correctly configured and has permissions to update PIX payments.
  • Network or API downtime: Temporary connectivity issues or Kobana API outages may cause failures; retry later or check service status.

Links and References

Discussion