Woovi icon

Woovi

Automate Woovi workflow API
Join our community

Actions43

Overview

This node creates a payment request using the Woovi API. It supports different types of payment requests such as PIX Key, QR Code, and Manual payments. The node is useful for automating payment request creation in workflows, allowing users to specify payment details like value, destination, comments, and metadata. Practical examples include generating a PIX payment request for a customer, creating a QR code payment request, or setting up a manual payment with detailed holder and account information.

Use Case Examples

  1. Creating a PIX Key payment request with a specified value and destination alias.
  2. Generating a QR Code payment request by providing the QR code string.
  3. Setting up a manual payment request with holder and account details for manual processing.

Properties

Name Meaning
Type Type of the payment request (PIX Key, QR Code, or Manual).
Value (cents) Value of the requested payment in cents, required for PIX Key and Manual types.
Correlation ID Unique identifier for this payment request.
pixKeyEndToEndId End-to-end ID of the PIX key used for tracking.
QR Code QR Code to be paid, required for QR_CODE type.
Comment Comment sent alongside the payment.
Destination Alias The PIX key or alias to receive the payment, required for PIX_KEY type.
Destination Alias Type Type of the destination PIX key (CPF, CNPJ, EMAIL, PHONE, RANDOM), required for PIX_KEY type.
PSP PSP identifier, required for MANUAL type.
Holder Holder information for manual payments, including name and tax ID.
Account Account information for manual payments, including bank, branch, and account number.
Metadata Optional metadata as key/value pairs (max 30 keys) to add additional information to the payment request.

Output

JSON

  • id - Unique identifier of the created payment request.
  • status - Current status of the payment request.
  • paymentType - Type of the payment request created.
  • value - Value of the payment request in cents.
  • correlationID - Correlation ID associated with the payment request.
  • comment - Comment sent with the payment request.
  • destinationAlias - Destination alias or PIX key for the payment.
  • metadata - Metadata key/value pairs associated with the payment request.

Dependencies

  • Woovi API
  • API key credential for Woovi API

Troubleshooting

  • Unsupported resource/operation error if the resource or operation is not recognized by the node. Ensure the resource is set to 'Payment Request' and operation to 'Create Payment Request'.
  • Validation errors if required fields like payment type, value, or correlation ID are missing or invalid.
  • API errors from Woovi service such as authentication failures or invalid payment details. Check API credentials and input data for correctness.

Links

Discussion