gigstack API
  1. Payments
gigstack API
  • Clients
    • List clients
      GET
    • Create client
      POST
    • Get client
      GET
    • Update client
      PUT
    • Delete client
      DELETE
    • Validate client fiscal information
      POST
    • Get customer portal access token
      POST
    • Stamp pending receipts
      POST
  • Services
    • List services
      GET
    • Create service
      POST
    • Get service
      GET
    • Update service
      PUT
    • Delete service
      DELETE
  • Invoices
    • List income invoices
      GET
    • Create income invoice
      POST
    • Get income invoice
      GET
    • Get invoice files
      GET
    • Cancel invoice
      DELETE
  • Payments
    • List payments
      GET
    • Get payment
      GET
    • Cancel payment
      DELETE
    • Request payment
      POST
    • Register payment
      POST
    • Mark payment as paid
      POST
    • Refund payment
      POST
  • Teams
    • List teams
    • Create team
    • Get team
    • Update team
    • Get team integrations
    • Add team member
    • Remove team member
    • Get team series
    • Create team series
    • Update team series
    • Update team settings
  • Users
    • List users
    • Create user
    • Get user
    • Update user
    • Reset user password
  1. Payments

Register payment

Prod Env
https://api.gigstack.io/v2
Prod Env
https://api.gigstack.io/v2
POST
https://api.gigstack.io/v2
/payments/register
Register a payment.
gigstack Connect: Register payments for other teams using the team parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.gigstack.io/v2/payments/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client": {
        "id": "client_1234567890",
        "search": {
            "on_key": "tax_id",
            "on_value": "PEGJ800101ABC",
            "auto_create": true
        },
        "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": [
            "user@example.com"
        ],
        "metadata": {},
        "legal_name": "Juan Pérez García",
        "tax_id": "PEGJ800101ABC",
        "use": "P01",
        "tax_system": "601"
    },
    "automation_type": "payment",
    "currency": "MXN",
    "exchange_rate": 1,
    "items": [
        {
            "id": "service_1234567890",
            "search": {
                "on_key": "sku",
                "on_value": "CONS-001",
                "auto_create": true
            },
            "quantity": 1,
            "description": "Consulting services",
            "sku": "CONS-001",
            "product_key": "80141503",
            "unit_key": "E48",
            "unit_name": "Servicio",
            "unit_price": 1000,
            "taxes": [
                {
                    "base": "01",
                    "factor": "Tasa",
                    "inclusive": false,
                    "rate": 0.16,
                    "type": "iva",
                    "withholding": false
                }
            ],
            "third_party": {
                "legal_name": "Third Party SA",
                "tax_id": "TPR800101ABC",
                "tax_system": "601",
                "zip": "03100"
            }
        }
    ],
    "paid": true,
    "metadata": {},
    "invoice_config": {
        "serie": "A",
        "folio": "123"
    }
}'
Response Response Example
{
    "message": "Operation completed successfully",
    "data": {}
}

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Query Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Payment registered successfully
Body

Modified at 2025-08-19 00:01:14
Previous
Request payment
Next
Mark payment as paid
Built with