Overview
This service presents a check for validation against a sequence of check validation engines, including but not limited to ABA verification, bad check authorization, etc. The actual sequence of validations performed is configured when the client is initially boarded. To simply present a check to a check authorization company, use the AuthorizeCheck service.
Security
The user must have either the Gateway.AuthorizeCheck role.
SOAP Service
Request
<ValidateCheck xmlns="https://gateway.acheck21.com/GlobalGateway/"> <Username>string</Username> <Password>string</Password> <ClientID>string</ClientID> <MICR>string</MICR> <TransitNumber>string</TransitNumber> <DDANumber>string</DDANumber> <CheckNumber>string</CheckNumber> <CheckAmount>decimal</CheckAmount> <DLNumber>decimal</DLNumber> <PhoneNumber>string</PhoneNumber> </ValidateCheck>
Response
<ValidateCheckResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<ValidateCheckResult> <Code>int</Code> <Message>string</Message> <Validation> <Response>Authorized OR Declined OR Warning OR Error</Response> <AuthorizationCode>string</AuthorizationCode> <DetailLines> <string>line</string> … <string>line</string> </DetailLines> </Validation> </ValidateCheckResult>
</ValidateCheckResponse>
REST Service
| URL | https://gateway.acheck21.com/GlobalGateway/REST/check/validate |
| VERB | POST |
| Form Contents | The form must contain elements corresponding to the ClientID, MICR, TransitNumber, DDANumber, CheckNumber, CheckAmount, and DLNumber elements in the XML. These form elements must have the same names as in the XML. |
| Response | The return value is the Validation portion of the SOAP response |
Possible values for <Code>
| Code | HTTP Status Code | Description |
| 0 | 204 | No error |
| 10000 | 401 | Not authorized |
Notes
The request should contain either the MICR or the separate components (TransitNumber, DDANumber, CheckNumber) from the check. If both are provided, the software will use the MICR value. The MICR must be expressed using the TOAD encoding, where the transit symbol is encoded as a ‘T’, the on-us as an ‘O’, the amount symbol as an ‘A’, and the dash as a ‘D’. Note that the characters must be upper-case, using lower case letters will result in a parameter error.
The DLNumber is optional. If provided, it must contain the 2 character state abbreviation followed by a hyphen, then the actual license number; for example:
AZ-D123456
means Arizona drivers license number D123456. Failure to conform to this format will result in an error from the check verification system.
The authorization code, if successful, will be stored on the ACHeck21 Global Gateway, where it can be retrieved if and when the actual check is uploaded.
Comments