AbacatePay icon

AbacatePay

Integração com a API AbacatePay
Join our community

Actions7

Overview

This node integrates with the AbacatePay API to create billing charges for customers. Specifically, the Billing - Create operation allows users to generate a new billing request that includes one or more products the customer is paying for. It supports setting payment frequency (one-time or multiple payments), available payment methods, and URLs for redirection after payment completion or cancellation.

Common scenarios where this node is useful include:

  • E-commerce platforms generating invoices or payment requests for purchased products.
  • Subscription services creating recurring or one-time payment bills.
  • Any application needing to programmatically create payment requests with detailed product information and control over payment flow.

Practical example:

  • An online store uses this node to create a billing charge when a customer places an order, specifying the products bought, their quantities, prices, and redirect URLs for success or cancellation.

Properties

Name Meaning
Products List of products the customer is paying for. Each product requires: Description, External ID (unique product identifier), Name, Price in cents, Quantity.
Return URL URL to redirect the customer if they click "Back" or cancel the payment process.
Completion URL URL to redirect the customer after the payment has been successfully completed.
Frequency Type of billing frequency:
- One Time: Single payment.
- Multiple Payments: Can be paid multiple times.
Methods Available payment methods. Currently supports:
- PIX
Additional Fields Optional extra fields:
- Customer ID: ID of an already registered customer.
- External ID: Unique identifier from your application for the billing.
- Allow Coupons: Whether coupons can be used.
- Coupons: Comma-separated list of coupon codes (e.g., ABKT10,ABKT5,PROMO10).

Output

The node outputs JSON data representing the created billing charge as returned by the AbacatePay API. This typically includes details such as billing ID, status, payment links, product details, and other metadata related to the billing request.

No binary data output is indicated.

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 explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrectly formatted product data (e.g., missing required fields like externalId or price) may result in API errors.
    • Invalid URLs for returnUrl or completionUrl could cause unexpected behavior during redirection.
    • Using unsupported payment methods will lead to errors; currently only "PIX" is supported.

  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly set up.
    • Validation errors from the API: Check that all required product fields are provided and valid.
    • Network or connectivity errors: Ensure the node can reach the AbacatePay API endpoint.

Links and References

Discussion