Developer API

Overview

Account API

Transfer API

Common Commands and Codes

This section of the document describes commands and codes that are common to all requests in the Account API.

Endpoint

Prefix: https://[server]/gateway/[version]/

Checking Server Readiness

Use GET /ping to check server status prior to sending a request. A return status of 100 indicates readiness to receive requests; any other code indicates the server is not ready.

Status code Description
200 Success

Error Response

When a request results in an error, the response includes an Errors property with a list of errors specific to the type of request: Error codes are:

Error Sample

{

 “Errors”: [{

  “ErrorCode”: “1050”,

  “ErrorDescription”: “Invalid FirstName”

 }]

}

HTTP Headers and Responses

The following headers are required for each type of request in the Account API.

Authorization Header

Authorization: Basic Access Authentication as defined by RFC 1945 11.1 with credentials supplied by Green Dot. All operations will return an HTTP 401 if the Authorization value is not properly populated.

Standard Request Headers

Accept: What the response should be formatted with. We currently support:

Content-Type: What the request was encoded with. Currently we support:

Custom Request Headers

Response Headers

Each Account API request will return these Response Headers.

HTTP Status Codes for Headers

Status Code Description
200 Successful Request. See specific operation to see further details for this response.
201 Resource was able to be created. See specific operation for further details for this response.
400 Malformed request; missing fields, incorrect data, or malformed input structure. If a specific custom header is malformed, an additional Error code will be sent depending on header.

  • Malformed RequestID : additional Error code 1010
  • Malformed EndUserSecurityID : additional Error code 1020
  • Malformed EndUserIP : additional Error code 1030
401 Unauthorized. Please provide valid credentials in the Authorizationheader.
404 Unable to find resource. Unable to find resource specified by the url parameter identifier. RequestID already in use; RequestID must be unique per request.
409 Unable to proceed because resource already exists in our system and is not in a valid state. See specific operation to see details for this response..
500 Internal Server Error
501 Not implemented. Will be implemented at a future date.
502 Bad Gateway. The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.
503 Service Unavailable. The server is currently unable to handle the request due to a temporary overload or server maintenance..
504 Gateway Timeout. The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) that it attempted to access in processing the request.