Nephila Tartarus

<back to all web services

GetCitiBankAccountBalanceRequest

Cash
Requires Authentication
Required role:Tartarus.Read
The following routes are available for this service:
GET,POST/api/citi-bank-account-balance
"use strict";
/** @typedef {number} */
export var BankEntryType;
(function (BankEntryType) {
    BankEntryType[BankEntryType["Balance"] = 1] = "Balance"
    BankEntryType[BankEntryType["Transaction"] = 2] = "Transaction"
})(BankEntryType || (BankEntryType = {}));
export class CitiBankAccountEntry {
    /** @param {{entryType?:BankEntryType,description?:string,amount?:number,currencyCode?:string,creditDebitIndicator?:string,entryDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BankEntryType} */
    entryType;
    /** @type {?string} */
    description;
    /** @type {?number} */
    amount;
    /** @type {?string} */
    currencyCode;
    /** @type {?string} */
    creditDebitIndicator;
    /** @type {?string} */
    entryDate;
}
export class CitiBankEntriesResponse {
    /** @param {{responseStatus?:ResponseStatus,statementIsStillGenerating?:boolean,entries?:CitiBankAccountEntry[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    statementIsStillGenerating;
    /** @type {CitiBankAccountEntry[]} */
    entries = [];
}
export class GetCitiBankAccountBalanceRequest {
    /** @param {{accountNumber?:string,currencyCode?:string,fromDate?:string,toDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    accountNumber;
    /** @type {string} */
    currencyCode;
    /** @type {string} */
    fromDate;
    /** @type {string} */
    toDate;
}

JavaScript GetCitiBankAccountBalanceRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/citi-bank-account-balance HTTP/1.1 
Host: tartarus.nephila.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"accountNumber":"String","currencyCode":"String","fromDate":"\/Date(-62135596800000-0000)\/","toDate":"\/Date(-62135596800000-0000)\/"}
HTTP/1.1 200 OK
Content-Type: application/json
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)\/"}]}