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
"use strict";
export class InitiateCitiBankStatementResponse {
    /** @param {{responseStatus?:ResponseStatus,statementIsStillGenerating?:boolean,statementId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    statementIsStillGenerating;
    /** @type {?string} */
    statementId;
}
export class InitiateCitiBankStatementRequest {
    /** @param {{bankAccountNumber?:string,fromDate?:string,toDate?:string,formatName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bankAccountNumber;
    /** @type {string} */
    fromDate;
    /** @type {string} */
    toDate;
    /** @type {?string} */
    formatName;
}

JavaScript 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
}