AbacatePay icon

AbacatePay

Integração com a API AbacatePay
Join our community

Actions7

Overview

This node integrates with the AbacatePay API to create a withdrawal (withdraw) transaction. It allows users to initiate a PIX withdrawal by specifying the amount, PIX key details, and other metadata. This is useful for automating payouts or transferring funds from your system to a recipient's PIX account.

Typical use cases include:

  • Automating salary or commission payments via PIX.
  • Sending refunds or reimbursements directly to customers' PIX keys.
  • Managing withdrawals programmatically in financial or billing workflows.

Properties

Name Meaning
Amount (in Cents) The withdrawal amount specified in cents. Minimum allowed is 350 (equivalent to R$ 3.50).
PIX Key Type The type of PIX key to receive the withdrawal. Options: CNPJ, CPF, Email, Phone, Random Key.
PIX Key The actual PIX key value where the withdrawal will be sent.
External ID A unique identifier for this withdrawal in your own system, used for tracking purposes.
Description Optional description for the withdrawal, e.g., "Withdrawal to main account".

Output

The node outputs JSON data representing the result of the withdrawal creation request. This typically includes details such as confirmation status, transaction identifiers, timestamps, and any relevant metadata returned by the AbacatePay API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the AbacatePay API.
  • The node depends on the AbacatePay API service being available and reachable.
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials can cause authentication failures.
    • Providing an amount less than 350 cents will likely trigger validation errors.
    • Incorrect PIX key format or mismatched PIX key type may cause the API to reject the request.
    • Duplicate external IDs might lead to conflicts or errors if the API expects uniqueness.

  • Error messages:

    • Authentication errors: Check that the API key credential is correctly set up and valid.
    • Validation errors about amount or PIX key: Ensure the amount meets minimum requirements and the PIX key matches the selected type.
    • Network or timeout errors: Verify network connectivity and API availability.

Links and References

Discussion