Gigstack icon

Gigstack

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

Actions82

Payment → Refund

AI-generated

Overview

This node operation allows users to refund a payment through the Gigstack API. It is useful in scenarios where a payment needs to be partially or fully refunded, optionally including a refund through an external payment processor like Stripe. For example, a business can automate refund processing for customer payments directly within their workflow.

Use Case Examples

  1. Refund a payment of $50 with a reason 'Product returned' and also refund through the external payment processor.
  2. Refund a partial amount of a payment without specifying a reason and without refunding through the external processor.

Properties

Name Meaning
Payment ID The ID of the payment to be refunded.
Refund Amount The amount of money to refund for the payment, with precision up to two decimal places.
Refund Reason Optional reason for the refund, providing context or explanation.
External Processor Refund Boolean flag indicating whether to also refund through the external payment processor (e.g., Stripe).
Team ID Optional team ID for multi-team access in Gigstack Connect. Leave empty to use the default team.

Output

JSON

  • amount - The refunded amount.
  • external_processor_refund - Indicates if the refund was processed through the external payment processor.
  • reason - The reason provided for the refund.
  • id - The ID of the refunded payment transaction.
  • status - The status of the refund operation.

Dependencies

  • Gigstack API with API key credential

Troubleshooting

  • Ensure the Payment ID is valid and exists in the system to avoid 'not found' errors.
  • Verify that the refund amount does not exceed the original payment amount to prevent validation errors.
  • If refunding through an external processor, ensure the external payment processor credentials and configurations are correctly set up.
  • Check network connectivity and API access permissions if the request fails to reach the Gigstack API.

Links

Discussion