Account Protocol Reference


                    
                    
                    customer

Customer

Declaration

Swift

var customer: Customer { get }

Show on GitHub


                    
                    
                    accountId

Internal ID

Declaration

Swift

var accountId: String { get }

Show on GitHub


                    
                    
                    accountType

Account type, e.g. Personal

Declaration

Swift

var accountType: String { get }

Show on GitHub


                    
                    
                    paymentStatus

Payment status, e.g. Paid

Declaration

Swift

var paymentStatus: String { get }

Show on GitHub


                    
                    
                    productName

Product Name, e.g. World Elite

Declaration

Swift

var productName: String { get }

Show on GitHub


                    
                    
                    productExternalCode

Code for product

Declaration

Swift

var productExternalCode: String { get }

Show on GitHub


                    
                    
                    accountCurrency

ISO symbol of account currency

Declaration

Swift

var accountCurrency: String { get }

Show on GitHub


                    
                    
                    brandId

Brand name, e.g. ROGERSBRAND

Declaration

Swift

var brandId: String { get }

Show on GitHub


                    
                    
                    openedDate

Date the Account was opend

Declaration

Swift

var openedDate: Date { get }

Show on GitHub


                    
                    
                    previousStatementDate

Date of the last statement

Declaration

Swift

var previousStatementDate: Date { get }

Show on GitHub


                    
                    
                    paymentDueDate

Date the payment of the current statement is due (might be in the past)

Declaration

Swift

var paymentDueDate: Date { get }

Show on GitHub


                    
                    
                    lastPaymentDate

Date of the last payment

Declaration

Swift

var lastPaymentDate: Date { get }

Show on GitHub


                    
                    
                    cycleDates

List of past statement dates

Declaration

Swift

var cycleDates: [Date] { get }

Show on GitHub


                    
                    
                    currentBalance

Current balance

Declaration

Swift

var currentBalance: Amount { get }

Show on GitHub


                    
                    
                    statementBalance

Balance on the last Statement

Declaration

Swift

var statementBalance: Amount { get }

Show on GitHub


                    
                    
                    statementDueAmount

Amount which is still due for the statement

Declaration

Swift

var statementDueAmount: Amount { get }

Show on GitHub


                    
                    
                    creditLimit

Credit limit

Declaration

Swift

var creditLimit: Amount { get }

Show on GitHub


                    
                    
                    purchasesSinceLastCycle

Amount charged since the last statement

Declaration

Swift

var purchasesSinceLastCycle: Amount? { get }

Show on GitHub


                    
                    
                    lastPayment

Amount of the last payment

Declaration

Swift

var lastPayment: Amount { get }

Show on GitHub


                    
                    
                    realtimeBalance

Remaining credit limit

Declaration

Swift

var realtimeBalance: Amount { get }

Show on GitHub


                    
                    
                    cashAvailable

Cash Advance available

Declaration

Swift

var cashAvailable: Amount { get }

Show on GitHub


                    
                    
                    cashLimit

Cash Advance limit

Declaration

Swift

var cashLimit: Amount { get }

Show on GitHub


                    
                    
                    multiCard

Multi Card

Declaration

Swift

var multiCard: Bool { get }

Show on GitHub


                    
                    
                    downloadStatement(statement:completion:)

Download a statement

Declaration

Swift

func downloadStatement(statement: Statement, completion: @escaping (Result<URL, DownloadError>) -> Void)

Parameters

`statement`	the statement to download
`completion`	completion handler, called with either a temporary URL to the downloaded file or a DownloadError

Show on GitHub


                    
                    
                    searchStatements(completion:)

Search Statements

Declaration

Swift

func searchStatements(completion: @escaping (Result<[Statement], DownloadError>) -> Void)

Parameters


                                completion

completion handler, called with either the Statements or a DownloadError

Show on GitHub


                    
                    
                    downloadActivities(statementNumber:completion:)

Downloads the transactions

Declaration

Swift

func downloadActivities(statementNumber: Int, completion: @escaping (Result<[Activity], DownloadError>) -> Void)

Parameters

`statementNumber`	number of the statement for which the transactions should be downloaded, with 0 mean current period, 1 means last statement, …
`completion`	completion handler, called with either the Transactions or a DownloadError

Show on GitHub