gigstack API
    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 client
      • Update client
      • Create client
      • Validate client fiscal information
      • Get client customer portal access token
      • Stamp pending receipts
      • Delete client
      • Upload CSF PDF to create or update client
    • Services
      • Services API Guide
      • List services
      • Get service
      • Update service
      • Create service
      • Delete service
    • Invoices
      • Invoices API Guide
      • Income
        • List income invoices
        • Get income invoice
        • Create income invoice
      • Egress
        • List egress invoices
        • Get egress invoice
        • Create egress invoice
      • List CFDI errors
      • List payment complement invoices
      • Get payment complement invoice
      • Get invoice files
      • Cancel invoice
    • Payments
      • Payments API Guide
      • List payments
      • Get payment
      • Request payment
      • Register payment
      • Mark payment as paid
      • Refund payment
      • Cancel payment
      • Search payments
    • 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
      • Upload SAT CSD certificates
      • Sign manifest document
    • Users
      • Users API Guide
      • List users
      • Get user
      • Update user
      • Create user
      • Reset user password
      • Generate login link
    • 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)
    • Webhooks
      • Webhooks
      • List webhooks
      • Create webhook
      • Get webhook
      • Update webhook
      • Delete webhook
    • Schemas
      • Schemas
        • ApiResponse
        • Category
        • Pet
        • Tag
        • Order
        • StandardizedSuccessResponse
        • StandardizedErrorResponse
        • ApiErrorCode
      • RequestBodies
        • UserArray
      • OrderDirection
      • ApiPublicClient
      • Client
      • DateRangeFilter
      • Service
      • ListQueryParams
      • ClientInput
      • ApiPublicService
      • ServiceInput
      • PaginationMeta
      • Invoice
      • InvoiceIncomeInput
      • Payment
      • PaymentInput
      • PaymentItem
      • InvoiceInput
      • InvoiceEgressInput
      • Team
      • PaymentAllowedMethod
      • TeamInput
      • TeamSettingsInput
      • CfdiError
      • ApiPublicPaymentProcessorDetails
      • User
      • ApiPublicPayment
      • UserInput
      • ClientAddress
      • TaxSchema
      • StandardSuccessResponse
      • RequestPaymentInput
      • RegisterPaymentInput
      • ListResponse
      • ErrorResponse
      • ApiPublicIncomeInvoice
      • ValidationErrorResponse
      • RefundPaymentInput
      • ApiPublicTeam
      • UnauthorizedError
      • MarkPaymentAsPaidInput
      • ApiPublicUser
      • NotFoundError
      • ApiPublicSearch
      • InternalServerError
      • ApiPublicThirdParty
      • ApiPublicInvoiceConfig
      • ApiPublicRefund
      • ApiPublicAutomations
      • TeamSettings
      • TaxElement
      • SeriesInput
      • Series
      • ApiPublicWebhook
      • ReceiptInput
      • WebhookInput
      • WebhookUpdateInput
      • PaymentMethodEnum
      • PaymentFormEnum
      • AutomationTypeEnum
      • ItemSchema

    ApiPublicPayment

    {
        "id": "payment_1234567890",
        "client": {
            "id": "client_1234567890",
            "address": {
                "country": "Mexico",
                "street": "Av. Insurgentes Sur",
                "zip": "03100",
                "city": "Ciudad de México",
                "state": "CDMX",
                "exterior": "123",
                "interior": "4B",
                "municipality": "Benito Juárez",
                "neighborhood": "Del Valle"
            },
            "name": "Juan Pérez García",
            "company": "Empresa SA de CV",
            "phone": "+52 55 1234 5678",
            "email": "juan.perez@ejemplo.com",
            "bcc": [
                "admin@empresa.com"
            ],
            "metadata": {
                "custom_field": "value"
            },
            "is_valid": true,
            "from": "api",
            "legal_name": "Juan Pérez García",
            "livemode": true,
            "owner": "user_1234567890",
            "tax_id": "PEGJ800101ABC",
            "use": "P01",
            "tax_system": "601",
            "team": "team_1234567890",
            "created_at": 1677651234,
            "efos": {
                "is_valid": true
            },
            "defaults": {
                "keep_full_legal_name": false,
                "issue_automatic_invoices": false,
                "issue_invoiceable_receipts": true
            }
        },
        "emails": [
            "client@example.com"
        ],
        "currency": "MXN",
        "allowed_payment_methods": [
            {
                "id": "card"
            }
        ],
        "exchange_rate": 1,
        "items": [
            {
                "id": "service_1234567890",
                "description": "Consulting services",
                "from": "api",
                "sku": "CONS-001",
                "product_key": "80141503",
                "unit_key": "E48",
                "unit_name": "Servicio",
                "unit_price": 1000,
                "taxes": [
                    {
                        "base": 0,
                        "factor": "Tasa",
                        "inclusive": false,
                        "rate": 0.16,
                        "type": "IVA",
                        "withholding": false
                    }
                ],
                "team": "team_1234567890",
                "created_at": 1677651234,
                "quantity": 1,
                "third_party": {
                    "legal_name": "Third Party SA de CV",
                    "tax_id": "TPR800101ABC",
                    "tax_system": "601",
                    "zip": "03100"
                },
                "search": {
                    "on_key": "tax_id",
                    "on_value": "PEGJ800101ABC",
                    "auto_create": true,
                    "safety_check": false
                }
            }
        ],
        "metadata": {
            "order_id": "12345"
        },
        "invoice_config": {
            "serie": "A",
            "folio": "123"
        },
        "team": "team_1234567890",
        "idempotency_key": "unique_key_123",
        "from": "api",
        "invoices": [
            "invoice_1234567890"
        ],
        "livemode": true,
        "owner": "user_1234567890",
        "payment_form": "03",
        "payments": [],
        "receipts": [
            "receipt_1234567890"
        ],
        "refunds": [
            {
                "id": "refund_1234567890",
                "items": [
                    {
                        "id": "service_1234567890",
                        "description": "Consulting services",
                        "from": "api",
                        "sku": "CONS-001",
                        "product_key": "80141503",
                        "unit_key": "E48",
                        "unit_name": "Servicio",
                        "unit_price": 1000,
                        "taxes": [
                            {
                                "base": 0,
                                "factor": "Tasa",
                                "inclusive": false,
                                "rate": 0.16,
                                "type": "IVA",
                                "withholding": false
                            }
                        ],
                        "team": "team_1234567890",
                        "created_at": 1677651234,
                        "quantity": 1
                    }
                ],
                "reason": "Customer requested cancellation",
                "created_at": 1677651234,
                "total": 1160
            }
        ],
        "short_url": "https://pay.gigstack.io/p/abc123",
        "status": "requires_payment_method",
        "total": 1160,
        "total_refunded": 0,
        "subtotal": 1000,
        "taxes": 160,
        "discount": 0,
        "withholding_taxes": 0,
        "created_at": 1677651234,
        "succeeded_at": 1677651234,
        "payment_processor": "stripe",
        "payment_processor_details": {
            "stripe": {
                "payment_intent": "pi_1234567890",
                "charge": "ch_1234567890",
                "invoice": "in_1234567890"
            }
        }
    }
    Built with