m8ty-dto - m8ty Data Transfer Objects/eu.m8ty.dtos.ais

Package-level declarations

Types

Link copied to clipboard
data class AccountBalanceDto(var year: Int, var month: Int, var balance: AmountDto, var income: AmountDto, var spending: AmountDto)

Balance of an account

Link copied to clipboard
data class AccountBalanceListDto(var balances: MutableList<AccountBalanceDto>? = null)

List of balances of an account

Link copied to clipboard
data class AccountBaseDataDto(var accountName: String? = null, var accountIBAN: String? = null, var accountNumber: String? = null, var accountDescription: String? = null, var accountType: AccountTypeEnumDto? = null, var accountTypeDescription: String? = null, var customerId: String? = null, var accountHolder: String? = null, var accountStatus: ActiveEnumDto? = null, var accountCurrency: CurrencyDto? = null, var bankId: String? = null, var internalAccount: Boolean? = null, var favoriteAccount: Boolean? = null)

Represents the base data of an account.

Link copied to clipboard
data class AccountDataDto(var customerId: String, var accountStatus: ActiveEnumDto, var bankId: String, var accountId: String, var accountName: String? = null, var accountIBAN: String? = null, var accountNumber: String? = null, var accountDescription: String? = null, var accountType: AccountTypeEnumDto? = null, var accountTypeDescription: String? = null, var accountHolder: String? = null, var accountCurrency: CurrencyDto? = null, var internalAccount: Boolean? = null, var favoriteAccount: Boolean? = null, var balance: AmountDto? = null, var availableAmount: AmountDto? = null, var interestRate: BigDecimal? = null, var bankName: String? = null, var bank: BankDto? = null)

Data of an account. The bank field is returned only for endpoints where the includeBankData flag is supported and set to true.

Link copied to clipboard
data class AccountDataRequestDto(var accountName: String? = null, var accountIBAN: String? = null, var accountNumber: String? = null, var accountDescription: String? = null, var accountType: MutableList<AccountTypeEnumDto>? = null, var accountTypeDescription: String? = null, var customerId: String? = null, var accountHolder: String? = null, var accountStatus: ActiveEnumDto? = null, var accountCurrency: CurrencyDto? = null, var bankId: String? = null, var internalAccount: Boolean? = null, var favoriteAccount: Boolean? = null, var accountIsoCurrency: IsoCurrencyEnumDto? = null)

Request object for account data search

Link copied to clipboard
data class AccountsResponseDto(var accounts: MutableList<AccountDataDto>? = null, var page: PageDto? = null)

Response containing all requested accounts of a user.

Link copied to clipboard
data class AccountTransactionDto(var id: String, var accountId: String, var bookingDate: OffsetDateTime, var amount: AmountDto, var purpose: String, var valueDate: LocalDate? = null, var bookingType: BookingTypeEnumDto? = null, var bookingTextLong: String? = null, var counterpartName: String? = null, var counterpartIBAN: String? = null, var mandateReference: String? = null, var creditorId: String? = null, var categoryId: String? = null, var labels: MutableList<String>? = null, var swiftGpiSettlementDate: OffsetDateTime? = null, var balanceAfterTransaction: AmountDto? = null, var isCollectiveTransaction: Boolean? = null)

Represents a transaction.

Link copied to clipboard
enum AccountTypeEnumDto : Enum<AccountTypeEnumDto>

Describes the account type. The type is defined by the Bank. Possible types are:

  • CURRENT - For Current accounts.
  • SAVINGS - For Savings accounts.
  • OTHER - All other account types.
Values: CURRENT,SAVINGS,OTHER

Link copied to clipboard
data class AliasDto(var alias: String)

Account name or alias object.

Link copied to clipboard
data class AnalyticsCategoriesListResponseDto(var categories: MutableList<AnalyticsCategoryDto>? = null)

List of categories for Analytics

Link copied to clipboard
data class AnalyticsCategoryDto(var id: String, var name: String, var category: String, var color: String? = null, var icon: String? = null, var isCustom: Boolean? = null, var options: String? = null)

Category for Analytics feature

Link copied to clipboard
data class BankCountryListDto(var countryISOCodes: MutableList<String>? = null)

Contains the list of all countries of supported Banks.

Link copied to clipboard
data class BankGroupDto(var id: String? = null, var groupName: String? = null, var numberOfBanks: BigDecimal? = null)

Provides a list of Bank groups.

Link copied to clipboard
data class BankGroupListDto(var bankGroups: MutableList<BankGroupDto>? = null)

