| Required role: | Tartarus.Read |
| GET,POST | /api/citi-bank-account-balance |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class BankEntryType(IntEnum):
BALANCE = 1
TRANSACTION = 2
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CitiBankAccountEntry:
entry_type: Optional[BankEntryType] = None
description: Optional[str] = None
amount: Optional[Decimal] = None
currency_code: Optional[str] = None
credit_debit_indicator: Optional[str] = None
entry_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CitiBankEntriesResponse:
response_status: Optional[ResponseStatus] = None
statement_is_still_generating: bool = False
entries: List[CitiBankAccountEntry] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCitiBankAccountBalanceRequest(IGet, IPost):
account_number: Optional[str] = None
currency_code: Optional[str] = None
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
Python GetCitiBankAccountBalanceRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<GetCitiBankAccountBalanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel">
<AccountNumber>String</AccountNumber>
<CurrencyCode>String</CurrencyCode>
<FromDate>0001-01-01T00:00:00</FromDate>
<ToDate>0001-01-01T00:00:00</ToDate>
</GetCitiBankAccountBalanceRequest>
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>