Search payments
Full-text search across payments using Typesense. Provides fast, typo-tolerant search capabilities.
gigstack Connect: Access other teams' payments using the team parameter.
Search Capabilities:
- Search across client name, email, payment ID, description, and metadata
- Typo-tolerant fuzzy matching
- Filter search results by status, currency, or client ID
- Paginated results
Requirements:
- Typesense must be configured for your team
- The q (or query) parameter is required
Query parameters
gigstack Connect: Target team ID for multi-team access.
Requires gigstack Connect enabled on your team and shared billing account.
Example: ?team=team_xyz789
Search query text (primary parameter). Searches across relevant fields depending on the collection (e.g., client name, email, payment ID, description, metadata). The query parameter is also accepted as a backward-compatible alternative.
Alternative to q, kept for backward compatibility. If both are provided, q takes precedence.
Maximum number of items to return (default 50, max 100)
Page number for pagination (default 1)
Comma-separated list of fields to include in the response
Filter payments by status
Filter payments by currency code (e.g., MXN, USD)
Filter payments by client ID
Response
Payments searched successfully
Example response
{
"message": "Payments searched successfully",
"data": [
{
"id": "payment_1234567890",
"client": {
"id": "client_1234567890",
"address": {
"country": "MEX",
"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": {
"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": [
{
"factor": "Tasa",
"rate": 0.16,
"type": "IVA"
}
],
"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
}
}
],
"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": [
{
"factor": "Tasa",
"rate": 0.16,
"type": "IVA"
}
],
"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": "succeeded",
"total": 1160,
"subtotal": 1000,
"taxes": 160,
"created_at": 1677651234,
"succeeded_at": 1677651234,
"payment_processor": "stripe",
"payment_processor_details": {
"stripe": {
"payment_intent": "pi_1234567890",
"charge": "ch_1234567890",
"invoice": "in_1234567890"
}
}
}
],
"found": 15,
"page": 1,
"per_page": 10,
"success": true,
"timestamp": 1677651234000
}