Actions43
- Subaccount Actions
- Customer Actions
- Refund Actions
- Installment Actions
- Invoice Actions
- Subscription Actions
- Pix Key Actions
- QR Code Static Actions
- Payment Request Actions
- Charge Actions
- Psp (Payment Service Providers) Actions
Overview
This node interacts with the Woovi API to check the status or details of a Pix Key, which is a payment key used in Brazil's instant payment system. It is useful for verifying if a Pix Key is valid, active, or associated with a particular account. Practical applications include automating payment verification processes, validating user input for Pix Keys, or integrating Pix Key checks into financial workflows.
Use Case Examples
- A business automates the verification of customer Pix Keys before processing payments to reduce errors.
- A financial service integrates Pix Key status checks to confirm the validity of payment keys in real-time.
Properties
| Name | Meaning |
|---|---|
| Pix Key | The Pix Key value to be checked, which is required for the operation. |
Output
JSON
pixKeyStatus- The status or details of the checked Pix Key returned from the Woovi API.
Dependencies
- Woovi API with API key credentials
Troubleshooting
- Ensure the Pix Key provided is correctly formatted and valid to avoid API errors.
- Check that the Woovi API credentials are correctly configured and have the necessary permissions.
- Common error messages include 'Unsupported resource/operation' if the resource or operation is incorrect, and API errors if the Pix Key is invalid or the API request fails.