List payments

curl --request GET \
  --url https://api.gigstack.io/v2/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gigstack.io/v2/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "Payments retrieved successfully",
  "data": [
    {
      "id": "payment_1234567890",
      "client": {
        "id": "client_1234567890",
        "name": "ESCUELA KEMPER URGATE",
        "legal_name": "ESCUELA KEMPER URGATE",
        "email": "contabilidad@ejemplo.com",
        "bcc": [],
        "phone": "+524421234567",
        "tax_id": "EKU9003173C9",
        "tax_system": "601",
        "use": "G03",
        "address": {
          "street": "Av. Constituyentes",
          "exterior": "1000",
          "neighborhood": "Centro",
          "city": "Querétaro",
          "state": "QRO",
          "zip": "76000",
          "country": "MEX"
        },
        "is_valid": true,
        "efos": {
          "is_valid": true
        },
        "metadata": {},
        "livemode": true,
        "from": "api",
        "owner": "user_1234567890",
        "team": "team_1234567890",
        "created_at": 1767225600000
      },
      "emails": [
        "contabilidad@ejemplo.com"
      ],
      "currency": "MXN",
      "allowed_payment_methods": [
        "card",
        "bank"
      ],
      "exchange_rate": 1,
      "items": [
        {
          "id": "service_1234567890",
          "description": "Servicios de consultoría profesional",
          "quantity": 1,
          "unit_price": 1000,
          "product_key": "80141503",
          "unit_key": "E48",
          "unit_name": "Unidad de servicio",
          "taxes": [
            {
              "type": "IVA",
              "rate": 0.16,
              "factor": "Tasa",
              "withholding": false
            }
          ],
          "team": "team_1234567890",
          "created_at": 1767225600000,
          "from": "api"
        }
      ],
      "metadata": {},
      "team": "team_1234567890",
      "idempotency_key": "payment-2026-0001",
      "from": "api",
      "invoices": [
        "B0C3E4F2-1A2B-4C5D-9E8F-0123456789AB"
      ],
      "livemode": true,
      "owner": "user_1234567890",
      "payment_form": "03",
      "payments": [],
      "receipts": [],
      "refunds": [],
      "short_url": "https://gigstack.xyz/Xk3mP9",
      "success_url": null,
      "status": "succeeded",
      "total": 1160,
      "total_refunded": 0,
      "subtotal": 1000,
      "taxes": 160,
      "discount": 0,
      "withholding_taxes": 0,
      "created_at": 1767225600000,
      "succeeded_at": 1767225900000,
      "payment_processor": "api"
    }
  ],
  "next": null,
  "has_more": false,
  "total_results": 1,
  "timestamp": 1767225600000
}

GET

payments

List payments

curl --request GET \
  --url https://api.gigstack.io/v2/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gigstack.io/v2/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "Payments retrieved successfully",
  "data": [
    {
      "id": "payment_1234567890",
      "client": {
        "id": "client_1234567890",
        "name": "ESCUELA KEMPER URGATE",
        "legal_name": "ESCUELA KEMPER URGATE",
        "email": "contabilidad@ejemplo.com",
        "bcc": [],
        "phone": "+524421234567",
        "tax_id": "EKU9003173C9",
        "tax_system": "601",
        "use": "G03",
        "address": {
          "street": "Av. Constituyentes",
          "exterior": "1000",
          "neighborhood": "Centro",
          "city": "Querétaro",
          "state": "QRO",
          "zip": "76000",
          "country": "MEX"
        },
        "is_valid": true,
        "efos": {
          "is_valid": true
        },
        "metadata": {},
        "livemode": true,
        "from": "api",
        "owner": "user_1234567890",
        "team": "team_1234567890",
        "created_at": 1767225600000
      },
      "emails": [
        "contabilidad@ejemplo.com"
      ],
      "currency": "MXN",
      "allowed_payment_methods": [
        "card",
        "bank"
      ],
      "exchange_rate": 1,
      "items": [
        {
          "id": "service_1234567890",
          "description": "Servicios de consultoría profesional",
          "quantity": 1,
          "unit_price": 1000,
          "product_key": "80141503",
          "unit_key": "E48",
          "unit_name": "Unidad de servicio",
          "taxes": [
            {
              "type": "IVA",
              "rate": 0.16,
              "factor": "Tasa",
              "withholding": false
            }
          ],
          "team": "team_1234567890",
          "created_at": 1767225600000,
          "from": "api"
        }
      ],
      "metadata": {},
      "team": "team_1234567890",
      "idempotency_key": "payment-2026-0001",
      "from": "api",
      "invoices": [
        "B0C3E4F2-1A2B-4C5D-9E8F-0123456789AB"
      ],
      "livemode": true,
      "owner": "user_1234567890",
      "payment_form": "03",
      "payments": [],
      "receipts": [],
      "refunds": [],
      "short_url": "https://gigstack.xyz/Xk3mP9",
      "success_url": null,
      "status": "succeeded",
      "total": 1160,
      "total_refunded": 0,
      "subtotal": 1000,
      "taxes": 160,
      "discount": 0,
      "withholding_taxes": 0,
      "created_at": 1767225600000,
      "succeeded_at": 1767225900000,
      "payment_processor": "api"
    }
  ],
  "next": null,
  "has_more": false,
  "total_results": 1,
  "timestamp": 1767225600000
}

