| POST | /CheckImages |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | form | long | Yes | The account number for which to find the associated check image |
| CheckNumber | form | int | Yes | The check number to lookup |
| CheckAmount | form | decimal | Yes | The amount which the check was made out for |
| PostDate | form | DateTime | Yes | The date which the check posted on. Ensure format is 'mm/dd/yyyy' |
| TraceNumber | form | long? | No | The trace number tied to the transaction containing the check |
| ImageReturnType | body | ImageReturnTypeEnum? | No | Specify the image return type: GIF PNG JPG TIFF BMP * (Default is 'GIF') |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsSuccessful | form | bool | No | Identifies whether the request executed successfully, however does not indicated requested data was found |
| StatusCode | form | int | No | The status code returned by the service |
| StatusMessage | form | string | No | The status message returned by the service |
| ServiceDebugFields | form | Dictionary<string, string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /CheckImages HTTP/1.1
Host: services.allianceassociationbank.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AccountNumber: 0,
CheckNumber: 0,
CheckAmount: 0,
PostDate: 0001-01-01,
TraceNumber: 0,
ImageReturnType: GIF
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IsSuccessful: False,
StatusCode: 0,
StatusMessage: String,
ServiceDebugFields:
{
ApiServiceHost: WAB-WEBPW02,
ApiServiceHostVersion: 1.0.0.0
}
}