Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Xs2aDirectDebitCheckResponse

export
interface

Xs2aDirectDebitCheckResponse

Hierarchy

  • Xs2aDirectDebitCheckResponse

Index

Properties

check_amount

check_amount: number

Account balance amount to be checked against

memberof

Xs2aDirectDebitCheckResponse

Optional check_currency_id

check_currency_id: Currency

Currency id of check_amount, e.g. EUR

memberof

Xs2aDirectDebitCheckResponse

created_at

created_at: string

Creation date of the object

memberof

Xs2aDirectDebitCheckResponse

Optional end_date

end_date: undefined | string

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.

memberof

Xs2aDirectDebitCheckResponse

object

object: "xs2a_direct_debit_check"

Object type, in this case xs2a_direct_debit_check

memberof

Xs2aDirectDebitCheckResponse

recommendation

recommendation: string

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

memberof

Xs2aDirectDebitCheckResponse

Optional recommendation_date

recommendation_date: undefined | string

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

memberof

Xs2aDirectDebitCheckResponse

Optional start_date

start_date: undefined | string

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.

memberof

Xs2aDirectDebitCheckResponse

Generated using TypeDoc