| Required role: | Tartarus.Read |
| GET,POST | /api/citi-bank-statement |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatementId | body | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| StatementIsStillGenerating | form | bool | No | |
| Entries | form | List<CitiBankAccountEntry> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EntryType | form | BankEntryType | No | |
| Description | form | string | No | |
| Amount | form | decimal? | No | |
| CurrencyCode | form | string | No | |
| CreditDebitIndicator | form | string | No | |
| EntryDate | form | DateTime? | No |
| Name | Value | |
|---|---|---|
| Balance | 1 | |
| Transaction | 2 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"statementId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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)\/"}]}