Woovi icon

Woovi

Automate Woovi workflow API

Overview

This node interacts with the Woovi API to approve a payment request. It is designed to automate workflows involving payment requests, specifically allowing users to approve a payment request by providing necessary identifiers such as a unique Correlation ID and an optional pixKeyEndToEndId for tracking. This is useful in scenarios where payment requests need to be programmatically approved as part of a larger payment processing or financial automation workflow.

Use Case Examples

  1. Approving a payment request in an automated billing system by providing the Correlation ID of the request.
  2. Tracking and approving a payment request using the pixKeyEndToEndId for end-to-end transaction tracking.

Properties

Name Meaning
Correlation ID Unique identifier for this payment request, required to specify which payment request to approve.
pixKeyEndToEndId End-to-end id of the pix key used for tracking the payment request, optional for additional tracking purposes.

Output

JSON

  • correlationID - The unique identifier of the approved payment request.
  • pixKeyEndToEndId - The end-to-end id of the pix key used for tracking the approved payment request.
  • status - The status of the payment request after approval.
  • approvalDetails - Additional details returned from the Woovi API about the approval process.

Dependencies

  • Woovi API with an API key credential for authentication

Troubleshooting

  • Ensure the Correlation ID is correctly provided and matches an existing payment request in the Woovi system, otherwise the approval will fail.
  • Check API credentials and network connectivity if the node fails to communicate with the Woovi API.
  • If the operation is unsupported or the resource/operation combination is incorrect, the node will throw an error indicating unsupported resource/operation.

Links

  • Woovi API Documentation - Official documentation for the Woovi API, useful for understanding the payment request approval process and required parameters.

Discussion