gigstack API
  1. Payments
gigstack API
  • Welcome to gigstack API
  • gigstack Connect API Guide
  • Migrar de API v1 a v2 de gigstack
  • Clients
    • Clients API Guide
    • List clients
      GET
    • Get client
      GET
    • Update client
      PUT
    • Create client
      POST
    • Validate client fiscal information
      POST
    • Get client customer portal access token
      POST
    • Stamp pending receipts
      POST
    • Delete client
      DELETE
  • Services
    • Services API Guide
    • List services
      GET
    • Get service
      GET
    • Update service
      PUT
    • Create service
      POST
    • Delete service
      DELETE
  • Invoices
    • Invoices API Guide
    • Income
      • List income invoices
      • Get income invoice
      • Create income invoice
    • Egress
      • List egress invoices
      • Get egress invoice
      • Create egress invoice
    • Get invoice files
      GET
    • Cancel invoice
      DELETE
  • Payments
    • Payments API Guide
    • List payments
      GET
    • Get payment
      GET
    • Request payment
      POST
    • Register payment
      POST
    • Mark payment as paid
      POST
    • Refund payment
      POST
    • Cancel payment
      DELETE
  • Receipts
    • Receipts API Guide
    • List receipts
    • Get receipt
    • Create receipt
    • Stamp receipt
    • Cancel receipt
  • Teams
    • Teams API Guide
    • List teams
    • Get team
    • Get team integrations
    • Get team series
    • Get team onboarding URL
    • Update team
    • Update team series
    • Update team settings
    • Create team
    • Add team member
    • Remove team member
    • Create team series
  • Users
    • Users API Guide
    • List users
    • Get user
    • Update user
    • Create user
    • Reset user password
  • Catalogs
    • Tax Regimes Catalog (Régimen Fiscal)
    • Payment Forms | Formas de pago
    • CFDI Usage Catalog (Uso CFDI)
    • Payment Methods Catalog (Método de Pago)
    • Months and Bimesters Catalog (Meses y Bimestres)
    • Invoice Relationships Catalog (Relación entre Facturas)
  1. Payments

Refund payment

POST
https://api.gigstack.io/v2/payments/{id}/refund
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

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Correcto
application/json
Payment refunded successfully
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.gigstack.io/v2/payments//refund?team' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "Customer requested cancellation",
    "amount": 1160,
    "external_processor_refund": true
}'
Response Response Example
{
    "message": "Operation completed successfully",
    "data": {}
}
Modified at 2025-10-09 23:51:05
Previous
Mark payment as paid
Next
Cancel payment
Built with