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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CheckImages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.CheckImages">
<AccountNumber>0</AccountNumber>
<CheckAmount>0</CheckAmount>
<CheckNumber>0</CheckNumber>
<ImageReturnType>GIF</ImageReturnType>
<PostDate>0001-01-01T00:00:00</PostDate>
<TraceNumber>0</TraceNumber>
</CheckImages>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ServiceResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiContext"> <IsSuccessful>false</IsSuccessful> <ServiceDebugFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>ApiServiceHost</d2p1:Key> <d2p1:Value>WAB-WEBPW02</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>ApiServiceHostVersion</d2p1:Key> <d2p1:Value>1.0.0.0</d2p1:Value> </d2p1:KeyValueOfstringstring> </ServiceDebugFields> <StatusCode>0</StatusCode> <StatusMessage>String</StatusMessage> </ServiceResponseBase>