Starlite API

<back to all web services

AccountBalance

The following routes are available for this service:
POST/CoreBanking/AccountBalance

// @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); }
}

// @DataContract
export class AccountBalance extends ServiceRequestBase
{
    /**
    * The account number for which you want to retrieve a current balance for
    */
    // @DataMember
    // @ApiMember(DataType="long", Description="The account number for which you want to retrieve a current balance for", IsRequired=true)
    public AccountNumber: number;

    /**
    * DEPRECATED
    */
    // @DataMember
    // @ApiMember(DataType="int", Description="DEPRECATED")
    public AccountType?: number;

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

TypeScript AccountBalance 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 /CoreBanking/AccountBalance HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AccountNumber: 0,
	AccountType: 0
}
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
	}
}