GET/users/balances/{accountType}

Assigned User Balances

Returns balances for all users assigned to the GMA partner for a given account type. Supports pagination and sorting by balance.

Path variables

Field	Type	Required	Possible values	Description
`accountType`	string	Required	USD	Account type identifier (e.g. USD).

Query parameters

Field	Type	Required	Possible values	Description
`pageNumber`	integer	Optional	—	Page number (enter 1 for the first page, 2 for the second, etc.).
`pageSize`	integer	Optional	10 \| 20 \| 40 \| 100	Number of records to return per page.
`orderBy`	string	Optional	balanceAsc \| balanceDesc \| alphabeticallyAsc \| alphabeticallyDesc	Sort order for balance results.

Headers

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

Response

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	Paginated list of user balances for the specified account type.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CurrentPage": 1,
    "PageSize": 40,
    "TotalCount": 5,
    "Data": [
      {
        "Name": "Two Seven Two Three Zero",
        "UserName": "user27230",
        "Email": "user27230@example.com",
        "AccountNumber": "****9274",
        "Balance": "0.00"
      },
      {
        "Name": "Two Seven Three Two Three",
        "UserName": "user27323",
        "Email": "user27323@example.com",
        "AccountNumber": "****2885",
        "Balance": "998.75"
      },
      {
        "Name": "Six Four Seven",
        "UserName": "user647",
        "AccountNumber": "****2280",
        "Balance": "3645.00"
      },
      {
        "Name": "John Doe",
        "UserName": "john.doe",
        "AccountNumber": "****2890",
        "Balance": "3689.84"
      },
      {
        "Name": "Two Six Four Eight Five",
        "UserName": "user26485",
        "Email": "user26485@example.com",
        "AccountNumber": "****1477",
        "Balance": "252665.00"
      }
    ]
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CurrentPage": 1,
    "PageSize": 40,
    "TotalCount": 5,
    "Data": [
      {
        "Name": "Two Seven Two Three Zero",
        "UserName": "user27230",
        "Email": "user27230@example.com",
        "AccountNumber": "****9274",
        "Balance": "0.00"
      },
      {
        "Name": "Two Seven Three Two Three",
        "UserName": "user27323",
        "Email": "user27323@example.com",
        "AccountNumber": "****2885",
        "Balance": "998.75"
      },
      {
        "Name": "Six Four Seven",
        "UserName": "user647",
        "AccountNumber": "****2280",
        "Balance": "3645.00"
      },
      {
        "Name": "John Doe",
        "UserName": "john.doe",
        "AccountNumber": "****2890",
        "Balance": "3689.84"
      },
      {
        "Name": "Two Six Four Eight Five",
        "UserName": "user26485",
        "Email": "user26485@example.com",
        "AccountNumber": "****1477",
        "Balance": "252665.00"
      }
    ]
  }
}

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