Skip to content

Latest commit

 

History

History
354 lines (197 loc) · 15.2 KB

Functionality.md

File metadata and controls

354 lines (197 loc) · 15.2 KB

Functionality

Properties

Name Type Description Notes
ProgressBar Pointer to NullableString Whether a progress bar is shown on the web form, letting the user know on which step he is.<br/>&bull; <code>RENDER</code> - the progress bar will be shown;<br/>&bull; <code>HIDDEN</code> - the progress bar will NOT be shown.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>RENDER</code>. [optional]
BankLoginHint Pointer to NullableString How the bank login hint will be shown to the end user<br/>&bull; <code>EXPANDED</code> - the user will see the login hint and will have the option to collapse it;<br/>&bull; <code>COLLAPSED</code> - the login hint will be collapsed and the user can see it if he expands the field;<br/>&bull; <code>HIDDEN</code> - the login hint is hidden and the user cannot see it.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>EXPANDED</code>. [optional]
StoreSecrets Pointer to NullableString Whether the user will have a checkbox to ask for storing login secrets (like a PIN) in finAPI or not.<br/>&bull; <code>RENDER</code> - the checkbox will be shown;<br/>&bull; <code>HIDDEN</code> - the checkbox will NOT be shown;<br/>&bull; <code>MANDATORY</code> - the checkbox will be shown and it will be mandatory for the end user to check it in order to continue.<br/>&bull; <code>IMPLICIT_APPROVAL</code> - the checkbox will NOT be shown but login secrets will nevertheless be stored;<br/>&nbsp;&nbsp;&nbsp;&nbsp;<strong>NOTE:</strong> This value will also automatically store the TAN method. This value can be applied ONLY by our support team. Please contact <a href='mailto:support@finapi.io'>support@finapi.io</a> with the <code>profile.id</code> as soon as you have finalized the customization for other parameters.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>RENDER</code>. [optional]
BankDetails Pointer to NullableString Whether the user will be allowed to change the selected bank, in case a BLZ/BIC/IBAN was sent in the API request by the client.<br/>&bull; <code>LOCKED</code> - the user will be directly routed to login to the pre-selected bank;<br/>&bull; <code>EDITABLE</code> - the user will see the pre-selected bank and have the option to change it.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>LOCKED</code>. [optional]
Header Pointer to NullableString Whether the header will be displayed on the web form.<br/>&bull; <code>RENDER</code> - the header will be shown;<br/>&bull; <code>HIDDEN</code> - the header will NOT be shown.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>RENDER</code>. [optional]
Language Pointer to NullableLanguage [optional]
SkipConfirmationView Pointer to NullableBool When the web form is completed successfully, it determines whether the last view will be rendered. It applies to embedded and standalone web forms. It also applies to all endpoints in the &quot;Account Information Services&quot; and &quot;Payment Initiation Services&quot;.<br/>If you are embedding the web form in your application, please set up appropriate handling for the 'onComplete' method to take advantage of the feature.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>false</code> [optional]
RenderAccountSelectionView Pointer to NullableBool Whether or not the Web Form will render the &quot;Account Selection View&quot; for the end-user to choose which of the imported accounts should be saved to the database and available on the customer application.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>false</code> [optional]
HidePaymentSummary Pointer to NullableBool Whether the entire payment summary is rendered on the Web Form. When set to TRUE, the counterpart data is not rendered on the Payment Summary of the Web Form.<br/><strong>NOTE:</strong> This value can be applied ONLY by our support team. Please contact <a href='mailto:support@finapi.io'>support@finapi.io</a> with the <code>profile.id</code> as soon as you have finalized the customization for other parameters.<br/><strong>NOTE:</strong> If no value is provided, then the following value will be applied by default when web form is opened: <code>false</code> [optional]

Methods

NewFunctionality

func NewFunctionality() *Functionality

NewFunctionality instantiates a new Functionality object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewFunctionalityWithDefaults

func NewFunctionalityWithDefaults() *Functionality

NewFunctionalityWithDefaults instantiates a new Functionality object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetProgressBar

func (o *Functionality) GetProgressBar() string

GetProgressBar returns the ProgressBar field if non-nil, zero value otherwise.

GetProgressBarOk

