Actions29
- Cliente Actions
- Antecipação Actions
- Assinatura Actions
- Cobrança Actions
- Link De Pagamento Actions
- Webhook Actions
Overview
This node integrates with the Asaas API to create payment links ("Link De Pagamento"). It allows users to generate customizable payment URLs that customers can use to pay invoices or subscriptions via various payment methods such as bank slip (boleto), credit card, PIX, or letting the customer choose the payment type.
Common scenarios include:
- Generating a fixed amount payment link for one-time payments.
- Creating recurring subscription payment links with configurable billing cycles.
- Allowing customers to define their own payment amount.
- Sending email notifications automatically when the payment link is used.
- Activating or deactivating payment links dynamically.
Practical example: A small business wants to send a payment link to clients for a monthly subscription service. They configure a recurring payment link with monthly billing cycle and enable email notifications so clients receive reminders.
Properties
| Name | Meaning |
|---|---|
| Nome * | The name of the payment link. |
| Descrição | Optional description of the payment link. |
| Tipo De Cobrança * | Accepted payment methods on the link. Options: Boleto Bancário (bank slip), Cartão De Crédito (credit card), PIX, Indefinido (customer chooses). |
| Tipo De Valor * | Type of charge: Valor Fixo (fixed value), Valor Recorrente (recurring subscription), Valor Livre (customer defines amount). |
| Valor * | The amount to be charged in BRL. Required if charge type is fixed or recurring. |
| Data De Vencimento | Due date for the payment (optional, only for fixed value charges). |
| Ciclo De Cobrança * | Billing cycle for recurring charges. Options: Anual, Bimestral, Mensal, Quinzenal, Semanal, Semestral, Trimestral. |
| Data De Término | End date for the subscription (optional, only for recurring charges). |
| Máximo De Cobranças | Maximum number of installments (1 to 12) allowed (only for fixed value charges). |
| Notificar Por Email | Boolean flag to enable or disable email notifications related to the payment link. |
| Ativo | Boolean flag indicating whether the payment link is active. |
Output
The node outputs JSON data representing the created payment link object returned by the Asaas API. This includes all details about the payment link such as its ID, URL, status, billing type, charge type, value, due dates, subscription cycles, notification settings, and activation status.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Asaas API.
- The node uses the Asaas API base URL, which switches between sandbox and production environments based on credential configuration.
- No additional external dependencies are required beyond network access to the Asaas API.
Troubleshooting
- Package Removal Error: If the node throws an error stating the package was removed from npm and is no longer available, it indicates the node's underlying package is deprecated or unpublished. The user should remove this node from their workflow.
- Invalid Customer ID: When creating payment links, if the customer ID is missing or invalid, the node will throw an error. Ensure the customer ID parameter is correctly set.
- Missing Required Fields: Required fields like "Nome", "Tipo De Cobrança", "Tipo De Valor", and "Valor" (when applicable) must be provided; otherwise, the node will fail.
- API Authentication Errors: Incorrect or missing API keys will cause authentication failures. Verify credentials are properly configured.
- Date Format Issues: Date/time fields must be valid ISO strings; invalid formats may cause API errors.
Links and References
- Asaas API Documentation (official API docs for payment links)
- n8n Documentation (for general usage of custom nodes and credentials)