Nephila Tartarus

<back to all web services

RetrieveCitiBankStatementRequest

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

export enum BankEntryType
{
    Balance = 1,
    Transaction = 2,
}

export class CitiBankAccountEntry
{
    public entryType: BankEntryType;
    public description?: string;
    public amount?: number;
    public currencyCode?: string;
    public creditDebitIndicator?: string;
    public entryDate?: string;

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

export class CitiBankEntriesResponse
{
    public responseStatus?: ResponseStatus;
    public statementIsStillGenerating: boolean;
    public entries: CitiBankAccountEntry[] = [];

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

export class RetrieveCitiBankStatementRequest implements IGet, IPost
{
    public statementId: string;

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

TypeScript RetrieveCitiBankStatementRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/citi-bank-statement HTTP/1.1 
Host: tartarus.nephila.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"statementId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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,"entries":[{"entryType":"Balance","description":"String","amount":0,"currencyCode":"String","creditDebitIndicator":"String","entryDate":"\/Date(-62135596800000-0000)\/"}]}