Healthcheck APIs

Obtain Service Health Status

This Healthcheck API reports the availability of the downstream service.

Endpoint: GET /healthCheck

Response Message

If the GET request is successful, the following response message is returned along with a 200 HTTP status code.

OK

Sample Response

{
     "healthCheck": {
          "serviceName": "string",
          "status": "string",
          "totalTime": "string",
          "waitTime": {
               "additionalProp1": "string",
               "additionalProp2": "string",
               "additionalProp3": "string"
          },
          "dependencies": [
               "string"
          ]
     },
     "responseDetails": [
          {
               "code": 0,
               "subCode": 0,
               "description": "string",
               "url": "string"
          }
     ]
}

Test Server Availability

This Healthcheck API determines if Green Dot servers are reachable.

Endpoint: GET /ping

Request Parameters

• X-GD-RequestId (String, Header) - Required. Contains a request identifier in UUID format.

Response Message

If the GET request is successful, the following response message is returned along with a 200 HTTP status code.

OK