POST/users/summary/{accountType}

Summary Balance

Returns a summary of balances across all users for a given account type. Supports filtering by user status.

Path variables

Field	Type	Required	Possible values	Description
`accountType`	string	Required	USD	Account type identifier.

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Field	Type	Required	Possible values	Description
`Statuses`	array	Optional	active \| blocked \| disabled \| purged \| removed	Filter users by their account status.

Example request

{
  "Statuses": [
    "active",
    "blocked"
  ]
}

{
  "Statuses": [
    "active",
    "blocked"
  ]
}

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	Aggregated balance summary across all users for the given account type.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Count": 5,
    "Sum": "260998.59",
    "Average": "52199.72"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Count": 5,
    "Sum": "260998.59",
    "Average": "52199.72"
  }
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.