Provides a list of Bank groups.

Link copied to clipboard
data class BankListResponseDto(var banks: MutableList<BankDto>? = null, var page: PageDto? = null)

List of Banks.

Link copied to clipboard
enum BookingTypeEnumDto : Enum<BookingTypeEnumDto>

Booking type of a transaction.

  • BOOKED - Transaction was booked by the Bank.
  • PENDING - Transaction is still pending and not booked by the Bank.
Values: BOOKED,PENDING

Link copied to clipboard
data class ImportBankConnectionFinAPIRequestDto(var webFormId: String? = null, var status: WebFormStatusDto? = null)

Request object, which is used by finAPI for the WebForm 2 callback

Link copied to clipboard
data class ImportBankConnectionRequestDto(var bankId: String, var languageCode: String? = null)

Request object for importing a Bank connection.

Link copied to clipboard
data class ImportBankConnectionResponseDto(var status: ImportBankConnectionStatusEnumDto, var bankConnectionId: String, var webFormURL: String? = null)

Response object for importing a Bank connection.

Link copied to clipboard
data class ImportBankConnectionStatusDto(var status: ImportBankConnectionStatusEnumDto)

Response object for the status of the import of a Bank connection.

Link copied to clipboard
enum ImportBankConnectionStatusEnumDto : Enum<ImportBankConnectionStatusEnumDto>

Describes the status of the Bank details import in the zero-error case. Possible states are:

  • WEB_FORM_REQUIRED - A web form is required to be displayed to the user in order for them to log into their bank account.
  • IN_PROGRESS - The web form is in progress.
  • SUCCESSFUL - If the Bank connection can be imported without a web form from the Bank or intermediary provider.
  • ABORTED - If the Web Form was aborted.
  • EXPIRED - If the Web Form has been expired.
  • COMPLETED_WITH_ERROR - If the Web Form has been completed with errors.
Values: WEB_FORM_REQUIRED,IN_PROGRESS,SUCCESSFUL,ABORTED,EXPIRED,COMPLETED_WITH_ERROR

Link copied to clipboard
enum ImportBankConnectionUpdateStatusEnumDto : Enum<ImportBankConnectionUpdateStatusEnumDto>

Current status of the data download (account balances and transactions/securities) of a Bank account. Possible states are:

  • READY - The Bank connection can be used.
  • IN_PROGRESS - The Bank connection is currently being updated.
Values: IN_PROGRESS,READY

Link copied to clipboard
data class ImportedBankConnectionDto(var id: String, var updateStatus: ImportBankConnectionUpdateStatusEnumDto, var bankDetails: BankDto)

Response object for imported Bank connection.

Link copied to clipboard
data class ImportedBankConnectionsResponseDto(var bankConnections: MutableList<ImportedBankConnectionDto>)

Response object for imported Bank connection.

Link copied to clipboard
data class SearchTransactionCriteriaDto(var bookingType: BookingTypeEnumDto? = null, var transactionFlowType: TransactionFlowTypeEnumDto? = TransactionFlowTypeEnumDto.BOTH, var bookingDateFrom: OffsetDateTime? = null, var bookingDateTo: OffsetDateTime? = null, var amountMin: BigDecimal? = null, var amountMax: BigDecimal? = null, var purpose: String? = null, var counterpartName: String? = null, var counterpartIBAN: String? = null, var search: String? = null)

Filters to be applied while searching for transactions.

Link copied to clipboard
data class SearchTransactionRequestDto(var accountIds: MutableList<String>, var bookingType: BookingTypeEnumDto? = null, var transactionFlowType: TransactionFlowTypeEnumDto? = TransactionFlowTypeEnumDto.BOTH, var bookingDateFrom: OffsetDateTime? = null, var bookingDateTo: OffsetDateTime? = null, var amountMin: BigDecimal? = null, var amountMax: BigDecimal? = null, var purpose: String? = null, var counterpartName: String? = null, var counterpartIBAN: String? = null, var search: String? = null)

Search parameter for the transaction list. accountIds is required. If the other fields are empty, all transactions of the specified accounts will be returned.

Link copied to clipboard
data class SearchTransactionResponseDto(var transactions: MutableList<AccountTransactionDto>, var page: PageDto)

Response to a search for transactions.

Link copied to clipboard
enum TransactionFlowTypeEnumDto : Enum<TransactionFlowTypeEnumDto>

This parameter defines the direction of transactions(in - and/or outgoing transactions). If no value defined explicitly, the default BOTH is taken into account. Values: INCOMING,OUTGOING,BOTH