Nephila Tartarus

RetrieveCitiBankStatementRequest

Cash

**Requires Authentication**
Required role:	Tartarus.Read

The following routes are available for this service:
GET,POST	/api/citi-bank-statement

**RetrieveCitiBankStatementRequest** Parameters:
Name	Parameter	Data Type	Required	Description
StatementId	body	string	Yes

**CitiBankEntriesResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
StatementIsStillGenerating	form	bool	No
Entries	form	List<CitiBankAccountEntry>	Yes

**CitiBankAccountEntry** Parameters:
Name	Parameter	Data Type	Required
EntryType	form	BankEntryType	No
Description	form	string	No
Amount	form	decimal?	No
CurrencyCode	form	string	No
CreditDebitIndicator	form	string	No
EntryDate	form	DateTime?	No

**BankEntryType** Enum:
Name	Value
Balance	1
Transaction	2

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

{
	statementId: 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,
	entries: 
	[
		{
			entryType: Balance,
			description: String,
			amount: 0,
			currencyCode: String,
			creditDebitIndicator: String,
			entryDate: 0001-01-01
		}
	]
}