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
RetrieveCitiBankStatementRequest Parameters:
NameParameterData TypeRequiredDescription
StatementIdbodystringYes
CitiBankEntriesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
StatementIsStillGeneratingformboolNo
EntriesformList<CitiBankAccountEntry>Yes
CitiBankAccountEntry Parameters:
NameParameterData TypeRequiredDescription
EntryTypeformBankEntryTypeNo
DescriptionformstringNo
Amountformdecimal?No
CurrencyCodeformstringNo
CreditDebitIndicatorformstringNo
EntryDateformDateTime?No
BankEntryType Enum:
NameValue
Balance1
Transaction2

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)\/"}]}