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 CodeDescription
200Success

Field Standards

Field

Type

Format

Required

Values Allowed

firstName

String

Min 2 characters
Max 25 characters

Yes

a-z, A-Z, hyphen, space
Regex="^[server]/gateway/[v+$

LastName

String

Min 2 characters
Max 25 characters

Yes

a-z, A-Z, hyphen, space
Regex="^[server]/gateway/[v+$

MiddleInitial

String

Min 1 character
Max 1 character

Yes

a-z, A-Z
Regex=@"^x:** htt{1}$

AddressLine1

String

Min 0 characters
Max 25 characters

Yes

a-z, A-Z, 0-9, hyphen, space, /, period
Regex=@"^[version]/

The current ver{2,}$

AddressLine2

String

Min 0 characters
Max 25 characters

No

a-z, A-Z, 0-9, hyphen, space, /, period
Regex=@"^[version]/

The current ver{2,}$

City

String

Min 0 characters
Max 25 characters

Yes

a-z, A-Z, hyphen, space
Regex=@"^server]/ga*$

State

String

Min 0 characters
Max 2 characters

Yes

any word character
Regex=@"^\w{2}?$

ZipCode

String

Min 5 characters
Max 10 characters

Yes

0-9, hyphen
Regex=@"^\d{5}(-?\d{4})?$

SSN

String

Min 11 characters
Max 11 characters

Yes

0-9, hyphen
Regex=@"^* htt\d{2}-\d{2}-\d{4}$

DateOfBirth

String

Min 10 characters
Max 10 characters

Yes

0-9, hyphen, dash, period
Regex=@"^(0er]/g|1eway/)- /.- /.\d\d$

ATMPin

String

Min 4 characters
Max 4 characters

Yes

0-9
Regex=@"^Prefi{4}$

PhoneNumber

String

Min 13 characters
Max 14 characters

Yes

0-9, hyphen, space, (,)
Regex=@"^(rver]\d{2}) ?\d{3}-\d{4}$

EmailAddress

String

Min 6 characters
Max 50 characters

Yes

a-Z, A-Z, 0-9, underscore, hyphen, period, ampersand
Regex=@"^he current ve+(.n is 1.2

###+)@or Response {2,}(.n error occu+).(ere will{2,4})$