Package com.fintecsystems.xs2a.java.models

Types

AccessToken

data class AccessToken(@Json(name = id) id: String, @Json(name = token) token: String, @Json(name = valid_until) validUntil: LocalDateTime?, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

AccessTokenList

data class AccessTokenList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = next_page_url) nextPageUrl: String?, @Json(name = prev_page_url) prevPageUrl: String?, @Json(name = from) from: Int?, @Json(name = to) to: Int?, @Json(name = data) data: List<AccessToken>)

AccountHoldersObject

data class AccountHoldersObject(@Json(name = type) type: String, @Json(name = holder) holder: String, @Json(name = iban) iban: String, @Json(name = matches) matches: List<MatchesObject>)

AccountProfileObject

data class AccountProfileObject(@Json(name = cash_withdrawals) cashWithdrawals: Int, @Json(name = cash_deposits) cashDeposits: Int, @Json(name = payment_gez) paymentGez: String, @Json(name = payment_schufa) paymentSchufa: String, @Json(name = payment_donation) paymentDonation: String, @Json(name = payment_party) paymentParty: String, @Json(name = payment_club) paymentClub: String)

AccountSnapshotFormat

enum AccountSnapshotFormat : Enum<AccountSnapshotFormat>

AccountStatement

data class AccountStatement(@Json(name = account) account: AccountStatementAccount, @Json(name = balance) balance: AccountStatementBalance, @Json(name = turnovers) turnovers: AccountStatementTurnovers)

AccountStatementAccount

data class AccountStatementAccount(@Json(name = holder) holder: String, @Json(name = description) description: String, @Json(name = iban) iban: String, @Json(name = bic) bic: String?, @Json(name = country_id) countryId: CountryId?, @Json(name = joint_account) jointAccount: Boolean)

AccountStatementBalance

data class AccountStatementBalance(@Json(name = available) available: Float, @Json(name = limit) limit: Float, @Json(name = balance) balance: Float, @Json(name = currency) currency: CurrencyId?, @Json(name = date) date: LocalDateTime)

AccountStatementTurnovers

data class AccountStatementTurnovers(@Json(name = turnovers) turnovers: List<Turnover>, @Json(name = date) date: LocalDateTime, @Json(name = days) days: Int?, @Json(name = filters) filters: List<String>)

array of turnovers

AccountType

enum AccountType : Enum<AccountType>

AuthenticationError

data class AuthenticationError(@Json(name = code) code: Int, @Json(name = message) message: String)

BankAccount

data class BankAccount(@Json(name = id) id: String, @Json(name = bank_connection_id) bankConnectionId: String, @Json(name = holder) holder: String, @Json(name = iban) iban: String, @Json(name = description) description: String, @Json(name = bic) bic: String?, @Json(name = account_number) accountNumber: String?, @Json(name = bank_code) bankCode: String, @Json(name = bank_name) bankName: String, @Json(name = country_id) countryId: CountryId?, @Json(name = type) type: AccountType, @Json(name = joint_account) jointAccount: Boolean, @Json(name = transaction_possible) transactionPossible: Boolean, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

BankAccountBalance

data class BankAccountBalance(@Json(name = id) id: String, @Json(name = available) available: Float, @Json(name = limit) limit: Float, @Json(name = balance) balance: Float, @Json(name = currency_id) currencyId: CurrencyId?, @Json(name = date) date: LocalDateTime, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

BankAccountObject

data class BankAccountObject(@Json(name = holder) holder: String, @Json(name = description) description: String, @Json(name = iban) iban: String, @Json(name = bic) bic: String?, @Json(name = country_id) countryId: CountryId?)

BankAccountsList

data class BankAccountsList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = next_page_url) nextPageUrl: String?, @Json(name = prev_page_url) prevPageUrl: String?, @Json(name = from) from: Int?, @Json(name = to) to: Int?, @Json(name = data) data: List<BankAccount>)

BankAccountTurnovers

data class BankAccountTurnovers(@Json(name = id) id: String, @Json(name = turnovers) turnovers: List<Turnover>, @Json(name = days) days: Int?, @Json(name = date) date: LocalDateTime, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

BankConnection

data class BankConnection(@Json(name = id) id: String, @Json(name = transaction) transaction: String, @Json(name = bic) bic: String?, @Json(name = bank_name) bankName: String, @Json(name = country_id) countryId: CountryId?, @Json(name = sync_mode) syncMode: BankConnection.SyncMode?, @Json(name = sync_active) syncActive: Boolean, @Json(name = sync_message) syncMessage: String, @Json(name = sync_fail_counter) syncFailCounter: Int, @Json(name = last_synced) lastSynced: LocalDateTime, @Json(name = consent_valid_until) consentValidUntil: LocalDate?, @Json(name = testmode) testmode: Boolean, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

BankConnectionList

data class BankConnectionList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = next_page_url) nextPageUrl: String?, @Json(name = prev_page_url) prevPageUrl: String?, @Json(name = from) from: Int?, @Json(name = to) to: Int?, @Json(name = data) data: List<BankConnection>)

BankConnectionRequest

