Actions7
- Billing Actions
- Coupon Actions
- Customer Actions
- PIX QR Code Actions
- Withdraw Actions
Overview
This node integrates with the AbacatePay API to create a PIX QR Code payment request. It allows users to generate a charge with specific details such as amount, description, expiration time, and optional customer information. This is useful for businesses or services that want to receive payments via PIX, a popular instant payment system in Brazil.
Typical use cases include:
- Generating a PIX payment request for an online purchase.
- Creating a charge with a custom message and expiration time.
- Attaching customer details to the payment request for record-keeping or follow-up.
- Adding metadata like an external ID to correlate the payment with internal systems.
Example: A small e-commerce platform can use this node to create a PIX QR code for each order, specifying the amount in cents, a description of the purchase, and customer contact info.
Properties
| Name | Meaning |
|---|---|
| Amount (in Cents) | The charge amount in cents (e.g., 2000 means R$ 20.00). Minimum value is 1 cent. |
| Description | Message shown during PIX payment (max 140 characters). |
| Expires In (Seconds) | Time in seconds before the charge expires (default 3600 seconds = 1 hour). |
| Customer | Optional collection of customer data: includes Name, Cellphone, Email, and Tax ID (CPF/CNPJ). |
| Metadata | Optional metadata for the charge; currently supports an External ID string for your app. |
Output
The node outputs JSON data representing the created PIX QR Code charge. This typically includes details such as the generated QR code, payment link, charge status, and any identifiers returned by the AbacatePay API.
If binary data is output (not explicitly shown in the source), it would likely represent the QR code image or related files, but based on the provided code and properties, the output is primarily JSON.
Dependencies
- Requires an API key credential for authenticating with the AbacatePay API.
- The node depends on the AbacatePay service being accessible and properly configured.
- No additional environment variables are indicated from the static analysis.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing an amount less than 1 cent will be rejected due to validation.
- Description longer than 140 characters may cause errors.
- Expiration time set too low or negative might lead to immediate expiration.
Error messages:
- Authentication errors: Check that the API key credential is correctly set up.
- Validation errors on input fields: Ensure all required fields are filled and respect constraints (e.g., amount ≥ 1, description ≤ 140 chars).
- Network or API errors: Verify network connectivity and AbacatePay service status.
Links and References
- AbacatePay Official Website (for API documentation and support)
- PIX Payment System Information (Central Bank of Brazil official site)
Note: This summary is based solely on static analysis of the provided source code and property definitions. Runtime behavior and dynamic responses depend on the actual API and environment configuration.