Nephila Tartarus

RetrieveCitiBankStatementRequest

Cash

**Requires Authentication**
Required role:	Tartarus.Read

The following routes are available for this service:
GET,POST	/api/citi-bank-statement

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class RetrieveCitiBankStatementRequest : IGet, IPost
{
    open var statementId:String? = null
}

open class CitiBankEntriesResponse
{
    open var responseStatus:ResponseStatus? = null
    open var statementIsStillGenerating:Boolean? = null
    open var entries:ArrayList<CitiBankAccountEntry> = ArrayList<CitiBankAccountEntry>()
}

open class CitiBankAccountEntry
{
    open var entryType:BankEntryType? = null
    open var description:String? = null
    open var amount:BigDecimal? = null
    open var currencyCode:String? = null
    open var creditDebitIndicator:String? = null
    open var entryDate:Date? = null
}

enum class BankEntryType(val value:Int)
{
    Balance(1),
    Transaction(2),
}

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

{
	statementId: String
}

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
		}
	]
}