data class BankConnectionRequest(@Json(name = sync_mode) syncMode: BankConnection.SyncMode?, @Json(name = bic) bic: String?, @Json(name = country_id) countryId: CountryId?, @Json(name = days) days: Int?, @Json(name = limit_days) limitDays: Int?, @Json(name = account_selection) accountSelection: BankConnection.AccountSelection?, @Json(name = language) language: BankConnection.Language?, @Json(name = fints_product_id) fintsProductId: String?)

BankConnectionSyncRequest

data class BankConnectionSyncRequest(@Json(name = credentials) credentials: String, @Json(name = force) force: Boolean)

BankObject

data class BankObject(@Json(name = bank_code) bankCode: String, @Json(name = bic) bic: String?, @Json(name = name) name: String, @Json(name = short_name) shortName: String, @Json(name = zipcode) zipcode: String?, @Json(name = city) city: String, @Json(name = country_id) countryId: CountryId?, @Json(name = testmode) testmode: Boolean, @Json(name = xs2a_products) xs2aProducts: List<String>, @Json(name = xs2a_supported) xs2aSupported: Boolean)

BankObjectList

data class BankObjectList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = from) from: Int, @Json(name = to) to: Int, @Json(name = data) data: List<BankObject>)

BankUser

data class BankUser(@Json(name = id) id: String, @Json(name = name) name: String, @Json(name = email) email: String, @Json(name = testmode) testmode: Boolean, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

BankUserCreationRequest

data class BankUserCreationRequest(@Json(name = name) name: String, @Json(name = email) email: String)

BankUserList

data class BankUserList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = next_page_url) nextPageUrl: String?, @Json(name = prev_page_url) prevPageUrl: String?, @Json(name = from) from: Int?, @Json(name = to) to: Int?, @Json(name = data) data: List<BankUser>)

BlacklistAdd

data class BlacklistAdd(@Json(name = data) data: String)

BlacklistObject

data class BlacklistObject(@Json(name = id) id: String, @Json(name = type) type: String, @Json(name = data) data: String)

BuriedSessionObject

data class BuriedSessionObject(@Json(name = code) code: Int, @Json(name = message) message: String)

ChargebacksObject

data class ChargebacksObject(@Json(name = chargebacks_coverage_count) chargebacksCoverageCount: Int, @Json(name = chargebacks_coverage_amount) chargebacksCoverageAmount: Float, @Json(name = chargebacks_revoke_count) chargebacksRevokeCount: Int, @Json(name = chargebacks_revoke_amount) chargebacksRevokeAmount: Float)

ChecksResult

data class ChecksResult(@Json(name = amount) amount: Float, @Json(name = currency) currency: CurrencyId?)

CountryId

enum CountryId : Enum<CountryId>

CreditCardsObject

data class CreditCardsObject(@Json(name = holder) holder: String, @Json(name = iban) iban: String, @Json(name = bic) bic: String?, @Json(name = country_id) countryId: CountryId?, @Json(name = bank_name) bankName: String, @Json(name = description) description: String)

CurrencyId

enum CurrencyId : Enum<CurrencyId>

The id of the currency to be used.

EasyOnboarding

data class EasyOnboarding(@Json(name = success_link) successLink: String, @Json(name = abort_link) abortLink: String)

An array of a success/abort_link to overwrite the statically stored values in the easyOboarding.

Employer

data class Employer(@Json(name = name) name: String, @Json(name = months_with_salaries_count) monthsWithSalariesCount: Int, @Json(name = booking_date_first_salary) bookingDateFirstSalary: LocalDateTime, @Json(name = booking_date_last_salary) bookingDateLastSalary: LocalDateTime, @Json(name = months_sums_median) monthsSumsMedian: Float, @Json(name = months_sums_minimum) monthsSumsMinimum: Float, @Json(name = public_employer) publicEmployer: Boolean, @Json(name = current_employer) currentEmployer: Boolean)

EncashmentObject

data class EncashmentObject(@Json(name = collection_count) collectionCount: Int, @Json(name = collection_amount) collectionAmount: Float, @Json(name = collection_office_count) collectionOfficeCount: Int)

EventObject

data class EventObject(@Json(name = id) id: String, @Json(name = transaction) transaction: String, @Json(name = type) type: String, @Json(name = data) data: Any, @Json(name = testmode) testmode: Boolean, @Json(name = message) message: String, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

EventsList

data class EventsList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = next_page_url) nextPageUrl: String?, @Json(name = prev_page_url) prevPageUrl: String?, @Json(name = from) from: Int?, @Json(name = to) to: Int?, @Json(name = data) data: List<EventObject>)

ExpectedHolderObject

data class ExpectedHolderObject(@Json(name = firstname) firstname: String, @Json(name = name) name: String)

Language

enum Language : Enum<Language>

The initial language.

LoansObject

data class LoansObject(@Json(name = loans_count) loansCount: Int, @Json(name = loans_amount) loansAmount: Float, @Json(name = subprime_lender_count) subprimeLenderCount: Int)

MatchesObject

data class MatchesObject(@Json(name = expected_holder) expectedHolder: String, @Json(name = match) match: MatchesObject.MatchType)

OtherAccountsObject

