Woovi icon

Woovi

Automate Woovi workflow API

Overview

This node operation facilitates the transfer of funds between subaccounts within the Woovi payment system. It is useful for scenarios where funds need to be moved from one subaccount to another, such as internal fund management or reallocating resources between different departments or projects. For example, a business can transfer a specified amount from one subaccount's Pix key to another's Pix key, optionally including a unique correlation ID and a description for the transaction.

Use Case Examples

  1. Transferring 1000 cents from Subaccount A's Pix key to Subaccount B's Pix key with a correlation ID for tracking.
  2. Moving funds between subaccounts with a descriptive note for accounting purposes.

Properties

Name Meaning
CorrelationID Unique identifier for the subaccount operation, used for tracking and correlation.
Amount Amount in cents to be transferred between subaccounts.
To Pix Key Destination Pix key for the transfer, indicating the receiving subaccount.
From Pix Key Source Pix key for the transfer, indicating the sending subaccount.
Description Optional description for the transfer operation, providing context or notes.

Output

JSON

  • transactionId - Unique identifier of the transfer transaction.
  • status - Status of the transfer operation (e.g., success, failed).
  • amount - Amount transferred in cents.
  • fromPixKey - Source Pix key from which the amount was transferred.
  • toPixKey - Destination Pix key to which the amount was transferred.
  • correlationID - Correlation ID provided for the operation, if any.
  • description - Description provided for the transfer operation.

Dependencies

  • Woovi API with API key credential for authentication

Troubleshooting

  • Ensure that the 'fromPixKey' and 'toPixKey' are valid and registered Pix keys within the Woovi system to avoid transfer failures.
  • Verify that the 'amount' is a positive number and available in the source subaccount to prevent insufficient funds errors.
  • Check that the correlation ID, if used, is unique to avoid conflicts or duplicate transaction issues.
  • Common error messages may include invalid Pix keys, insufficient funds, or unauthorized access due to incorrect API credentials. Resolving these involves validating input data and ensuring correct API authentication.

Links

Discussion