Starlite API

CheckImages

The following routes are available for this service:
POST	/CheckImages


// @DataContract
export class ServiceRequestBase implements IHasVersion
{

    public constructor(init?: Partial<ServiceRequestBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ServiceResponseBase
{
    /**
    * Identifies whether the request executed successfully, however does not indicated requested data was found
    */
    // @DataMember
    // @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    public IsSuccessful?: boolean;

    /**
    * The status code returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status code returned by the service")
    public StatusCode?: number;

    /**
    * The status message returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status message returned by the service")
    public StatusMessage?: string;

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public ServiceDebugFields?: { [index: string]: string; };

    public constructor(init?: Partial<ServiceResponseBase>) { (Object as any).assign(this, init); }
}

export enum ImageReturnTypeEnum
{
    GIF = 'GIF',
    PNG = 'PNG',
    JPG = 'JPG',
    TIFF = 'TIFF',
    BMP = 'BMP',
}

export class CheckImages extends ServiceRequestBase
{
    /**
    * The account number for which to find the associated check image
    */
    // @ApiMember(Description="The account number for which to find the associated check image", IsRequired=true, ParameterType="form")
    public AccountNumber: number;

    /**
    * The check number to lookup
    */
    // @ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")
    public CheckNumber: number;

    /**
    * The amount which the check was made out for
    */
    // @ApiMember(Description="The amount which the check was made out for", IsRequired=true, ParameterType="form")
    public CheckAmount: number;

    /**
    * The date which the check posted on. Ensure format is 'mm/dd/yyyy'
    */
    // @ApiMember(Description="The date which the check posted on. Ensure format is 'mm/dd/yyyy'", IsRequired=true, ParameterType="form")
    public PostDate?: string;

    /**
    * The trace number tied to the transaction containing the check
    */
    // @ApiMember(Description="The trace number tied to the transaction containing the check", ParameterType="form")
    public TraceNumber?: number;

    /**
    * Specify the image return type:<br/><b>GIF</b><br/><b>PNG</b><br/><b>JPG</b><br/><b>TIFF</b><br/><b>BMP</b><br/>* (Default is 'GIF')
    */
    // @ApiMember(Description="Specify the image return type:<br/><b>GIF</b><br/><b>PNG</b><br/><b>JPG</b><br/><b>TIFF</b><br/><b>BMP</b><br/>* (Default is 'GIF')")
    public ImageReturnType?: ImageReturnTypeEnum;

    public constructor(init?: Partial<CheckImages>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CheckImages DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: AZW-AABWPW03,
		ApiServiceHostVersion: 2016.1.18.3
	}
}