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
import Foundation
import ServiceStack

public class RetrieveCitiBankStatementRequest : IGet, IPost, Codable
{
    public var statementId:String

    required public init(){}
}

public class CitiBankEntriesResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var statementIsStillGenerating:Bool
    public var entries:[CitiBankAccountEntry] = []

    required public init(){}
}

public class CitiBankAccountEntry : Codable
{
    public var entryType:BankEntryType
    public var Description:String
    public var amount:Double?
    public var currencyCode:String
    public var creditDebitIndicator:String
    public var entryDate:Date?

    required public init(){}
}

public enum BankEntryType : Int, Codable
{
    case Balance = 1
    case Transaction = 2
}


Swift RetrieveCitiBankStatementRequest DTOs

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

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