Nephila Tartarus

<back to all web services

InitiateCitiBankStatementRequest

Cash
Requires Authentication
Required role:Tartarus.Read
The following routes are available for this service:
GET,POST/api/initiate-citi-bank-statement

export class InitiateCitiBankStatementResponse
{
    public responseStatus?: ResponseStatus;
    public statementIsStillGenerating: boolean;
    public statementId?: string;

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

export class InitiateCitiBankStatementRequest implements IGet, IPost
{
    public bankAccountNumber: string;
    public fromDate: string;
    public toDate: string;
    public formatName?: string;

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

TypeScript InitiateCitiBankStatementRequest 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 /api/initiate-citi-bank-statement HTTP/1.1 
Host: tartarus.nephila.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	bankAccountNumber: String,
	fromDate: 0001-01-01,
	toDate: 0001-01-01,
	formatName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	statementIsStillGenerating: False,
	statementId: String
}