List Payments

Returns Payments for the organization.

GEThttps://api.tracksales.co/api/v1/payments

Required scope: payments:read

Query Params

searchstring

Search by name, code, or reference

location_idinteger

Filter by branch/location ID

customer_idinteger

Filter by customer ID

payment_typestring

Filter by payment type

limitinteger

Page size (default 20, max 100)

offsetinteger

Pagination offset (default 0)

Responses

200OK

Request succeeded.

401Unauthorized

API key is missing or invalid.

403Forbidden

API key lacks the required scope.

404Not Found

Payments was not found.

422Validation Error

Request validation failed.

curl -X GET 'https://api.tracksales.co/api/v1/payments?limit=20&search=acme' \
  -H 'Authorization: Bearer ts_live_YOUR_API_KEY' \
  -H 'Accept: application/json'

{
    "success": true,
    "data": {
        "items": [
            {
                "payment_id": 801,
                "customerId": 42,
                "amount": 5000,
                "date": "2026-07-03"
            }
        ],
        "total": 1
    }
}

{
    "success": false,
    "error": {
        "code": "unauthenticated",
        "message": "Invalid or revoked API key."
    }
}

{
    "success": false,
    "error": {
        "code": "forbidden",
        "message": "API key lacks required scope."
    }
}

{
    "success": false,
    "message": "Payments not found"
}

{
    "success": false,
    "message": "Validation failed",
    "errors": {
        "field": [
            "The field is required."
        ]
    }
}