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
    • Search clients
      GET
    • Upload CSF PDF to create or update client
      POST
    • Upload support document
      POST
    • List support documents
      GET
    • Health check
      GET
  • Services
    • Services API Guide
    • List services
    • Get service
    • Update service
    • Create service
    • Delete service
    • Health check
  • Invoices
    • Invoices API Guide
    • Income
      • List income invoices
      • Create income invoice
      • Get income invoice
    • Egress
      • List egress invoices
      • Create egress invoice
      • Get egress invoice
    • Drafts
      • Create draft invoice (pre-factura)
      • Stamp draft invoice (finalize)
      • Generate draft preview PDF (pre-factura)
      • Delete draft invoice
      • Update draft invoice
      • Get draft invoice
      • List draft invoices
    • List CFDI errors
    • List payment complement invoices
    • Get payment complement invoice
    • Get invoice files
    • Upload support document
    • List support documents
    • Cancel invoice
    • Search invoices
    • List SAT invoices
    • Get a SAT invoice
    • Retry XML download
    • Generate PDF for a received SAT invoice
    • Create payment complement (complemento de pago)
    • Resend invoice email
    • Get invoice
    • Health check
    • Trigger end-of-month global invoicing
    • Connect FIEL credentials from a PFX file
    • Update bulk-download sync period
  • 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
    • Search payments
      GET
    • Update payment
      PUT
    • Upload support document
      POST
    • List support documents
      GET
    • Health check
      GET
  • Receipts
    • Receipts API Guide
    • List receipts
    • Get receipt
    • Create receipt
    • Stamp receipt
    • Cancel receipt
    • Search receipts
    • Health check
  • Teams
    • Teams API Guide
    • List teams
    • Get team
    • Get team integrations (not implemented)
    • 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
    • Delete team
    • Upload SAT CSD certificates
    • Sign manifest document
    • Health check
  • Users
    • Users API Guide
    • List users
    • Get user
    • Update user
    • Create user
    • Reset user password
    • Generate login link
    • Delete user
    • Reset user password
    • Health check
  • 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)
    • Search SAT product keys
    • Search SAT unit keys
    • Health check
  • Webhooks
    • Webhooks
    • List webhooks
    • Create webhook
    • Get webhook
    • Update webhook
    • Delete webhook
    • Health check
  • Retentions
    • Retentions
    • List retentions
    • Create retention
    • Get retention
    • Cancel retention
    • Get retention files
  • Descarga Masiva SAT
    • Descarga Masiva
    • Check activation status
    • Activate Descarga Masiva SAT
    • Deactivate Descarga Masiva SAT
    • Upload FIEL credentials
    • Register business with SAT (manual)
    • Get schedule configuration
    • Save schedule configuration
    • Get download request history
    • Create bulk download request
    • Check download request status
    • Download XML package
    • Get single invoice from SAT
    • Debug registration status
    • Enable SAT sync
  • Auth
    • Headless signup (API-only path)
    • Health check
  • SAT Lists
    • List SAT lists and sync status
    • Check an RFC against the SAT lists
    • Consult the SAT "Opinión del Cumplimiento" (32-D) for an RFC
  • Documents
    • List documents
    • Create document
    • Get document
    • Update document
    • Delete document
    • Analyze document with AI
    • Link document to an entity
    • Unlink document from an entity
  • Apidog connectivity test
    GET
  • Schemas
    • Schemas
      • ApiResponse
      • Category
      • Pet
      • Tag
      • Order
      • StandardizedSuccessResponse
      • StandardizedErrorResponse
      • ApiErrorCode
    • RequestBodies
      • UserArray
    • SatInvoice
    • DateRangeFilter
    • OrderDirection
    • ListQueryParams
    • PaginationMeta
    • ApiPublicProductKey
    • ApiPublicUnitKey
    • Client
    • ApiPublicService
    • ApiPublicClient
    • Service
    • PendingReceiptsSummary
    • CfdiError
    • ClientInput
    • ServiceInput
    • Invoice
    • DraftInvoiceInput
    • DraftInvoiceUpdateInput
    • DraftInvoiceOutput
    • PaymentComplementRelatedDocument
    • InvoiceIncomeInput
    • InvoiceEgressInput
    • PaymentComplementPayment
    • PaymentItem
    • PaymentComplementInput
    • PaymentAllowedMethod
    • InvoiceInput
    • ApiPublicPaymentProcessorDetails
    • Payment
    • ApiPublicPayment
    • PaymentInput
    • RequestPaymentInput
    • RegisterPaymentInput
    • RefundPaymentInput
    • InvoiceConfigInput
    • MarkPaymentAsPaidInput
    • ApiPublicUser
    • UpdatePaymentInput
    • ApiPublicWebhook
    • ApiPublicIncomeInvoice
    • ApiPublicTeam
    • Team
    • WebhookInput
    • WebhookUpdateInput
    • User
    • TeamInput
    • TeamSettingsInput
    • SeriesInput
    • TeamSettings
    • Series
    • UserInput
    • ApiPublicSearch
    • ApiPublicThirdParty
    • ApiPublicInvoiceConfig
    • ReceiptInput
    • ApiPublicRefund
    • DocumentTypeEnum
    • DocumentComplianceStatusEnum
    • ApiPublicAutomations
    • DocumentLinkEntityTypeEnum
    • TeamTaxDefault
    • DocumentInput
    • BadRequestError
    • ClientAddress
    • DocumentUpdateInput
    • DocumentLinkInput
    • SatListRfcCheck
    • ApiPublicDocument
    • TaxElement
    • PaymentMethodEnum
    • PaymentFormEnum
    • TaxSchema
    • SatListDefinition
    • AutomationTypeEnum
    • StandardSuccessResponse
    • StandardErrorResponse
    • SATDocument
    • HealthResponse
    • UploadSupportDocumentInput
    • CfdiErrorResponse
    • CreditLimitResponse
    • ListResponse
    • SearchResponse
    • ErrorResponse
    • ValidationErrorResponse
    • UnauthorizedError
    • NotFoundError
    • InternalServerError
    • LegacyErrorResponse
    • SatOpinion32dCheck
    • ItemSchema
  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
reason and amount are both required. amount must be at least 0.01 — the
validator rejects anything below it.

Request

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

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Payment refunded successfully
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.gigstack.io/v2/payments/payment_1234567890/refund?team=undefined' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "Customer requested cancellation",
    "amount": 1160,
    "external_processor_refund": true
}'
Response Response Example
200 - Example 1
{
    "success": true,
    "data": {
        "refund": {
            "id": "refund_1234567890",
            "reason": "Customer requested cancellation",
            "total": 1160,
            "status": "succeeded",
            "timestamp": 1767225600000,
            "from": "api",
            "external_processor_refund": true
        },
        "payment": {
            "id": "payment_1234567890",
            "amount": 116000,
            "total_refunded": 116000,
            "refund_status": "refunded"
        }
    },
    "message": "Operation completed successfully",
    "timestamp": 1767225600000
}
Modified at 2026-08-13 23:10:14
Previous
Mark payment as paid
Next
Cancel payment
Built with