com.fintecsystems.xs2a.java.models.risk.Xs2aRisk.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xs2a-java Show documentation
Java SDK for XS2A API
The newest version!

package com.fintecsystems.xs2a.java.models.risk

import com.fintecsystems.xs2a.java.models.common.CountryId
import com.fintecsystems.xs2a.java.models.common.CurrencyId
import com.fintecsystems.xs2a.java.models.common.EasyOnboarding
import com.fintecsystems.xs2a.java.models.common.Language
import com.fintecsystems.xs2a.java.models.risk.checks.*
import com.squareup.moshi.Json

/**
 * 
 * @param bankCode bank code of the customers bank, requires also parameter country_id. If supplied the step/page for entering a bank code will be skipped.
 * @param countryId Two letter country code id, e.g. AT, CH, DE
 * @param accountNumber The (national) account number of the customer. Is the account number valid, an IBAN will be calculated using the bank code and the account number. Afterwards the procedure is equal to the following description for iban (see below). If you include this field, you must also include the parameter bank_code.
 * @param iban IBAN of the customer. If it is a valid IBAN, the IBAN will be pinned for the current session. The customer will not be able to choose a different account, even if there are more accounts available to chose from. If the given IBAN is not in the customer list of accounts, the transaction will be aborted. In the case of an invalid IBAN XS2A will return a validation error with HTTP status code 422.
 * @param bic BIC of the customer. If the given BIC is valid, the step/page for entering a bank code will be skipped.
 * @param checkAmount The account balance amount to be checked against.
 * @param checkCurrencyId Currency id of check_amount
 * @param metadata 
 * @param merchantId The internal ID of your merchant, if any.
 * @param fintsProductId The fints product ID can be enclosed in the initial request. If you have an eIDAS certificate, then you have to send it with every request.
 * @param easyOnboarding 
 * @param language 
 * @param xs2aAccountCharacteristicsCheck XS2A.account_characteristics_check allows you to retrieve many possible information about the account, like chargebacks, encashment, loans and other.
 * @param xs2aAccountLinkedOffersCheck The Account Linked Offers Check validates with the consent of the user, based on an account view, whether third party offers might be of interest to the user and hands over an advertising link for one-time use to a XS2A business partner.
 * @param xs2aAccountSnapshot 
 * @param xs2aAccountStatusCheck 
 * @param xs2aAgeVerificationCheck 
 * @param xs2aAllAccountsCheck XS2A.standing_orders_check allows you to retrieve all standing orders from an account. An XS2A.standing_orders_check has no additional parameters.
 * @param xs2aBalanceCheck 
 * @param xs2aBalanceOverview XS2A.balance_overview returns the current running total of the chosen account. An XS2A.balance_overview has no additional parameters.
 * @param xs2aCashflowOverview XS2A.cashflow_overview provides an cashflow overview for the requested risk date range. An XS2A.cashflow_overview has no additional parameters.
 * @param xs2aChargebackCheck XS2A.chargeback_check returns the number of detected chargeback transactions for the account. An XS2A.chargeback_check has no additional parameters.
 * @param xs2aChildrenCheck The XS2A.children_check gathers payments from governmental facilities, which indicate how many children the account has. This risk-check has no configuration.
 * @param xs2aCreditCheck 
 * @param xs2aDirectDebitCheck
 * @param xs2aFactSheetLists 
 * @param xs2aHolderIdentificationCheck 
 * @param xs2aIncomeCheck The Income Check provides an overview of the account holder's various types of income. Each type of income is listed separately and the corresponding key figures are calculated so that the customer can only take into account the types of income that are relevant for him/her.
 * @param xs2aInsuranceContractCheck
 * @param xs2aNameCheck
 * @param xs2aOverdraftLimitCheck XS2A.overdraft_limit_check returns the number of booking days of the given risk range. The number of days the account used the overdraft limit, the maximum amount of overdraft used, the average and the median used overdraft. An XS2A.overdraft_limit_check has no additional parameters.
 * @param xs2aProfitLossCheck The P&L check (profit and loss check) provides a simplified P&L statement for B2B customers as well as an overview of other relevant operational KPIs. These can be, for example, other relevant income, expenses and cash flows from the account. In addition, the tax number is also shown (initially, only in Germany).
 * @param xs2aRatingB2bCheck Produces a qualitative evaluation of a bank statement (business accounts) according to various criteria and summarizes these in a school grade system (A-F).
 * @param xs2aRatingB2cCheck Produces a qualitative evaluation of a bank statement (private accounts) according to various criteria and summarizes these in a school grade system (A-F).
 * @param xs2aRiskCalculationsCheck 
 * @param xs2aSeizureCheck 
 * @param xs2aStandingOrdersCheck XS2A.standing_orders_check allows you to retrieve all standing orders from an account. An XS2A.standing_orders_check has no additional parameters.
 */

