Skip to main content
GET
Get Payment Summary
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get Payment Summary The Get Payment Summary endpoint returns aggregated payment statistics for the tenant. Method: GET Authorization:
  • Required role: user or higher
Response Data: Query Parameters:

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

startDate
string<date>

Filter payments from this date (inclusive)

endDate
string<date>

Filter payments to this date (inclusive)

currency
string

Filter by currency code (e.g., USD, EUR)

status
enum<string>

Filter by payment status

Available options:
completed,
processing,
failed

Response

Success

message
string
Example:

"success"

summary
object