Gigstack icon

Gigstack

Interact with Gigstack API for Mexican tax-compliant invoicing and payments

Actions82

Payment → Request

AI-generated

Overview

This node operation allows users to create a payment request for a client using the Gigstack API. It is useful for scenarios where a business needs to request payments from clients for specific services or products, specifying details such as items, payment methods, currency, and automation options. For example, a company can request a payment from a client for multiple services with different quantities and prices, choose allowed payment methods like card or bank transfer, and decide whether to automatically create an invoice upon payment completion.

Use Case Examples

  1. Requesting a payment from a client for a set of services with specified quantities and prices.
  2. Configuring allowed payment methods for the client to choose from during payment.
  3. Setting the currency and exchange rate for the payment request.
  4. Automatically creating an invoice when the payment is completed.

Properties

Name Meaning
Client ID The ID of the client for this payment, identifying who the payment request is for.
Items The payment line items specifying the services or products, their quantities, and optional unit price overrides.
Automation Type Defines what happens automatically when the payment is completed, such as creating an invoice or no automatic action.
Additional Fields Optional additional settings for the payment request, including currency, exchange rate, email sending options, additional emails, and custom metadata.
Allowed Payment Methods The payment methods available to the customer for completing the payment, such as card, bank transfer, or OXXO.
Team ID Optional team ID for multi-team access; if empty, the default team is used.

Output

JSON

  • id - The unique identifier of the created payment request.
  • client
    • id - The client ID associated with the payment request.
  • items - Array of payment line items with details such as service ID, quantity, and unit price.
  • automation_type - The automation type set for the payment request.
  • allowed_payment_methods - The list of allowed payment methods for the payment.
  • currency - The currency used for the payment.
  • exchange_rate - The exchange rate applied to the payment.
  • send_email - Indicates if the payment request email was sent to the client.
  • emails - Additional email addresses the payment request was sent to.
  • metadata - Custom metadata included with the payment request.

Dependencies

  • Gigstack API key credential

Troubleshooting

  • Ensure the Client ID is valid and exists in the Gigstack system to avoid errors.
  • Verify that the items array contains valid service IDs and quantities; invalid or missing data may cause request failures.
  • Check that the automation type and allowed payment methods are correctly set to supported values.
  • If sending emails, confirm that the email addresses are correctly formatted and the email service is operational.
  • Handle API errors gracefully and check for network connectivity issues when making requests to the Gigstack API.

Links

Discussion