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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RetrieveCitiBankStatementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel">
  <StatementId>String</StatementId>
</RetrieveCitiBankStatementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CitiBankEntriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel">
  <Entries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel.Types">
    <d2p1:CitiBankAccountEntry>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:CreditDebitIndicator>String</d2p1:CreditDebitIndicator>
      <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EntryDate>0001-01-01T00:00:00</d2p1:EntryDate>
      <d2p1:EntryType>Balance</d2p1:EntryType>
    </d2p1:CitiBankAccountEntry>
  </Entries>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StatementIsStillGenerating>false</StatementIsStillGenerating>
</CitiBankEntriesResponse>