System Endpoints

Ping

Verifies connectivity with the Green Dot Retail API. Use this endpoint for integration health checks and liveness probes.

Note: Ping does not require metadata headers. However, each request must include a unique X-GD-RequestId header value.

Syntax:

GET {baseUrl}/system/ping

Request

Headers:

GET {baseUrl}/system/ping
Authorization: Bearer {access_token}
X-GD-RequestId: req-20260115-ping01

Request Parameters

Parameter	Required	Type	Max Length	Description
`X-GD-RequestId`	Yes	String	50	Unique request ID generated by the retailer. Must be unique per request.

Response

Successful Response

Headers:

HTTP/1.1 200 OK
X-GD-ResponseId: a0b1c2d3-e4f5-6789-abcd-ef0123456789

Body:

{
  "requestId": "req-20260115-ping01",
  "responseId": "a0b1c2d3-e4f5-6789-abcd-ef0123456789",
  "responseCode": 0,
  "responseDescription": "Success",
  "responseDateTime": "2026-01-15T12:00:07.1411753Z"
}

Error Response Example

Headers:

HTTP/1.1 400 Bad Request
X-GD-ResponseId: c2d3e4f5-a6b7-1890-efab-cd9876543210

Body:

{
  "requestId": "",
  "responseId": "c2d3e4f5-a6b7-1890-efab-cd9876543210",
  "responseCode": 100,
  "responseDescription": "RequestId is required",
  "responseDateTime": "2026-01-15T12:00:07.7790449Z"
}

Response Parameters

Parameter	Required	Type	Pattern	Description
`requestId`	Yes	String	Max: 50	Echo of the `X-GD-RequestId` value from the request header.
`responseId`	Yes	String	UUID	Unique response identifier generated by Green Dot.
`responseCode`	Yes	Numeric	0–1000	Indicates success or failure. `0` = Success. See Response Codes.
`responseDescription`	Yes	String	Max: 255	Human-readable description of the response code.
`responseDateTime`	Yes	DateTime	YYYY-MM-DDTHH:mm:ss.fffffffZ	UTC timestamp of the response.

Response Codes

Code	Code Text	Response Description	Explanation
0	Success	Success	Ping successful. The API is reachable.
100	InvalidParameter	(See description)	`X-GD-RequestId` is missing or invalid.
999	RequestTimeout	Request Timeout	Request expired or no downstream response received.
1000	GeneralFailure	General Failure	An unspecified service failure occurred.