AbacatePay icon

AbacatePay

Interact with AbacatePay API

Actions9

Cobrança → Criar Cobrança

AI-generated

Overview

This node interacts with the AbacatePay API to create a new billing charge (Cobrança). It allows users to specify billing details such as frequency, payment methods, product information, customer details, and URLs for redirection after payment or cancellation. This node is useful for automating the creation of payment requests or invoices in systems that integrate with AbacatePay, facilitating online payment processing.

Use Case Examples

  1. Creating a one-time billing charge for a product with specified price and quantity, and redirecting the user to a completion URL after payment.
  2. Creating a recurring billing charge with multiple payments accepted via PIX, including customer details either by existing customer ID or by providing customer information directly.

Properties

Name Meaning
Frequency Billing frequency, either one-time or multiple payments.
Payment Methods Accepted payment methods for the billing charge.
Product External ID Unique product identifier in the user's system.
Product Name Name of the product or service being billed.
Product Description Description of the product or service.
Price in Cents Price of the product in cents (minimum 100 cents).
Quantity Quantity of the product being billed.
Return URL URL where the user will be redirected if they choose to go back during the payment process.
Completion URL URL for redirection after payment completion.
Existing Customer ID ID of an existing registered customer; optional if customer details are provided instead.
Customer Name Customer's name, used if no existing customer ID is provided.
Customer Email Customer's email, used if no existing customer ID is provided.
Customer Tax ID Customer's CPF or CNPJ tax identification, used if no existing customer ID is provided.
Customer Phone Customer's phone number, used if no existing customer ID is provided.

Output

JSON

  • json
    • id - Unique identifier of the created billing charge.
    • status - Status of the billing charge.
    • frequency - Billing frequency set for the charge.
    • methods - Payment methods accepted for the charge.
    • products - Array of product details included in the billing charge.
    • returnUrl - URL for redirection when user chooses to go back.
    • completionUrl - URL for redirection after payment completion.
    • customerId - ID of the customer associated with the billing charge.
    • customer - Customer details if provided instead of customerId.

Dependencies

  • AbacatePay API access with an API token credential

Troubleshooting

  • Common issues include missing required fields such as productExternalId, productName, productPrice, returnUrl, and completionUrl which will cause API errors.
  • If customerId is not provided, customer details must be supplied; otherwise, the API may reject the request.
  • Errors related to authentication usually indicate invalid or missing API token credentials.
  • Network or API endpoint issues can cause request failures; verify the API base URL and network connectivity.

Discussion