Nephila Tartarus

<back to all web services

GetCitiBankAccountBalanceRequest

Cash
Requires Authentication
Required role:Tartarus.Read
The following routes are available for this service:
GET,POST/api/citi-bank-account-balance
import Foundation
import ServiceStack

public class GetCitiBankAccountBalanceRequest : IGet, IPost, Codable
{
    public var accountNumber:String
    public var currencyCode:String
    public var fromDate:Date
    public var toDate:Date

    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 GetCitiBankAccountBalanceRequest DTOs

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

{
	accountNumber: String,
	currencyCode: String,
	fromDate: 0001-01-01,
	toDate: 0001-01-01
}
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
		}
	]
}