API Methods
Endpoints
Prefix: https://[server]/gateway/[version]/
The current version is 1.2
Error Response
When an error occurs, there will be an errors property with a list of errors applicable to the request:
- errorcode: Green Dot error code.
- errordescription: Descriptive error message.
Example:
{
"errors": [{
"errorcode":1317,
"errordescription":"Missing request id”
}]
}
Get/ping & Get/ping/{id}
Returns the status of the server.
HTTP Status Codes
Response Code | Description |
---|---|
200 | Success |
Field Standards
Field | Type | Format | Required | Values Allowed |
---|---|---|---|---|
firstName | String | Min 2 characters | Yes | a-z, A-Z, hyphen, space |
LastName | String | Min 2 characters | Yes | a-z, A-Z, hyphen, space |
MiddleInitial | String | Min 1 character | Yes | a-z, A-Z |
AddressLine1 | String | Min 0 characters | Yes | a-z, A-Z, 0-9, hyphen, space, /, period The current ver{2,}$ |
AddressLine2 | String | Min 0 characters | No | a-z, A-Z, 0-9, hyphen, space, /, period The current ver{2,}$ |
City | String | Min 0 characters | Yes | a-z, A-Z, hyphen, space |
State | String | Min 0 characters | Yes | any word character |
ZipCode | String | Min 5 characters | Yes | 0-9, hyphen |
SSN | String | Min 11 characters | Yes | 0-9, hyphen |
DateOfBirth | String | Min 10 characters | Yes | 0-9, hyphen, dash, period |
ATMPin | String | Min 4 characters | Yes | 0-9 |
PhoneNumber | String | Min 13 characters | Yes | 0-9, hyphen, space, (,) |
EmailAddress | String | Min 6 characters | Yes | a-Z, A-Z, 0-9, underscore, hyphen, period, ampersand ###+)@or Response {2,}(.n error occu+).(ere will{2,4})$ |
Updated about 24 hours ago