The API Request must be submitted using a name/value pair format.
a) The Name of the field submitted is always first.
b) Value of the field submitted is always second.
c) The Format is the Name followed with an equal sign followed by the Value followed by an ampersand. There must be NO SPACES in front of or following either the equal sign or the ampersand. Only the parameters necessary for each function should be passed. At the very end of the Request, leave off theampersand.
d) The order or sequence of the Name/Value Pairs submitted is not important. The user must ensure however that all name/value pairs that are required to be submitted are included.
Message format example:
Required fields for all Requests:
|CID||Client ID||Y||(1,4) numeric|
|CUSR||Client User ID||Y||(5,12) varchar|
|CPWD||Client Password||Y||(8,20) varchar|
1-5 characters reserved for Client ID left padded with zeros.
6-17 characters reserved for message id counter.
A brief overview of the Request processing follows:
1. The AE CardAPI receives the request.
2. The program will then process the request. Processing includes:
a. Validation of the user information (user account information)
b. Validation of the transaction information – Validates to ensure all required fields are present, allowable based on the User Account, and contains correctly formatted content, and data type. If required fields are not present, an error message is returned, and the Request is declined.
3. When all the information has been processed, the AE CardAPI adds any additional information, as necessary, to the response, and reformats it into the correct format to send back to the user.
4. The AE CardAPI sends the response back to the user.