Get Payment Summary
Payments
Get Payment Summary
Get Payment Summary
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:
useror higher
| Field | Type | Description |
|---|---|---|
| total | integer | Total number of payments |
| byStatus | object | Count of payments grouped by status (completed, processing, failed) |
| byCurrency | object | Count of payments grouped by currency |
| totalAmounts | object | Total amounts (amountUSD and amount) |
| Parameter | Type | Description |
|---|---|---|
| startDate (Optional) | string | Filter payments from this date (inclusive) |
| endDate (Optional) | string | Filter payments to this date (inclusive) |
| currency (Optional) | string | Filter by currency code |
| status (Optional) | string | Filter by payment status |
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Filter payments from this date (inclusive)
Filter payments to this date (inclusive)
Filter by currency code (e.g., USD, EUR)
Filter by payment status
Available options:
completed, processing, failed