Xs2aRisk

data class Xs2aRisk(@Json(name = bank_codebankCode: Int?, @Json(name = country_idcountryId: CountryId?, @Json(name = account_numberaccountNumber: String?, @Json(name = ibaniban: String?, @Json(name = bicbic: String?, @Json(name = check_amountcheckAmount: Float?, @Json(name = check_currency_idcheckCurrencyId: CurrencyId?, @Json(name = metadatametadata: Map<String, Any>?, @Json(name = merchant_idmerchantId: String?, @Json(name = fints_product_idfintsProductId: String?, @Json(name = easy_onboardingeasyOnboarding: EasyOnboarding?, @Json(name = languagelanguage: Language?, @Json(name = xs2a_account_characteristics_checkxs2aAccountCharacteristicsCheck: Xs2aAccountCharacteristicsCheck?, @Json(name = xs2a_account_linked_offers_checkxs2aAccountLinkedOffersCheck: Xs2aAccountLinkedOffersCheck?, @Json(name = xs2a_account_snapshotxs2aAccountSnapshot: Xs2aAccountSnapshot?, @Json(name = xs2a_account_status_checkxs2aAccountStatusCheck: Xs2aAccountStatusCheck?, @Json(name = xs2a_age_verification_checkxs2aAgeVerificationCheck: Xs2aAgeVerificationCheck?, @Json(name = xs2a_all_accounts_checkxs2aAllAccountsCheck: Xs2aAllAccountsCheck?, @Json(name = xs2a_balance_checkxs2aBalanceCheck: Xs2aBalanceCheck?, @Json(name = xs2a_balance_overviewxs2aBalanceOverview: Xs2aBalanceOverview?, @Json(name = xs2a_cashflow_overviewxs2aCashflowOverview: Xs2aCashflowOverview?, @Json(name = xs2a_chargeback_checkxs2aChargebackCheck: Xs2aChargebackCheck?, @Json(name = xs2a_children_checkxs2aChildrenCheck: Xs2aChildrenCheck?, @Json(name = xs2a_credit_checkxs2aCreditCheck: Xs2aCreditCheck?, @Json(name = xs2a_direct_debit_checkxs2aDirectDebitCheck: Xs2aDirectDebitCheck?, @Json(name = xs2a_fact_sheet_listsxs2aFactSheetLists: Xs2aFactSheetLists?, @Json(name = xs2a_holder_identification_checkxs2aHolderIdentificationCheck: Xs2aHolderIdentificationCheck?, @Json(name = xs2a_income_checkxs2aIncomeCheck: Xs2aIncomeCheck?, @Json(name = xs2a_insurance_contract_checkxs2aInsuranceContractCheck: Xs2aInsuranceContractCheck?, @Json(name = xs2a_name_checkxs2aNameCheck: Xs2aNameCheck?, @Json(name = xs2a_overdraft_limit_checkxs2aOverdraftLimitCheck: Xs2aOverdraftLimitCheck?, @Json(name = xs2a_profit_loss_checkxs2aProfitLossCheck: Xs2aProfitLossCheck?, @Json(name = xs2a_rating_b2b_checkxs2aRatingB2bCheck: Xs2aRatingB2bCheck?, @Json(name = xs2a_rating_b2c_checkxs2aRatingB2cCheck: Xs2aRatingB2cCheck?, @Json(name = xs2a_risk_calculations_checkxs2aRiskCalculationsCheck: Xs2aRiskCalculationsCheck?, @Json(name = xs2a_seizure_checkxs2aSeizureCheck: Xs2aSeizureCheck?, @Json(name = xs2a_standing_orders_checkxs2aStandingOrdersCheck: Xs2aStandingOrdersCheck?)

Parameters

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.

countryId

Two letter country code id, e.g. AT, CH, DE

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.

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.

bic

BIC of the customer. If the given BIC is valid, the step/page for entering a bank code will be skipped.

checkAmount

The account balance amount to be checked against.

checkCurrencyId

Currency id of check_amount

metadata
merchantId

The internal ID of your merchant, if any.

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.

easyOnboarding
language
xs2aAccountCharacteristicsCheck

XS2A.account_characteristics_check allows you to retrieve many possible information about the account, like chargebacks, encashment, loans and other.

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.

xs2aAccountSnapshot
xs2aAccountStatusCheck
xs2aAgeVerificationCheck
xs2aAllAccountsCheck

XS2A.standing_orders_check allows you to retrieve all standing orders from an account. An XS2A.standing_orders_check has no additional parameters.

xs2aBalanceCheck
xs2aBalanceOverview

XS2A.balance_overview returns the current running total of the chosen account. An XS2A.balance_overview has no additional parameters.

xs2aCashflowOverview

XS2A.cashflow_overview provides an cashflow overview for the requested risk date range. An XS2A.cashflow_overview has no additional parameters.

xs2aChargebackCheck

XS2A.chargeback_check returns the number of detected chargeback transactions for the account. An XS2A.chargeback_check has no additional parameters.

xs2aChildrenCheck

The XS2A.children_check gathers payments from governmental facilities, which indicate how many children the account has. This risk-check has no configuration.

xs2aCreditCheck
xs2aDirectDebitCheck
xs2aFactSheetLists
xs2aHolderIdentificationCheck
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.

xs2aInsuranceContractCheck
xs2aNameCheck
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.

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).

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).

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).

xs2aRiskCalculationsCheck
xs2aSeizureCheck
xs2aStandingOrdersCheck

XS2A.standing_orders_check allows you to retrieve all standing orders from an account. An XS2A.standing_orders_check has no additional parameters.

Constructors

Xs2aRisk
Link copied to clipboard
fun Xs2aRisk(@Json(name = bank_codebankCode: Int? = null, @Json(name = country_idcountryId: CountryId? = null, @Json(name = account_numberaccountNumber: String? = null, @Json(name = ibaniban: String? = null, @Json(name = bicbic: String? = null, @Json(name = check_amountcheckAmount: Float? = null, @Json(name = check_currency_idcheckCurrencyId: CurrencyId? = null, @Json(name = metadatametadata: Map<String, Any>? = null, @Json(name = merchant_idmerchantId: String? = null, @Json(name = fints_product_idfintsProductId: String? = null, @Json(name = easy_onboardingeasyOnboarding: EasyOnboarding? = null, @Json(name = languagelanguage: Language? = null, @Json(name = xs2a_account_characteristics_checkxs2aAccountCharacteristicsCheck: Xs2aAccountCharacteristicsCheck? = null, @Json(name = xs2a_account_linked_offers_checkxs2aAccountLinkedOffersCheck: Xs2aAccountLinkedOffersCheck? = null, @Json(name = xs2a_account_snapshotxs2aAccountSnapshot: Xs2aAccountSnapshot? = null, @Json(name = xs2a_account_status_checkxs2aAccountStatusCheck: Xs2aAccountStatusCheck? = null, @Json(name = xs2a_age_verification_checkxs2aAgeVerificationCheck: Xs2aAgeVerificationCheck? = null, @Json(name = xs2a_all_accounts_checkxs2aAllAccountsCheck: Xs2aAllAccountsCheck? = null, @Json(name = xs2a_balance_checkxs2aBalanceCheck: Xs2aBalanceCheck? = null, @Json(name = xs2a_balance_overviewxs2aBalanceOverview: Xs2aBalanceOverview? = null, @Json(name = xs2a_cashflow_overviewxs2aCashflowOverview: Xs2aCashflowOverview? = null, @Json(name = xs2a_chargeback_checkxs2aChargebackCheck: Xs2aChargebackCheck? = null, @Json(name = xs2a_children_checkxs2aChildrenCheck: Xs2aChildrenCheck? = null, @Json(name = xs2a_credit_checkxs2aCreditCheck: Xs2aCreditCheck? = null, @Json(name = xs2a_direct_debit_checkxs2aDirectDebitCheck: Xs2aDirectDebitCheck? = null, @Json(name = xs2a_fact_sheet_listsxs2aFactSheetLists: Xs2aFactSheetLists? = null, @Json(name = xs2a_holder_identification_checkxs2aHolderIdentificationCheck: Xs2aHolderIdentificationCheck? = null, @Json(name = xs2a_income_checkxs2aIncomeCheck: Xs2aIncomeCheck? = null, @Json(name = xs2a_insurance_contract_checkxs2aInsuranceContractCheck: Xs2aInsuranceContractCheck? = null, @Json(name = xs2a_name_checkxs2aNameCheck: Xs2aNameCheck? = null, @Json(name = xs2a_overdraft_limit_checkxs2aOverdraftLimitCheck: Xs2aOverdraftLimitCheck? = null, @Json(name = xs2a_profit_loss_checkxs2aProfitLossCheck: Xs2aProfitLossCheck? = null, @Json(name = xs2a_rating_b2b_checkxs2aRatingB2bCheck: Xs2aRatingB2bCheck? = null, @Json(name = xs2a_rating_b2c_checkxs2aRatingB2cCheck: Xs2aRatingB2cCheck? = null, @Json(name = xs2a_risk_calculations_checkxs2aRiskCalculationsCheck: Xs2aRiskCalculationsCheck? = null, @Json(name = xs2a_seizure_checkxs2aSeizureCheck: Xs2aSeizureCheck? = null, @Json(name = xs2a_standing_orders_checkxs2aStandingOrdersCheck: Xs2aStandingOrdersCheck? = null)
bank code of the customers bank, requires also parameter country_id.

Properties

accountNumber
Link copied to clipboard
var accountNumber: String? = null
The (national) account number of the customer.
bankCode
Link copied to clipboard
var bankCode: Int? = null
bank code of the customers bank, requires also parameter country_id.
bic
Link copied to clipboard
var bic: String? = null
BIC of the customer.
checkAmount
Link copied to clipboard
var checkAmount: Float? = null
The account balance amount to be checked against.
checkCurrencyId
Link copied to clipboard
var checkCurrencyId: CurrencyId? = null
Currency id of check_amount
countryId
Link copied to clipboard
var countryId: CountryId? = null
Two letter country code id, e.g.
easyOnboarding
Link copied to clipboard
var easyOnboarding: EasyOnboarding? = null
fintsProductId
Link copied to clipboard
var fintsProductId: String? = null
The fints product ID can be enclosed in the initial request.
iban
Link copied to clipboard
var iban: String? = null
IBAN of the customer.
language
Link copied to clipboard
var language: Language? = null
merchantId
Link copied to clipboard
var merchantId: String? = null
The internal ID of your merchant, if any.
metadata
Link copied to clipboard
var metadata: Map<String, Any>? = null
xs2aAccountCharacteristicsCheck
Link copied to clipboard
XS2A.account_characteristics_check allows you to retrieve many possible information about the account, like chargebacks, encashment, loans and other.
xs2aAccountLinkedOffersCheck
Link copied to clipboard
var xs2aAccountLinkedOffersCheck: Xs2aAccountLinkedOffersCheck? = null
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.
xs2aAccountSnapshot
Link copied to clipboard
var xs2aAccountSnapshot: Xs2aAccountSnapshot? = null
xs2aAccountStatusCheck
Link copied to clipboard
var xs2aAccountStatusCheck: Xs2aAccountStatusCheck? = null
xs2aAgeVerificationCheck
Link copied to clipboard
var xs2aAgeVerificationCheck: Xs2aAgeVerificationCheck? = null
xs2aAllAccountsCheck
Link copied to clipboard
var xs2aAllAccountsCheck: Xs2aAllAccountsCheck? = null
XS2A.standing_orders_check allows you to retrieve all standing orders from an account.
xs2aBalanceCheck
Link copied to clipboard
var xs2aBalanceCheck: Xs2aBalanceCheck? = null
xs2aBalanceOverview
Link copied to clipboard
var xs2aBalanceOverview: Xs2aBalanceOverview? = null
XS2A.balance_overview returns the current running total of the chosen account.
xs2aCashflowOverview
Link copied to clipboard
var xs2aCashflowOverview: Xs2aCashflowOverview? = null
XS2A.cashflow_overview provides an cashflow overview for the requested risk date range.
xs2aChargebackCheck
Link copied to clipboard
var xs2aChargebackCheck: Xs2aChargebackCheck? = null
XS2A.chargeback_check returns the number of detected chargeback transactions for the account.
xs2aChildrenCheck
Link copied to clipboard
var xs2aChildrenCheck: Xs2aChildrenCheck? = null
The XS2A.children_check gathers payments from governmental facilities, which indicate how many children the account has.
xs2aCreditCheck
Link copied to clipboard
var xs2aCreditCheck: Xs2aCreditCheck? = null
xs2aDirectDebitCheck
Link copied to clipboard
var xs2aDirectDebitCheck: Xs2aDirectDebitCheck? = null
xs2aFactSheetLists
Link copied to clipboard
var xs2aFactSheetLists: Xs2aFactSheetLists? = null
xs2aHolderIdentificationCheck
Link copied to clipboard
var xs2aHolderIdentificationCheck: Xs2aHolderIdentificationCheck? = null
xs2aIncomeCheck
Link copied to clipboard
var xs2aIncomeCheck: Xs2aIncomeCheck? = null
The Income Check provides an overview of the account holder's various types of income.
xs2aInsuranceContractCheck
Link copied to clipboard
var xs2aInsuranceContractCheck: Xs2aInsuranceContractCheck? = null
xs2aNameCheck
Link copied to clipboard
var xs2aNameCheck: Xs2aNameCheck? = null
xs2aOverdraftLimitCheck
Link copied to clipboard
var xs2aOverdraftLimitCheck: Xs2aOverdraftLimitCheck? = null
XS2A.overdraft_limit_check returns the number of booking days of the given risk range.
xs2aProfitLossCheck
Link copied to clipboard
var xs2aProfitLossCheck: Xs2aProfitLossCheck? = null
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.
xs2aRatingB2bCheck
Link copied to clipboard
var xs2aRatingB2bCheck: Xs2aRatingB2bCheck? = null
Produces a qualitative evaluation of a bank statement (business accounts) according to various criteria and summarizes these in a school grade system (A-F).
xs2aRatingB2cCheck
Link copied to clipboard
var xs2aRatingB2cCheck: Xs2aRatingB2cCheck? = null
Produces a qualitative evaluation of a bank statement (private accounts) according to various criteria and summarizes these in a school grade system (A-F).
xs2aRiskCalculationsCheck
Link copied to clipboard
var xs2aRiskCalculationsCheck: Xs2aRiskCalculationsCheck? = null
xs2aSeizureCheck
Link copied to clipboard
var xs2aSeizureCheck: Xs2aSeizureCheck? = null
xs2aStandingOrdersCheck
Link copied to clipboard
var xs2aStandingOrdersCheck: Xs2aStandingOrdersCheck? = null
XS2A.standing_orders_check allows you to retrieve all standing orders from an account.