func (o *Functionality) GetProgressBarOk() (*string, bool)

GetProgressBarOk returns a tuple with the ProgressBar field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProgressBar

func (o *Functionality) SetProgressBar(v string)

SetProgressBar sets ProgressBar field to given value.

HasProgressBar

func (o *Functionality) HasProgressBar() bool

HasProgressBar returns a boolean if a field has been set.

SetProgressBarNil

func (o *Functionality) SetProgressBarNil(b bool)

SetProgressBarNil sets the value for ProgressBar to be an explicit nil

UnsetProgressBar

func (o *Functionality) UnsetProgressBar()

UnsetProgressBar ensures that no value is present for ProgressBar, not even an explicit nil

GetBankLoginHint

func (o *Functionality) GetBankLoginHint() string

GetBankLoginHint returns the BankLoginHint field if non-nil, zero value otherwise.

GetBankLoginHintOk

func (o *Functionality) GetBankLoginHintOk() (*string, bool)

GetBankLoginHintOk returns a tuple with the BankLoginHint field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBankLoginHint

func (o *Functionality) SetBankLoginHint(v string)

SetBankLoginHint sets BankLoginHint field to given value.

HasBankLoginHint

func (o *Functionality) HasBankLoginHint() bool

HasBankLoginHint returns a boolean if a field has been set.

SetBankLoginHintNil

func (o *Functionality) SetBankLoginHintNil(b bool)

SetBankLoginHintNil sets the value for BankLoginHint to be an explicit nil

UnsetBankLoginHint

func (o *Functionality) UnsetBankLoginHint()

UnsetBankLoginHint ensures that no value is present for BankLoginHint, not even an explicit nil

GetStoreSecrets

func (o *Functionality) GetStoreSecrets() string

GetStoreSecrets returns the StoreSecrets field if non-nil, zero value otherwise.

GetStoreSecretsOk

func (o *Functionality) GetStoreSecretsOk() (*string, bool)

GetStoreSecretsOk returns a tuple with the StoreSecrets field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStoreSecrets

func (o *Functionality) SetStoreSecrets(v string)

SetStoreSecrets sets StoreSecrets field to given value.

HasStoreSecrets

func (o *Functionality) HasStoreSecrets() bool

HasStoreSecrets returns a boolean if a field has been set.

SetStoreSecretsNil

func (o *Functionality) SetStoreSecretsNil(b bool)

SetStoreSecretsNil sets the value for StoreSecrets to be an explicit nil

UnsetStoreSecrets

func (o *Functionality) UnsetStoreSecrets()

UnsetStoreSecrets ensures that no value is present for StoreSecrets, not even an explicit nil

GetBankDetails

func (o *Functionality) GetBankDetails() string

GetBankDetails returns the BankDetails field if non-nil, zero value otherwise.

GetBankDetailsOk

func (o *Functionality) GetBankDetailsOk() (*string, bool)

GetBankDetailsOk returns a tuple with the BankDetails field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBankDetails

func (o *Functionality) SetBankDetails(v string)

SetBankDetails sets BankDetails field to given value.

HasBankDetails

func (o *Functionality) HasBankDetails() bool

HasBankDetails returns a boolean if a field has been set.

SetBankDetailsNil

func (o *Functionality) SetBankDetailsNil(b bool)

SetBankDetailsNil sets the value for BankDetails to be an explicit nil

UnsetBankDetails

func (o *Functionality) UnsetBankDetails()

UnsetBankDetails ensures that no value is present for BankDetails, not even an explicit nil

GetHeader

func (o *Functionality) GetHeader() string

GetHeader returns the Header field if non-nil, zero value otherwise.

GetHeaderOk

func (o *Functionality) GetHeaderOk() (*string, bool)

GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHeader

func (o *Functionality) SetHeader(v string)

SetHeader sets Header field to given value.

HasHeader

func (o *Functionality) HasHeader() bool

HasHeader returns a boolean if a field has been set.

SetHeaderNil

func (o *Functionality) SetHeaderNil(b bool)

SetHeaderNil sets the value for Header to be an explicit nil

UnsetHeader

func (o *Functionality) UnsetHeader()

UnsetHeader ensures that no value is present for Header, not even an explicit nil

GetLanguage

func (o *Functionality) GetLanguage() Language

