POST/users/{userId}/accounts/{accountType}/balance

User Balance (Single Account)

Returns the balance for a specific user account.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique user ID.
`accountType`	string	Required	USD	Account type identifier.

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	Balance details for the specified user account.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Currency": "USD",
    "Type": "Account (USD)",
    "AccountNumber": "****2890",
    "Status": {
      "Balance": "3689.84",
      "ReservedAmount": "429.92",
      "AvailableBalance": "3259.92"
    }
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Currency": "USD",
    "Type": "Account (USD)",
    "AccountNumber": "****2890",
    "Status": {
      "Balance": "3689.84",
      "ReservedAmount": "429.92",
      "AvailableBalance": "3259.92"
    }
  }
}

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