Xs2aDirectDebitCheckResponse

data class Xs2aDirectDebitCheckResponse(@Json(name = check_amountcheckAmount: Float, @Json(name = check_currency_idcheckCurrencyId: CurrencyId, @Json(name = start_datestartDate: LocalDate?, @Json(name = end_dateendDate: LocalDate?, @Json(name = recommendationrecommendation: String, @Json(name = recommendation_daterecommendationDate: LocalDate?, @Json(name = objectobject: String, @Json(name = created_atcreatedAt: LocalDateTime)

Parameters

checkAmount

Account balance amount to be checked against

checkCurrencyId

Currency id of check_amount, e.g. EUR

startDate

An optional field. The date format is \"YYYY-mm-dd\". If a start_date is given, the field \"end_date\" has to be set as well. The start date can be no earlier than the day after the transaction. In case the start date is invalid or not set, the earliest bank work day will be used.

endDate

An optional field. The date format is \"YYYY-mm-dd\". The end date has to be at lest 3 days after the start date and can be a maximum of 30 days into the future. If there is no end date given, the maximum of 30 days will be used.

recommendation

This field represents the response from our system. The values will either be ANY, DATE or REJECT. If ANY is returned, it should be save to execute the direct debit at any time. If DATE is returned, we suggest a date for executing the direct debit in the field recommendation_date. In case of a REJECT it is not recommended to execute a direct debit, because the amount is likely not be covered. For a REJECT the returned recommendation_date will always be \"0000-00-00\".

recommendationDate

If the recommendation is DATE, this will be the recommended time to execute a direct debit. In some cases, this date might be out of the start-/end-date range supplied (reasons might be holidays etc.). In case of REJECT this field will always be set as \"0000-00-00\".

object Object type, in this case a xs2a_direct_debit_check

createdAt

Creation date of the object

Constructors

Xs2aDirectDebitCheckResponse
Link copied to clipboard
fun Xs2aDirectDebitCheckResponse(@Json(name = check_amountcheckAmount: Float, @Json(name = check_currency_idcheckCurrencyId: CurrencyId, @Json(name = start_datestartDate: LocalDate? = null, @Json(name = end_dateendDate: LocalDate? = null, @Json(name = recommendationrecommendation: String, @Json(name = recommendation_daterecommendationDate: LocalDate? = null, @Json(name = objectobject: String, @Json(name = created_atcreatedAt: LocalDateTime)
Account balance amount to be checked against

Properties

checkAmount
Link copied to clipboard
var checkAmount: Float
Account balance amount to be checked against
checkCurrencyId
Link copied to clipboard
var checkCurrencyId: CurrencyId
Currency id of check_amount, e.g.
createdAt
Link copied to clipboard
var createdAt: LocalDateTime
Creation date of the object
endDate
Link copied to clipboard
var endDate: LocalDate? = null
An optional field.
object
Link copied to clipboard
var object: String
recommendation
Link copied to clipboard
var recommendation: String
This field represents the response from our system.
recommendationDate
Link copied to clipboard
var recommendationDate: LocalDate? = null
If the recommendation is DATE, this will be the recommended time to execute a direct debit.
startDate
Link copied to clipboard
var startDate: LocalDate? = null
An optional field.