data class OtherAccountsObject(@Json(name = holder) holder: String, @Json(name = iban) iban: String, @Json(name = bic) bic: String?, @Json(name = country_id) countryId: CountryId?, @Json(name = bank_name) bankName: String, @Json(name = type) type: String)

PaymentStatus

enum PaymentStatus : Enum<PaymentStatus>

PayObject

data class PayObject(@Json(name = id) id: String, @Json(name = transaction) transaction: String, @Json(name = sender_holder) senderHolder: String?, @Json(name = sender_iban) senderIban: String?, @Json(name = sender_bic) senderBic: String?, @Json(name = sender_bank_name) senderBankName: String?, @Json(name = sender_country_id) senderCountryId: CountryId?, @Json(name = recipient_holder) recipientHolder: String?, @Json(name = recipient_iban) recipientIban: String?, @Json(name = recipient_bic) recipientBic: String?, @Json(name = recipient_bank_name) recipientBankName: String?, @Json(name = recipient_country_id) recipientCountryId: CountryId?, @Json(name = purpose) purpose: String, @Json(name = amount) amount: Float, @Json(name = currency_id) currencyId: CurrencyId?, @Json(name = testmode) testmode: Boolean, @Json(name = payment_status) paymentStatus: PaymentStatus, @Json(name = metadata) metadata: Map<String, Any>?, @Json(name = merchant_id) merchantId: String?, @Json(name = object) object: String)

PayTransactionList

data class PayTransactionList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = from) from: Int, @Json(name = to) to: Int, @Json(name = data) data: List<PayObject>)

Polling

data class Polling(@Json(name = interval) interval: Int?)

The polling attribute indicates whether the transaction status needs to be polled.

Product

enum Product : Enum<Product>

Name of the used product.

RefundPayoutList

data class RefundPayoutList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = from) from: Int, @Json(name = to) to: Int, @Json(name = data) data: List<RefundPayoutObject>)

RefundPayoutObject

data class RefundPayoutObject(@Json(name = message_id) messageId: String, @Json(name = created_at) createdAt: LocalDateTime)

RefundPayoutRequest

data class RefundPayoutRequest(@Json(name = pain_type) painType: RefundPayoutRequest.PainType, @Json(name = transactions) transactions: List<RefundPayoutTransactions>, @Json(name = batch_booking) batchBooking: Boolean?)

RefundPayoutResponse

data class RefundPayoutResponse(@Json(name = message_id) messageId: String)

RefundPayoutTransactions

data class RefundPayoutTransactions(@Json(name = transaction) transaction: String, @Json(name = amount) amount: Float, @Json(name = type) type: RefundPayoutType)

RefundPayoutType

enum RefundPayoutType : Enum<RefundPayoutType>

The type is payout or refund.

RefundsPayout

data class RefundsPayout(@Json(name = transaction) transaction: String, @Json(name = amount_issued) amountIssued: Float, @Json(name = type) type: RefundPayoutType, @Json(name = testmode) testmode: Boolean, @Json(name = created_at) createdAt: LocalDateTime)

ReportFormat

enum ReportFormat : Enum<ReportFormat>

ReportLocale

enum ReportLocale : Enum<ReportLocale>

RiskCalculations

data class RiskCalculations(@Json(name = tags) tags: List<String>, @Json(name = categories) categories: List<String>, @Json(name = functions) functions: List<String>, @Json(name = name) name: String, @Json(name = days) days: Int?, @Json(name = from) from: LocalDate?, @Json(name = to) to: LocalDate?, @Json(name = full_months) fullMonths: String?, @Json(name = children_categories) childrenCategories: Boolean?, @Json(name = match_tags_with_categories) matchTagsWithCategories: Boolean?)

RiskCalculationsResponse

data class RiskCalculationsResponse(@Json(name = tags) tags: List<String>, @Json(name = categories) categories: List<String>, @Json(name = functions) functions: List<String>, @Json(name = name) name: String, @Json(name = days) days: Int?, @Json(name = from) from: LocalDateTime?, @Json(name = to) to: LocalDateTime?, @Json(name = full_months) fullMonths: String?, @Json(name = results) results: RiskCalculationsResponseResults)

RiskCalculationsResponseResults

data class RiskCalculationsResponseResults(@Json(name = count) count: Int?)

Counts all appropriate results.

RiskObject

