Sign in

v1

latestOpenAPI 3.0.3Proprietaryraw.githubusercontent.com2026-03-067260437.0 KB
Payments

Refund payment

Refund a payment with a specified reason and amount.

gigstack Connect: Refund other teams' payments using the team parameter.

Key Features

  • Partial or full refunds supported
  • Optional external processor refund handling
  • Automatic refund tracking and reporting
  • Supports Stripe integration for automatic processor refunds
post/payments/{id}/refund

Path parameters

idstring required

Query parameters

teamstring

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Example: ?team=team_xyz789

Request body

reasonstring required

Reason for the refund

amountnumber required

Amount to refund

external_processor_refundboolean nullable

Whether to process refund through external payment processor

Example request

{
  "reason": "Customer requested cancellation",
  "amount": 1160
}

Response

Payment refunded successfully

messagestring required
dataobject required

Example response

{
  "message": "Operation completed successfully"
}