Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node provides integration with the Zappfy API, specifically enabling sending PIX payments through the "Enviar PIX" operation under the "Mensagem" resource. This operation allows users to programmatically send PIX transactions by specifying recipient details and payment key information.

Common scenarios for this node include automating PIX payments in workflows such as:

  • Sending instant payments to customers or suppliers.
  • Automating refunds or payouts via PIX.
  • Integrating PIX transfers into broader business processes like order fulfillment or financial reconciliation.

For example, a user can configure the node to send a PIX payment to a beneficiary by providing the beneficiary's name, PIX key type (phone, email, CPF, CNPJ, or random), and the actual PIX key value.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the PIX payment.
Número Do Destinatário The recipient's number or identifier where the PIX is sent.
Nome Do Beneficiário The name of the PIX payment beneficiary.
Tipo Da Chave The type of PIX key used; options are: Telefone (phone), E-Mail (email), CPF, CNPJ, Aleatória (random).
Chave PIX The PIX key value of the beneficiary.

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to send the PIX payment. The exact structure depends on the API response but typically includes confirmation details about the transaction status.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The base URL for requests is https://docs.zappfy.io/api-reference.

Troubleshooting

  • Operation not supported error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "messages-api" and "send-pix" respectively.
  • Missing required properties: Ensure all required fields (instance name, recipient number, beneficiary name, key type, and PIX key) are provided.
  • API authentication errors: Confirm that the API credentials are valid and properly configured in n8n.
  • Network or connectivity issues: Check network access to the Zappfy API endpoint.

Links and References

Discussion