GetLanguage returns the Language field if non-nil, zero value otherwise.

GetLanguageOk

func (o *Functionality) GetLanguageOk() (*Language, bool)

GetLanguageOk returns a tuple with the Language field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLanguage

func (o *Functionality) SetLanguage(v Language)

SetLanguage sets Language field to given value.

HasLanguage

func (o *Functionality) HasLanguage() bool

HasLanguage returns a boolean if a field has been set.

SetLanguageNil

func (o *Functionality) SetLanguageNil(b bool)

SetLanguageNil sets the value for Language to be an explicit nil

UnsetLanguage

func (o *Functionality) UnsetLanguage()

UnsetLanguage ensures that no value is present for Language, not even an explicit nil

GetSkipConfirmationView

func (o *Functionality) GetSkipConfirmationView() bool

GetSkipConfirmationView returns the SkipConfirmationView field if non-nil, zero value otherwise.

GetSkipConfirmationViewOk

func (o *Functionality) GetSkipConfirmationViewOk() (*bool, bool)

GetSkipConfirmationViewOk returns a tuple with the SkipConfirmationView field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSkipConfirmationView

func (o *Functionality) SetSkipConfirmationView(v bool)

SetSkipConfirmationView sets SkipConfirmationView field to given value.

HasSkipConfirmationView

func (o *Functionality) HasSkipConfirmationView() bool

HasSkipConfirmationView returns a boolean if a field has been set.

SetSkipConfirmationViewNil

func (o *Functionality) SetSkipConfirmationViewNil(b bool)

SetSkipConfirmationViewNil sets the value for SkipConfirmationView to be an explicit nil

UnsetSkipConfirmationView

func (o *Functionality) UnsetSkipConfirmationView()

UnsetSkipConfirmationView ensures that no value is present for SkipConfirmationView, not even an explicit nil

GetRenderAccountSelectionView

func (o *Functionality) GetRenderAccountSelectionView() bool

GetRenderAccountSelectionView returns the RenderAccountSelectionView field if non-nil, zero value otherwise.

GetRenderAccountSelectionViewOk

func (o *Functionality) GetRenderAccountSelectionViewOk() (*bool, bool)

GetRenderAccountSelectionViewOk returns a tuple with the RenderAccountSelectionView field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRenderAccountSelectionView

func (o *Functionality) SetRenderAccountSelectionView(v bool)

SetRenderAccountSelectionView sets RenderAccountSelectionView field to given value.

HasRenderAccountSelectionView

func (o *Functionality) HasRenderAccountSelectionView() bool

HasRenderAccountSelectionView returns a boolean if a field has been set.

SetRenderAccountSelectionViewNil

func (o *Functionality) SetRenderAccountSelectionViewNil(b bool)

SetRenderAccountSelectionViewNil sets the value for RenderAccountSelectionView to be an explicit nil

UnsetRenderAccountSelectionView

func (o *Functionality) UnsetRenderAccountSelectionView()

UnsetRenderAccountSelectionView ensures that no value is present for RenderAccountSelectionView, not even an explicit nil

GetHidePaymentSummary

func (o *Functionality) GetHidePaymentSummary() bool

GetHidePaymentSummary returns the HidePaymentSummary field if non-nil, zero value otherwise.

GetHidePaymentSummaryOk

func (o *Functionality) GetHidePaymentSummaryOk() (*bool, bool)

GetHidePaymentSummaryOk returns a tuple with the HidePaymentSummary field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHidePaymentSummary

func (o *Functionality) SetHidePaymentSummary(v bool)

SetHidePaymentSummary sets HidePaymentSummary field to given value.

HasHidePaymentSummary

func (o *Functionality) HasHidePaymentSummary() bool

HasHidePaymentSummary returns a boolean if a field has been set.

SetHidePaymentSummaryNil

func (o *Functionality) SetHidePaymentSummaryNil(b bool)

SetHidePaymentSummaryNil sets the value for HidePaymentSummary to be an explicit nil

UnsetHidePaymentSummary

func (o *Functionality) UnsetHidePaymentSummary()

UnsetHidePaymentSummary ensures that no value is present for HidePaymentSummary, not even an explicit nil

[Back to Model list] [Back to API list] [Back to README]