data class RiskObject(@Json(name = id) id: String, @Json(name = transaction) transaction: String, @Json(name = account_holder) accountHolder: String, @Json(name = iban) iban: String, @Json(name = bic) bic: String?, @Json(name = bank_name) bankName: String, @Json(name = country_id) countryId: CountryId?, @Json(name = testmode) testmode: Boolean, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = metadata) metadata: Map<String, Any>?, @Json(name = merchant_id) merchantId: String?, @Json(name = object) object: String, @Json(name = xs2a_account_snapshot) xs2aAccountSnapshot: Xs2aAccountSnapshotResponse?, @Json(name = xs2a_balance_check) xs2aBalanceCheck: Xs2aBalanceCheckResponse?, @Json(name = xs2a_balance_overview) xs2aBalanceOverview: Xs2aBalanceOverviewResponse?, @Json(name = xs2a_cashflow_overview) xs2aCashflowOverview: Xs2aCashflowOverviewResponse?, @Json(name = xs2a_chargeback_check) xs2aChargebackCheck: Xs2aChargebackCheckResponse?, @Json(name = xs2a_children_check) xs2aChildrenCheck: Xs2aChildrenCheckResponse?, @Json(name = xs2a_rating_b2b_check) xs2aRatingB2bCheck: Xs2aRatingB2bCheckResponse?, @Json(name = xs2a_rating_b2c_check) xs2aRatingB2cCheck: Xs2aRatingB2cCheckResponse?, @Json(name = xs2a_profit_loss_check) xs2aProfitLossCheck: Xs2aProfitLossCheckResponse?, @Json(name = xs2a_income_check) xs2aIncomeCheck: Xs2aIncomeCheckResponse?, @Json(name = xs2a_account_linked_offers_check) xs2aAccountLinkedOffersCheck: Xs2aAccountLinkedOffersCheckResponse?, @Json(name = xs2a_credit_check) xs2aCreditCheck: Xs2aCreditCheckResponse?, @Json(name = xs2a_direct_debit_check) xs2aDirectDebitCheck: Xs2aDirectDebitCheckResponse?, @Json(name = xs2a_fact_sheet_lists) xs2aFactSheetLists: Xs2aFactSheetListsResponse?, @Json(name = xs2a_overdraft_limit_check) xs2aOverdraftLimitCheck: Xs2aOverdraftLimitCheckResponse?, @Json(name = xs2a_seizure_check) xs2aSeizureCheck: Xs2aSeizureCheckResponse?, @Json(name = xs2a_name_check) xs2aNameCheck: Xs2aNameCheckResponse?, @Json(name = xs2a_standing_orders_check) xs2aStandingOrdersCheck: Xs2aStandingOrdersCheckResponse?, @Json(name = xs2a_all_accounts_check) xs2aAllAccountsCheck: Xs2aAllAccountsCheckResponse?, @Json(name = xs2a_account_status_check) xs2aAccountStatusCheck: Xs2aAccountStatusCheckResponse?, @Json(name = xs2a_holder_identification_check) xs2aHolderIdentificationCheck: Xs2aHolderIdentificationCheckResponse?, @Json(name = xs2a_risk_calculations_check) xs2aRiskCalculationsCheck: Xs2aRiskCalculationsCheckResponse?, @Json(name = xs2a_account_characteristics_check) xs2aAccountCharacteristicsCheck: Xs2aAccountCharacteristicsCheckResponse?)

RisksTransactionList

data class RisksTransactionList(@Json(name = total) total: Int, @Json(name = per_page) perPage: Int, @Json(name = current_page) currentPage: Int, @Json(name = last_page) lastPage: Int, @Json(name = from) from: Int, @Json(name = to) to: Int, @Json(name = data) data: List<RiskObject>)

Turnover

data class Turnover(@Json(name = booking_date) bookingDate: LocalDateTime, @Json(name = amount) amount: Float, @Json(name = currency) currency: CurrencyId?, @Json(name = purpose) purpose: List<String>, @Json(name = counter_iban) counterIban: String?, @Json(name = counter_bic) counterBic: String?, @Json(name = counter_holder) counterHolder: String?, @Json(name = prebooked) prebooked: Boolean?, @Json(name = canceled) canceled: Boolean?, @Json(name = tags) tags: List<String>?, @Json(name = category_id) categoryId: String?, @Json(name = creditor_id) creditorId: String?, @Json(name = new) new: Boolean?)

UserAccountsObject

data class UserAccountsObject(@Json(name = identifier) identifier: String, @Json(name = holder) holder: String, @Json(name = description) description: String, @Json(name = iban) iban: String, @Json(name = bic) bic: String?, @Json(name = account_number) accountNumber: String?, @Json(name = bank_code) bankCode: String, @Json(name = bank_name) bankName: String, @Json(name = country_id) countryId: CountryId?, @Json(name = joint_account) jointAccount: Boolean, @Json(name = transaction_possible) transactionPossible: Boolean, @Json(name = account_type) accountType: AccountType, @Json(name = balance) balance: Float, @Json(name = available) available: Float, @Json(name = limit) limit: Float, @Json(name = currency_id) currencyId: CurrencyId?, @Json(name = turnover_days) turnoverDays: Int, @Json(name = turnover_available_days) turnoverAvailableDays: Int, @Json(name = turnover_count) turnoverCount: Int, @Json(name = average_account_usage) averageAccountUsage: String, @Json(name = overdraft_days) overdraftDays: Int, @Json(name = overdraft_limit_days) overdraftLimitDays: Int, @Json(name = completeness) completeness: UserAccountsObjectCompleteness, @Json(name = account_data_available) accountDataAvailable: String)

UserAccountsObjectCompleteness

data class UserAccountsObjectCompleteness(@Json(name = counter_holder) counterHolder: String, @Json(name = counter_iban) counterIban: String, @Json(name = purpose) purpose: String)

WhitelistAdd

data class WhitelistAdd(@Json(name = iban) iban: String)

WhitelistObject

data class WhitelistObject(@Json(name = id) id: String, @Json(name = hash) hash: String)

WizardResponse

data class WizardResponse(@Json(name = code) code: Int, @Json(name = message) message: String?, @Json(name = error) error: Any?, @Json(name = polling) polling: Polling?, @Json(name = form) form: FormObject?)

