List payments

GET

https://api.gigstack.io/v2/payments

Retrieve a paginated list of payments with powerful filtering capabilities.

gigstack Connect: Access other teams' payments using the team parameter.

Filtering Options:

Filter by payment status, currency, amount

Filter by client ID, email, tax ID (RFC), or name

Filter by metadata fields using dot or underscore notation (e.g., metadata.order_id or metadata_order_id)

Filter by creation date using comparison operators

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

Responses

🟢200OK

application/json

Payments retrieved successfully

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://api.gigstack.io/v2/payments?team=undefined&limit=undefined&next=undefined&order_by=undefined&sort=undefined&created[gte]=1733011200&created[lte]=1735689599&status=undefined&currency=undefined&amount=undefined&client_id=undefined&email=undefined&tax_id=undefined&client_name=undefined&metadata.{key}=undefined' \
--header 'Authorization: <api-key>'

Response Example

{
    "message": "Items retrieved successfully",
    "data": [
        {}
    ],
    "next": "eyJjcmVhdGVkX2F0IjoxNjc3NjUxMjM0fQ==",
    "has_more": true,
    "total_results": 150
}

Modified at 2026-05-07 15:46:23

Payments API Guide

Get payment