data class Xs2aRisk (
    @Json(name = "bank_code")
    var bankCode: Int? = null,
    @Json(name = "country_id")
    var countryId: CountryId? = null,
    @Json(name = "account_number")
    var accountNumber: String? = null,
    @Json(name = "iban")
    var iban: String? = null,
    @Json(name = "bic")
    var bic: String? = null,
    @Json(name = "check_amount")
    var checkAmount: Float? = null,
    @Json(name = "check_currency_id")
    var checkCurrencyId: CurrencyId? = null,
    @Json(name = "metadata")
    var metadata: Map? = null,
    @Json(name = "merchant_id")
    var merchantId: String? = null,
    @Json(name = "fints_product_id")
    var fintsProductId: String? = null,
    @Json(name = "easy_onboarding")
    var easyOnboarding: EasyOnboarding? = null,
    @Json(name = "language")
    var language: Language? = null,
    @Json(name = "xs2a_account_characteristics_check")
    var xs2aAccountCharacteristicsCheck: Xs2aAccountCharacteristicsCheck? = null,
    @Json(name = "xs2a_account_linked_offers_check")
    var xs2aAccountLinkedOffersCheck: Xs2aAccountLinkedOffersCheck? = null,
    @Json(name = "xs2a_account_snapshot")
    var xs2aAccountSnapshot: Xs2aAccountSnapshot? = null,
    @Json(name = "xs2a_account_status_check")
    var xs2aAccountStatusCheck: Xs2aAccountStatusCheck? = null,
    @Json(name = "xs2a_age_verification_check")
    var xs2aAgeVerificationCheck: Xs2aAgeVerificationCheck? = null,
    @Json(name = "xs2a_all_accounts_check")
    var xs2aAllAccountsCheck: Xs2aAllAccountsCheck? = null,
    @Json(name = "xs2a_balance_check")
    var xs2aBalanceCheck: Xs2aBalanceCheck? = null,
    @Json(name = "xs2a_balance_overview")
    var xs2aBalanceOverview: Xs2aBalanceOverview? = null,
    @Json(name = "xs2a_cashflow_overview")
    var xs2aCashflowOverview: Xs2aCashflowOverview? = null,
    @Json(name = "xs2a_chargeback_check")
    var xs2aChargebackCheck: Xs2aChargebackCheck? = null,
    @Json(name = "xs2a_children_check")
    var xs2aChildrenCheck: Xs2aChildrenCheck? = null,
    @Json(name = "xs2a_credit_check")
    var xs2aCreditCheck: Xs2aCreditCheck? = null,
    @Json(name = "xs2a_direct_debit_check")
    var xs2aDirectDebitCheck: Xs2aDirectDebitCheck? = null,
    @Json(name = "xs2a_fact_sheet_lists")
    var xs2aFactSheetLists: Xs2aFactSheetLists? = null,
    @Json(name = "xs2a_holder_identification_check")
    var xs2aHolderIdentificationCheck: Xs2aHolderIdentificationCheck? = null,
    @Json(name = "xs2a_income_check")
    var xs2aIncomeCheck: Xs2aIncomeCheck? = null,
    @Json(name = "xs2a_insurance_contract_check")
    var xs2aInsuranceContractCheck: Xs2aInsuranceContractCheck? = null,
    @Json(name = "xs2a_name_check")
    var xs2aNameCheck: Xs2aNameCheck? = null,
    @Json(name = "xs2a_overdraft_limit_check")
    var xs2aOverdraftLimitCheck: Xs2aOverdraftLimitCheck? = null,
    @Json(name = "xs2a_profit_loss_check")
    var xs2aProfitLossCheck: Xs2aProfitLossCheck? = null,
    @Json(name = "xs2a_rating_b2b_check")
    var xs2aRatingB2bCheck: Xs2aRatingB2bCheck? = null,
    @Json(name = "xs2a_rating_b2c_check")
    var xs2aRatingB2cCheck: Xs2aRatingB2cCheck? = null,
    @Json(name = "xs2a_risk_calculations_check")
    var xs2aRiskCalculationsCheck: Xs2aRiskCalculationsCheck? = null,
    @Json(name = "xs2a_seizure_check")
    var xs2aSeizureCheck: Xs2aSeizureCheck? = null,
    @Json(name = "xs2a_standing_orders_check")
    var xs2aStandingOrdersCheck: Xs2aStandingOrdersCheck? = null,
)