WizardSessionCurrentStep

enum WizardSessionCurrentStep : Enum<WizardSessionCurrentStep>

WizardSessionLastError

enum WizardSessionLastError : Enum<WizardSessionLastError>

WizardSessionObject

data class WizardSessionObject(@Json(name = id) id: String, @Json(name = transaction) transaction: String, @Json(name = wizard_session_key) wizardSessionKey: String, @Json(name = product) product: Product?, @Json(name = parameters) parameters: Any, @Json(name = last_error) lastError: WizardSessionLastError, @Json(name = testmode) testmode: Boolean, @Json(name = finished) finished: Boolean, @Json(name = current_step) currentStep: WizardSessionCurrentStep, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

WizardSessionResponse

data class WizardSessionResponse(@Json(name = transaction) transaction: String, @Json(name = wizard_session_key) wizardSessionKey: String)

Xs2aAccountCharacteristicsCheckResponse

data class Xs2aAccountCharacteristicsCheckResponse(@Json(name = chargebacks) chargebacks: ChargebacksObject, @Json(name = encashment) encashment: EncashmentObject, @Json(name = account_profile) accountProfile: AccountProfileObject, @Json(name = loans) loans: LoansObject, @Json(name = flags) flags: Map<String, String>, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aAccountLinkedOffersCheckResponse

data class Xs2aAccountLinkedOffersCheckResponse(@Json(name = links) links: List<Xs2aAccountLinkedOffersCheckResponseLinks>)

Xs2aAccountLinkedOffersCheckResponseLinks

data class Xs2aAccountLinkedOffersCheckResponseLinks(@Json(name = link) link: String, @Json(name = description) description: String, @Json(name = image) image: String)

Xs2aAccountSnapshot

data class Xs2aAccountSnapshot(@Json(name = days) days: Int?, @Json(name = from) from: LocalDate?, @Json(name = to) to: LocalDate?, @Json(name = filters) filters: List<String>?, @Json(name = all_accounts) allAccounts: Boolean, @Json(name = all_tags) allTags: Boolean)

Xs2aAccountSnapshotResponse

data class Xs2aAccountSnapshotResponse(@Json(name = object) object: String, @Json(name = days) days: Int?, @Json(name = from) from: LocalDate?, @Json(name = to) to: LocalDate?, @Json(name = filters) filters: List<String>?, @Json(name = all_tags) allTags: Boolean, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aAccountStatusCheck

data class Xs2aAccountStatusCheck(@Json(name = limit_turnover_days) limitTurnoverDays: Int?, @Json(name = all_accounts) allAccounts: Boolean)

With XS2A.xs2a_account_status_check a list of accounts within the bank connection can be requested.

Xs2aAccountStatusCheckResponse

data class Xs2aAccountStatusCheckResponse(@Json(name = account_details) accountDetails: List<UserAccountsObject>, @Json(name = other_accounts) otherAccounts: List<OtherAccountsObject>, @Json(name = credit_cards) creditCards: List<CreditCardsObject>, @Json(name = days) days: Int?, @Json(name = all_accounts) allAccounts: Boolean, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

Xs2aAllAccountsCheckResponse

data class Xs2aAllAccountsCheckResponse(@Json(name = accounts) accounts: List<BankAccountObject>, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aBalanceCheck

data class Xs2aBalanceCheck(@Json(name = check_amount) checkAmount: Float, @Json(name = check_currency_id) checkCurrencyId: CurrencyId)

Xs2aBalanceCheckResponse

data class Xs2aBalanceCheckResponse(@Json(name = object) object: String, @Json(name = check_amount) checkAmount: Float, @Json(name = check_currency_id) checkCurrencyId: CurrencyId, @Json(name = check_passed) checkPassed: Boolean, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aBalanceOverviewResponse

data class Xs2aBalanceOverviewResponse(@Json(name = object) object: String, @Json(name = balance) balance: Float, @Json(name = available) available: Float, @Json(name = limit) limit: Float, @Json(name = currency_id) currencyId: CurrencyId?, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aCashflowObject

data class Xs2aCashflowObject(@Json(name = month) month: Int, @Json(name = incoming) incoming: Float, @Json(name = outgoing) outgoing: Float, @Json(name = minimum_balance) minimumBalance: Float, @Json(name = incoming_transactions) incomingTransactions: Int, @Json(name = outgoing_transactions) outgoingTransactions: Int, @Json(name = currency_id) currencyId: CurrencyId?)

Xs2aCashflowOverviewResponse

data class Xs2aCashflowOverviewResponse(@Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String, @Json(name = cashflow) cashflow: List<Xs2aCashflowObject>)

Xs2aChargebackCheckResponse

data class Xs2aChargebackCheckResponse(@Json(name = chargebacks_count) chargebacksCount: Int, @Json(name = chargebacks_coverage) chargebacksCoverage: Int, @Json(name = chargebacks_revoked) chargebacksRevoked: Int, @Json(name = chargebacks_sum_amount) chargebacksSumAmount: Float, @Json(name = currency_id) currencyId: CurrencyId?, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aChildrenCheckResponse

data class Xs2aChildrenCheckResponse(@Json(name = children_at_account_holder) childrenAtAccountHolder: Int)

Xs2aCreditCheck

data class Xs2aCreditCheck(@Json(name = checks) checks: List<String>)

The XS2A.credit_check gathers various information about a customer.

Xs2aCreditCheckResponse

data class Xs2aCreditCheckResponse(@Json(name = checks) checks: List<String>, @Json(name = check_days) checkDays: Int, @Json(name = results) results: Xs2aCreditCheckResponseResults, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aCreditCheckResponseResults

data class Xs2aCreditCheckResponseResults(@Json(name = income) income: ChecksResult?, @Json(name = rent) rent: ChecksResult?)

The keys are the names of the requested checks.

Xs2aDirectDebitCheck

data class Xs2aDirectDebitCheck(@Json(name = check_amount) checkAmount: Float, @Json(name = check_currency_id) checkCurrencyId: CurrencyId, @Json(name = start_date) startDate: LocalDate?, @Json(name = end_date) endDate: LocalDate?)

Xs2aDirectDebitCheckResponse

data class Xs2aDirectDebitCheckResponse(@Json(name = check_amount) checkAmount: Float, @Json(name = check_currency_id) checkCurrencyId: CurrencyId, @Json(name = start_date) startDate: LocalDate?, @Json(name = end_date) endDate: LocalDate?, @Json(name = recommendation) recommendation: String, @Json(name = recommendation_date) recommendationDate: LocalDate?, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aFactSheetLists

data class Xs2aFactSheetLists(@Json(name = limit_turnover_days) limitTurnoverDays: Int?, @Json(name = fields) fields: List<Xs2aFactSheetListsFields>)

Xs2aFactSheetListsFields

data class Xs2aFactSheetListsFields(@Json(name = tags) tags: List<String>, @Json(name = categories) categories: List<String>, @Json(name = name) name: String, @Json(name = min_amount) minAmount: Float?, @Json(name = max_amount) maxAmount: Float?)

Xs2aFactSheetListsResponse

data class Xs2aFactSheetListsResponse(@Json(name = fields) fields: List<Xs2aFactSheetListsResponseFields>, @Json(name = days) days: Int?, @Json(name = result) result: List<Xs2aFactSheetListsResponseResult>, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

This module allows you to create a lists of filtered transaction data from the reference account.

Xs2aFactSheetListsResponseFields

data class Xs2aFactSheetListsResponseFields(@Json(name = name) name: String, @Json(name = tags) tags: List<String>, @Json(name = categories) categories: List<String>, @Json(name = min_amount) minAmount: Float?, @Json(name = max_amount) maxAmount: Float?)

Xs2aFactSheetListsResponseResult

data class Xs2aFactSheetListsResponseResult(@Json(name = fields) fields: Xs2aFactSheetListsResponseFields, @Json(name = turnovers_count) turnoversCount: Int, @Json(name = sum_amounts) sumAmounts: Float, @Json(name = timespan) timespan: Int, @Json(name = distinct_counter_holders) distinctCounterHolders: Int, @Json(name = turnovers) turnovers: Int)

Model for a single result entry of an FactSheetLists-Check.

Xs2aHolderIdentificationCheck

data class Xs2aHolderIdentificationCheck(@Json(name = expect_holders) expectHolders: List<ExpectedHolderObject>)

XS2A.holder_identification_check.

Xs2aHolderIdentificationCheckResponse

data class Xs2aHolderIdentificationCheckResponse(@Json(name = expect_holders) expectHolders: List<String>, @Json(name = accounts) accounts: List<AccountHoldersObject>, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aIncomeCheckResponse

data class Xs2aIncomeCheckResponse(@Json(name = data) data: Xs2aIncomeCheckResponseData, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aIncomeCheckResponseData

data class Xs2aIncomeCheckResponseData(@Json(name = full_months_count) fullMonthsCount: Int, @Json(name = category_short_name) categoryShortName: Xs2aIncomeCheckResponseDataCategoryShortName?)

Xs2aIncomeCheckResponseDataCategoryShortName

data class Xs2aIncomeCheckResponseDataCategoryShortName(@Json(name = monthly_sums) monthlySums: Map<String, Float>, @Json(name = months_sums_median) monthsSumsMedian: Float, @Json(name = months_sums_minimum) monthsSumsMinimum: Float, @Json(name = min_date) minDate: LocalDateTime, @Json(name = max_date) maxDate: LocalDateTime, @Json(name = current_payment) currentPayment: Boolean, @Json(name = forecast) forecast: Float, @Json(name = forecast_month_count) forecastMonthCount: Int, @Json(name = current_employers) currentEmployers: Int, @Json(name = employer) employer: Employer)

Xs2aNameCheck

data class Xs2aNameCheck(@Json(name = name) name: String, @Json(name = firstname) firstname: String)

Xs2aNameCheckResponse

data class Xs2aNameCheckResponse(@Json(name = name) name: String, @Json(name = firstname) firstname: String, @Json(name = match) match: Boolean, @Json(name = similarity) similarity: Int, @Json(name = created_at) created_at: String, @Json(name = object) object: String)

Xs2aOverdraftLimitCheckResponse

data class Xs2aOverdraftLimitCheckResponse(@Json(name = booking_days) bookingDays: Int, @Json(name = overdraft_limit_days) overdraftLimitDays: Int, @Json(name = maximum_overdraft_used) maximumOverdraftUsed: Float, @Json(name = average_overdraft_used) averageOverdraftUsed: Float, @Json(name = median_overdraft_used) medianOverdraftUsed: Float, @Json(name = currency_id) currencyId: CurrencyId?, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aPay

data class Xs2aPay(@Json(name = amount) amount: Float, @Json(name = currency_id) currencyId: CurrencyId?, @Json(name = purpose) purpose: String, @Json(name = recipient_holder) recipientHolder: String, @Json(name = recipient_iban) recipientIban: String, @Json(name = metadata) metadata: Map<String, Any>?, @Json(name = language) language: Language?, @Json(name = merchant_id) merchantId: String?, @Json(name = fints_product_id) fintsProductId: String?, @Json(name = easy_onboarding) easyOnboarding: EasyOnboarding?, @Json(name = sender_holder) senderHolder: String?, @Json(name = sender_iban) senderIban: String?, @Json(name = sender_bic) senderBic: String?, @Json(name = sender_country_id) senderCountryId: CountryId?, @Json(name = recipient_bic) recipientBic: String?, @Json(name = recipient_street) recipientStreet: String?, @Json(name = recipient_zip) recipientZip: String?, @Json(name = recipient_city) recipientCity: String?, @Json(name = recipient_country_id) recipientCountryId: CountryId?)

Xs2aProfitLossCheckResponse

data class Xs2aProfitLossCheckResponse(@Json(name = result) result: Xs2aProfitLossCheckResponseResult)

Xs2aProfitLossCheckResponseResult

data class Xs2aProfitLossCheckResponseResult(@Json(name = tax_ids) taxIds: List<String>, @Json(name = profit_loss) profitLoss: Xs2aProfitLossCheckResponseResultProfitLoss)

Xs2aProfitLossCheckResponseResultProfitLoss

data class Xs2aProfitLossCheckResponseResultProfitLoss(@Json(name = period_start) periodStart: String, @Json(name = period_end) periodEnd: String, @Json(name = period_days) periodDays: Int, @Json(name = turnover_income) turnoverIncome: Float, @Json(name = cash_deposit) cashDeposit: Float, @Json(name = other_income) otherIncome: Float, @Json(name = rent_expense) rentExpense: Float, @Json(name = supplies_expense) suppliesExpense: Float, @Json(name = personnel_expense) personnelExpense: Float, @Json(name = tax_expense) taxExpense: Float, @Json(name = other_expense) otherExpense: Float, @Json(name = cashflow) cashflow: Float, @Json(name = cashflow_revenue_ratio) cashflowRevenueRatio: Float)

Xs2aRatingB2bCheckResponse

data class Xs2aRatingB2bCheckResponse(@Json(name = rating) rating: String, @Json(name = version) version: String)

Xs2aRatingB2cCheckResponse

data class Xs2aRatingB2cCheckResponse(@Json(name = rating) rating: String, @Json(name = version) version: String)

Xs2aRisk

data class Xs2aRisk(@Json(name = bank_code) bankCode: Int?, @Json(name = country_id) countryId: CountryId?, @Json(name = account_number) accountNumber: String?, @Json(name = iban) iban: String?, @Json(name = bic) bic: String?, @Json(name = check_amount) checkAmount: Float?, @Json(name = check_currency_id) checkCurrencyId: CurrencyId?, @Json(name = metadata) metadata: Map<String, Any>?, @Json(name = merchant_id) merchantId: String?, @Json(name = fints_product_id) fintsProductId: String?, @Json(name = easy_onboarding) easyOnboarding: EasyOnboarding?, @Json(name = language) language: Language?, @Json(name = xs2a_account_characteristics_check) xs2aAccountCharacteristicsCheck: List<String>?, @Json(name = xs2a_account_linked_offers_check) xs2aAccountLinkedOffersCheck: List<String>?, @Json(name = xs2a_account_snapshot) xs2aAccountSnapshot: Xs2aAccountSnapshot?, @Json(name = xs2a_account_status_check) xs2aAccountStatusCheck: Xs2aAccountStatusCheck?, @Json(name = xs2a_all_accounts_check) xs2aAllAccountsCheck: List<String>?, @Json(name = xs2a_balance_check) xs2aBalanceCheck: Xs2aBalanceCheck?, @Json(name = xs2a_balance_overview) xs2aBalanceOverview: List<String>?, @Json(name = xs2a_cashflow_overview) xs2aCashflowOverview: List<String>?, @Json(name = xs2a_chargeback_check) xs2aChargebackCheck: List<String>?, @Json(name = xs2a_children_check) xs2aChildrenCheck: List<String>?, @Json(name = xs2a_credit_check) xs2aCreditCheck: Xs2aCreditCheck?, @Json(name = xs2a_direct_debit_check) xs2aDirectDebitCheck: Xs2aDirectDebitCheck?, @Json(name = xs2a_fact_sheet_lists) xs2aFactSheetLists: Xs2aFactSheetLists?, @Json(name = xs2a_holder_identification_check) xs2aHolderIdentificationCheck: Xs2aHolderIdentificationCheck?, @Json(name = xs2a_income_check) xs2aIncomeCheck: List<String>?, @Json(name = xs2a_name_check) xs2aNameCheck: Xs2aNameCheck?, @Json(name = xs2a_overdraft_limit_check) xs2aOverdraftLimitCheck: List<String>?, @Json(name = xs2a_profit_loss_check) xs2aProfitLossCheck: List<String>?, @Json(name = xs2a_rating_b2b_check) xs2aRatingB2bCheck: List<String>?, @Json(name = xs2a_rating_b2c_check) xs2aRatingB2cCheck: List<String>?, @Json(name = xs2a_risk_calculations_check) xs2aRiskCalculationsCheck: Xs2aRiskCalculationsCheck?, @Json(name = xs2a_seizure_check) xs2aSeizureCheck: Xs2aSeizureCheck?, @Json(name = xs2a_standing_orders_check) xs2aStandingOrdersCheck: List<String>?)

Xs2aRiskCalculationsCheck

data class Xs2aRiskCalculationsCheck(@Json(name = calculations) calculations: List<RiskCalculations>)

XS2A.

Xs2aRiskCalculationsCheckResponse

data class Xs2aRiskCalculationsCheckResponse(@Json(name = calculations) calculations: List<RiskCalculationsResponse>, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = object) object: String)

Xs2ariskuploadjson404

data class Xs2ariskuploadjson404(@Json(name = code) code: Int, @Json(name = message) message: String)

Xs2ariskuploadjson422

data class Xs2ariskuploadjson422(@Json(name = code) code: Int, @Json(name = message) message: String)

Xs2ariskuploadjson500

data class Xs2ariskuploadjson500(@Json(name = code) code: Int, @Json(name = message) message: String)

Xs2aRiskUploadJsonAccount

data class Xs2aRiskUploadJsonAccount(@Json(name = holder) holder: String, @Json(name = description) description: String, @Json(name = iban) iban: String, @Json(name = country_id) countryId: CountryId, @Json(name = bic) bic: String?, @Json(name = bank_name) bankName: String, @Json(name = joint_account) jointAccount: Boolean)

Xs2aRiskUploadJsonBalance

data class Xs2aRiskUploadJsonBalance(@Json(name = balance) balance: Float, @Json(name = limit) limit: Float, @Json(name = available) available: Float, @Json(name = currency) currency: CurrencyId)

Xs2aRiskUploadJsonSuccess

data class Xs2aRiskUploadJsonSuccess(@Json(name = id) id: String, @Json(name = transaction) transaction: String, @Json(name = account_holder) accountHolder: String, @Json(name = iban) iban: String?, @Json(name = bic) bic: String?, @Json(name = bank_name) bankName: String, @Json(name = country_id) countryId: CountryId?, @Json(name = testmode) testmode: Boolean, @Json(name = created_at) createdAt: LocalDateTime, @Json(name = metadata) metadata: String?, @Json(name = merchant_id) merchantId: String?, @Json(name = object) object: String)

Xs2aRiskUploadJsonTurnoversTurnover

data class Xs2aRiskUploadJsonTurnoversTurnover(@Json(name = booking_date) bookingDate: LocalDateTime, @Json(name = amount) amount: Float, @Json(name = currency) currency: CurrencyId, @Json(name = purpose) purpose: List<String>, @Json(name = counter_iban) counterIban: String, @Json(name = counter_bic) counterBic: String, @Json(name = counter_holder) counterHolder: String)

Xs2aRiskUploadJsonWrapper

data class Xs2aRiskUploadJsonWrapper(@Json(name = account) account: Xs2aRiskUploadJsonAccount, @Json(name = balance) balance: Xs2aRiskUploadJsonBalance, @Json(name = turnovers) turnovers: List<Xs2aRiskUploadJsonTurnoversTurnover>)

Xs2aSeizureCheck

data class Xs2aSeizureCheck(@Json(name = days) days: Int?)

XS2a.seizure_check allows you to check for a seizire account.

Xs2aSeizureCheckResponse

data class Xs2aSeizureCheckResponse(@Json(name = is_seizure) isSeizure: Int, @Json(name = days) days: Int?, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aStandingOrdersCheckResponse

data class Xs2aStandingOrdersCheckResponse(@Json(name = standing_orders) standingOrders: List<Xs2aStandingOrdersCheckResponseStandingOrders>, @Json(name = object) object: String, @Json(name = created_at) createdAt: LocalDateTime)

Xs2aStandingOrdersCheckResponseStandingOrders

data class Xs2aStandingOrdersCheckResponseStandingOrders(@Json(name = sender_account) senderAccount: BankAccountObject, @Json(name = recipient_account) recipientAccount: BankAccountObject, @Json(name = amount) amount: Float, @Json(name = currency) currency: CurrencyId?, @Json(name = purpose) purpose: String, @Json(name = frequency) frequency: String, @Json(name = frequency_interval) frequencyInterval: Int, @Json(name = day) day: Int, @Json(name = start_execution) startExecution: LocalDate?, @Json(name = end_execution) endExecution: LocalDate?)