Authorizations

Authorization

string

header

required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

Errors: credential failures are answered by the authentication layer with a raw { "message": … } body, not the standardized envelope — 401 for a missing, malformed or expired token, 403 for a revoked key or a plan without API access. See the Unauthorized and AuthForbidden responses.

Query Parameters

team

string

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

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

Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a team other than the one your API key belongs to return 403 without it.

Only API keys can use it: an OAuth access token sent with another team's id is rejected with 403 Team mismatch with OAuth token.

Optional — omit it entirely unless you are acting on another team. It deliberately carries no example value so generated snippets do not emit ?team=undefined; when the parameter is absent, the team is derived from your API key.

Example: ?team=team_xyz789

limit

integer

default:10

Maximum number of items to return (default 10, max 100)

Required range: 1 <= x <= 100

string | null

Pagination cursor for the next page of results

order_by

enum<string>

default:timestamp

Field name to order results by

Available options:

name,

timestamp

sort

enum<string>

Sort direction for the results Sort direction for list queries

Available options:

asc,

desc

created[gte]

Filter results created on or after this timestamp. Accepts Unix timestamp in seconds (e.g., 1733011200), milliseconds (e.g., 1733011200000), or ISO 8601 date string (e.g., 2024-12-01).

created[lte]

Filter results created on or before this timestamp. Accepts Unix timestamp in seconds (e.g., 1735689599), milliseconds (e.g., 1735689599000), or ISO 8601 date string (e.g., 2024-12-31).

created[gt]

Filter results created after this timestamp. Accepts Unix timestamp in seconds (e.g., 1733011200), milliseconds (e.g., 1733011200000), or ISO 8601 date string (e.g., 2024-12-01).

created[lt]

Filter results created before this timestamp. Accepts Unix timestamp in seconds (e.g., 1735689599), milliseconds (e.g., 1735689599000), or ISO 8601 date string (e.g., 2024-12-31).

status

enum<string>

Filter payments by status

Available options:

requires_payment_method,

succeeded,

partially_paid,

canceled

currency

string

Filter payments by currency code (e.g., MXN, USD)

amount

number

Filter payments by amount

client_id

string

Filter payments by client ID

string

Filter payments by client email address

tax_id

string

Filter payments by client tax ID (RFC)

client_name

string

Filter payments by client name

metadata.{key}

string

Filter by any metadata field using dot notation (e.g., metadata.order_id=ORD-123) or underscore notation (e.g., metadata_order_id=ORD-123). Both formats are supported and equivalent.

Response

Payments retrieved successfully

Response shape of the Firestore-backed list handlers. Note this is not the standardized envelope: data sits at the top level alongside the pagination keys and message/success/timestamp, rather than under a data wrapper.

A few modules (clients, payments) take a second code path when the request carries metadata.* / metadata_* filters and the team has Typesense configured: Typesense resolves the matching ids and the documents are then re-read from Firestore. That path returns has_more, total_results, page and per_page instead of the cursor-style next. Modules without a Typesense branch (invoices list, receipts, retentions, users) only ever return the cursor form.

Full-text /search endpoints are different again — see SearchResponse.

success

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Example:

"Items retrieved successfully"

data

object[]

required

timestamp

integer<int64>

required

Server time in epoch milliseconds.

Example:

1767225600000

string | null

Cursor for the next page. Cursor-style (Firestore) path only.

Example:

"eyJjcmVhdGVkX2F0IjoxNjc3NjUxMjM0fQ=="

has_more

boolean

Metadata-filtered (Typesense-assisted) path only.

Example:

true

total_results

number

Metadata-filtered (Typesense-assisted) path only.

Example:

150

page

integer

Metadata-filtered (Typesense-assisted) path only.

Example:

1

per_page

integer

Metadata-filtered (Typesense-assisted) path only.

Example:

10

Clients

Services

Descarga Masiva SAT

Invoices

Payments

Receipts

Retentions

Teams

Users

Webhooks

Catalogs

Auth

SAT Lists

Documents

Platform Payouts

List payments

Authorizations

Query Parameters

Response