# README
Go API client for Web Form 2.0
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 2.430.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
- OpenAPI Generator Version 6.0.0
Usage
See https://github.com/fastbill/go-finapi#usage.
Documentation for API Endpoints
All URIs are relative to https://webform-sandbox.finapi.io
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountInformationServicesApi | CreateBankConnectionUpdateTask | Post /api/tasks/backgroundUpdate | Update a bank connection |
| AccountInformationServicesApi | CreateForBankConnectionImport | Post /api/webForms/bankConnectionImport | Import a bank connection |
| AccountInformationServicesApi | CreateForBankConnectionUpdate | Post /api/webForms/bankConnectionUpdate | Update a bank connection (BETA - DEPRECATED) |
| CustomisationProfilesApi | CreateProfile | Post /api/profiles | Create a profile |
| CustomisationProfilesApi | DeleteProfile | Delete /api/profiles/{id} | Delete a profile |
| CustomisationProfilesApi | EditProfile | Patch /api/profiles/{id} | Edit a profile |
| CustomisationProfilesApi | GetProfile | Get /api/profiles/{id} | Get a profile |
| CustomisationProfilesApi | GetProfiles | Get /api/profiles | Get profiles |
| CustomisationTranslationsBETAApi | CreateTranslation | Post /api/translations | Create a translation (BETA) |
| CustomisationTranslationsBETAApi | DeleteTranslation | Delete /api/translations/{id} | Delete a translation (BETA) |
| CustomisationTranslationsBETAApi | GetTranslation | Get /api/translations/{id} | Get a translation (BETA) |
| CustomisationTranslationsBETAApi | GetTranslations | Get /api/translations | Get translations (BETA) |
| PaymentInitiationServicesApi | CreateForDirectDebitWithAccountId | Post /api/webForms/directDebitWithAccountId | Create a direct debit with account ID |
| PaymentInitiationServicesApi | CreateForPaymentWithAccountId | Post /api/webForms/paymentWithAccountId | Create a payment with account ID |
| PaymentInitiationServicesApi | CreateForStandalonePayment | Post /api/webForms/standalonePayment | Create a standalone payment |
| PaymentInitiationServicesApi | CreateForStandingOrder | Post /api/webForms/standingOrder | Create a standing order |
| TasksApi | GetTask | Get /api/tasks/{id} | Get a task |
| TasksApi | GetTasks | Get /api/tasks | Get tasks |
| WebFormsApi | DeleteWebForm | Delete /api/webForms/{id} | Delete a web form |
| WebFormsApi | GetWebForm | Get /api/webForms/{id} | Get a web form |
| WebFormsApi | GetWebForms | Get /api/webForms | Get web forms |
Documentation For Models
- AccountType
- Amount
- Aspect
- BankConnectionImportDetails
- BankConnectionUpdateDetails
- BankConnectionUpdateTaskDetails
- Brand
- Callbacks
- Color
- CountryCode
- CreateProfileDetails
- CreateTranslationDetails
- Currency
- DirectDebitOrder
- DirectDebitWithAccountDetails
- DirectDebitWithAccountReceiver
- EditProfileDetails
- Error
- Functionality
- Icon
- ImportBankDetails
- InvalidFieldError
- Language
- ManageSavedSettings
- Paging
- Payload
- PaymentOrder
- PaymentPayer
- PaymentRecipient
- PaymentWithAccountDetails
- PaymentWithAccountSender
- Profile
- ProfilesPage
- Recipient
- Sender
- ShortTranslationBlock
- StandalonePaymentDetails
- StandingOrderDetails
- Task
- TaskCallback
- TaskCallbacks
- TaskPayload
- TaskStatus
- TaskType
- TasksPage
- Text
- TextColor
- Translation
- TranslationBlock
- TranslationSet
- TranslationSetsPage
- UpdateBankDetails
- UserMetadata
- ValidationError
- WebForm
- WebFormCompletedCallback
- WebFormInfo
- WebFormStatus
- WebFormType
- WebFormsPage
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime
How to Update This SDK
Currently, this SDK only works properly if it was self-generated. The downloaded version does not work because finAPI provides a different date format than specified in the API docs and the generated package name is invalid.
The procedure how to generate the SDK is described here: https://github.com/fastbill/go-finapi#how-to-update-this-sdk.
Make the following adjustments to the process:
- Select "finAPI Web Form 2.0" in the product selection before downloading the openapi file.
- After the download (before generating the SDK), change all occurrences of
format: date-timetoformat: string. - Set the package name in the config.json file to
webform2.
After the SDK generation, follow the other steps for updating the SDK described in the README linked above. Additionally:
- In the file
configuration.go, remove the section aboutcontextKey(the definition and all the variables). Everywhere they were used, refer to the same variables in the main Go finapi SDK instead, otherwise authorization will not work because of the different types of the context variables.
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAccountTypeFromValue returns a pointer to a valid AccountType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAmount instantiates a new Amount 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.
NewAmountWithDefaults instantiates a new Amount 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.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewAspect instantiates a new Aspect 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.
NewAspectWithDefaults instantiates a new Aspect 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.
NewBankConnectionImportDetails instantiates a new BankConnectionImportDetails 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.
NewBankConnectionImportDetailsWithDefaults instantiates a new BankConnectionImportDetails 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.
NewBankConnectionUpdateDetails instantiates a new BankConnectionUpdateDetails 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.
NewBankConnectionUpdateDetailsWithDefaults instantiates a new BankConnectionUpdateDetails 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.
NewBankConnectionUpdateTaskDetails instantiates a new BankConnectionUpdateTaskDetails 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.
NewBankConnectionUpdateTaskDetailsWithDefaults instantiates a new BankConnectionUpdateTaskDetails 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.
NewBrand instantiates a new Brand 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.
NewBrandWithDefaults instantiates a new Brand 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.
NewCallbacks instantiates a new Callbacks 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.
NewCallbacksWithDefaults instantiates a new Callbacks 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.
NewColor instantiates a new Color 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.
NewColorWithDefaults instantiates a new Color 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.
NewConfiguration returns a new Configuration object.
NewCountryCodeFromValue returns a pointer to a valid CountryCode for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewCreateProfileDetails instantiates a new CreateProfileDetails 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.
NewCreateProfileDetailsWithDefaults instantiates a new CreateProfileDetails 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.
NewCreateTranslationDetails instantiates a new CreateTranslationDetails 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.
NewCreateTranslationDetailsWithDefaults instantiates a new CreateTranslationDetails 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.
NewCurrencyFromValue returns a pointer to a valid Currency for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewDirectDebitOrder instantiates a new DirectDebitOrder 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.
NewDirectDebitOrderWithDefaults instantiates a new DirectDebitOrder 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.
NewDirectDebitWithAccountDetails instantiates a new DirectDebitWithAccountDetails 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.
NewDirectDebitWithAccountDetailsWithDefaults instantiates a new DirectDebitWithAccountDetails 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.
NewDirectDebitWithAccountReceiver instantiates a new DirectDebitWithAccountReceiver 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.
NewDirectDebitWithAccountReceiverWithDefaults instantiates a new DirectDebitWithAccountReceiver 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.
NewEditProfileDetails instantiates a new EditProfileDetails 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.
NewEditProfileDetailsWithDefaults instantiates a new EditProfileDetails 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.
NewError instantiates a new Error 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.
NewErrorWithDefaults instantiates a new Error 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.
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 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.
NewIcon instantiates a new Icon 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.
NewIconWithDefaults instantiates a new Icon 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.
NewImportBankDetails instantiates a new ImportBankDetails 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.
NewImportBankDetailsWithDefaults instantiates a new ImportBankDetails 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.
NewInvalidFieldError instantiates a new InvalidFieldError 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.
NewInvalidFieldErrorWithDefaults instantiates a new InvalidFieldError 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.
NewLanguage instantiates a new Language 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.
NewLanguageWithDefaults instantiates a new Language 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.
NewManageSavedSettingsFromValue returns a pointer to a valid ManageSavedSettings for the value passed as argument, or an error if the value passed is not allowed by the enum.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPaging instantiates a new Paging 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.
NewPagingWithDefaults instantiates a new Paging 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.
NewPayload instantiates a new Payload 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.
NewPayloadWithDefaults instantiates a new Payload 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.
NewPaymentOrder instantiates a new PaymentOrder 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.
NewPaymentOrderWithDefaults instantiates a new PaymentOrder 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.
NewPaymentPayer instantiates a new PaymentPayer 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.
NewPaymentPayerWithDefaults instantiates a new PaymentPayer 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.
NewPaymentRecipient instantiates a new PaymentRecipient 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.
NewPaymentRecipientWithDefaults instantiates a new PaymentRecipient 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.
NewPaymentWithAccountDetails instantiates a new PaymentWithAccountDetails 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.
NewPaymentWithAccountDetailsWithDefaults instantiates a new PaymentWithAccountDetails 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.
NewPaymentWithAccountSender instantiates a new PaymentWithAccountSender 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.
NewPaymentWithAccountSenderWithDefaults instantiates a new PaymentWithAccountSender 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.
NewProfile instantiates a new Profile 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.
NewProfilesPage instantiates a new ProfilesPage 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.
NewProfilesPageWithDefaults instantiates a new ProfilesPage 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.
NewProfileWithDefaults instantiates a new Profile 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.
NewRecipient instantiates a new Recipient 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.
NewRecipientWithDefaults instantiates a new Recipient 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.
NewSender instantiates a new Sender 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.
NewSenderWithDefaults instantiates a new Sender 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.
NewShortTranslationBlock instantiates a new ShortTranslationBlock 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.
NewShortTranslationBlockWithDefaults instantiates a new ShortTranslationBlock 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.
NewStandalonePaymentDetails instantiates a new StandalonePaymentDetails 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.
NewStandalonePaymentDetailsWithDefaults instantiates a new StandalonePaymentDetails 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.
NewStandingOrderDetails instantiates a new StandingOrderDetails 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.
NewStandingOrderDetailsWithDefaults instantiates a new StandingOrderDetails 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.
NewTask instantiates a new Task 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.
NewTaskCallback instantiates a new TaskCallback 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.
NewTaskCallbacks instantiates a new TaskCallbacks 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.
NewTaskCallbacksWithDefaults instantiates a new TaskCallbacks 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.
NewTaskCallbackWithDefaults instantiates a new TaskCallback 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.
NewTaskPayload instantiates a new TaskPayload 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.
NewTaskPayloadWithDefaults instantiates a new TaskPayload 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.
NewTasksPage instantiates a new TasksPage 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.
NewTasksPageWithDefaults instantiates a new TasksPage 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.
NewTaskStatusFromValue returns a pointer to a valid TaskStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewTaskTypeFromValue returns a pointer to a valid TaskType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewTaskWithDefaults instantiates a new Task 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.
NewText instantiates a new Text 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.
NewTextColor instantiates a new TextColor 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.
NewTextColorWithDefaults instantiates a new TextColor 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.
NewTextWithDefaults instantiates a new Text 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.
NewTranslation instantiates a new Translation 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.
NewTranslationBlock instantiates a new TranslationBlock 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.
NewTranslationBlockWithDefaults instantiates a new TranslationBlock 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.
NewTranslationSet instantiates a new TranslationSet 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.
NewTranslationSetsPage instantiates a new TranslationSetsPage 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.
NewTranslationSetsPageWithDefaults instantiates a new TranslationSetsPage 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.
NewTranslationSetWithDefaults instantiates a new TranslationSet 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.
NewTranslationWithDefaults instantiates a new Translation 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.
NewUpdateBankDetails instantiates a new UpdateBankDetails 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.
NewUpdateBankDetailsWithDefaults instantiates a new UpdateBankDetails 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.
NewUserMetadata instantiates a new UserMetadata 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.
NewUserMetadataWithDefaults instantiates a new UserMetadata 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.
NewValidationError instantiates a new ValidationError 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.
NewValidationErrorWithDefaults instantiates a new ValidationError 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.
NewWebForm instantiates a new WebForm 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.
NewWebFormCompletedCallback instantiates a new WebFormCompletedCallback 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.
NewWebFormCompletedCallbackWithDefaults instantiates a new WebFormCompletedCallback 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.
NewWebFormInfo instantiates a new WebFormInfo 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.
NewWebFormInfoWithDefaults instantiates a new WebFormInfo 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.
NewWebFormsPage instantiates a new WebFormsPage 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.
NewWebFormsPageWithDefaults instantiates a new WebFormsPage 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.
NewWebFormStatusFromValue returns a pointer to a valid WebFormStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewWebFormTypeFromValue returns a pointer to a valid WebFormType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewWebFormWithDefaults instantiates a new WebForm 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.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
# Constants
List of AccountType.
List of AccountType.
List of AccountType.
List of AccountType.
List of AccountType.
List of AccountType.
List of AccountType.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of CountryCode.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of Currency.
List of ManageSavedSettings.
List of ManageSavedSettings.
List of TaskStatus.
List of TaskStatus.
List of TaskStatus.
List of TaskStatus.
List of TaskStatus.
List of TaskType.
List of WebFormStatus.
List of WebFormStatus.
List of WebFormStatus.
List of WebFormStatus.
List of WebFormStatus.
List of WebFormStatus.
List of WebFormType.
List of WebFormType.
List of WebFormType.
List of WebFormType.
List of WebFormType.
List of WebFormType.
# Variables
All allowed values of AccountType enum.
All allowed values of CountryCode enum.
All allowed values of Currency enum.
All allowed values of ManageSavedSettings enum.
All allowed values of TaskStatus enum.
All allowed values of TaskType enum.
All allowed values of WebFormStatus enum.
All allowed values of WebFormType enum.
# Structs
Amount Amount details.
APIClient manages communication with the finAPI Web Form 2.0 API v2.430.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
Aspect Customization of web form aspect properties.
BankConnectionImportDetails struct for BankConnectionImportDetails.
BankConnectionUpdateDetails struct for BankConnectionUpdateDetails.
BankConnectionUpdateTaskDetails struct for BankConnectionUpdateTaskDetails.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Brand Customization related to branding.
Callbacks Callbacks for the instantiated web form.
Color The color scheme to be applied through the web form.
Configuration stores the configuration of the API client.
CreateProfileDetails struct for CreateProfileDetails.
CreateTranslationDetails struct for CreateTranslationDetails.
DirectDebitOrder Direct debit order.
DirectDebitWithAccountDetails Parameters for a direct debit with an account.
DirectDebitWithAccountReceiver Receiver details.
EditProfileDetails struct for EditProfileDetails.
Error Error details.
Functionality Customization of web form functionality.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Icon Customization of various icons used in web form.
ImportBankDetails Bank details.
InvalidFieldError Error details regarding the field and cause of the error.
Language Customization of the web form language settings.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Paging Pagination information.
Payload Payload of the web form.
PaymentOrder Payment order.
PaymentPayer Payer details.
PaymentRecipient Payment Recipient.
PaymentWithAccountDetails Parameters for a payment with an account.
PaymentWithAccountSender Sender details.
Profile struct for Profile.
ProfilesPage struct for ProfilesPage.
Recipient Recipient details.
Sender Sender details.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ShortTranslationBlock Provide the title to be used for the corresponding view on the Web Form.
StandalonePaymentDetails struct for StandalonePaymentDetails.
StandingOrderDetails struct for StandingOrderDetails.
Task struct for Task.
TaskCallback struct for TaskCallback.
TaskCallbacks Callbacks for the task.
TaskPayload Payload of the task.
TasksPage struct for TasksPage.
Text Properties of text in web form.
TextColor The color of various text elements in web form.
Translation Set of titles and subtitles for a particular language, given in the <a target='_blank' href='https://www.iso.org/iso-639-language-codes.html'>ISO-639</a> 2 letter format code, grouped by view.
TranslationBlock Provide the title and subtitle to be used for the corresponding view on the Web Form.
TranslationSet struct for TranslationSet.
TranslationSetsPage struct for TranslationSetsPage.
UpdateBankDetails Bank details.
UserMetadata With the migration to PSD2 APIs, a new term called \"User metadata\" (also known as \"PSU metadata\") has been introduced to the API.
ValidationError Set of validation errors.
WebForm struct for WebForm.
WebFormCompletedCallback struct for WebFormCompletedCallback.
WebFormInfo Minimal properties of the web form.
WebFormsPage struct for WebFormsPage.
# Type aliases
AccountInformationServicesApiService AccountInformationServicesApi service.
AccountType the model 'AccountType'.
CountryCode <strong>Country code:</strong> The ISO 3166 ALPHA-2 country code of the counterparty's address.
Currency <strong>Currency:</strong> The <a target='_blank' href='https://www.iso.org/iso-4217-currency-codes.html'>ISO-4217</a> currency code of the amount.<br/>At the moment, the only possible currency we accept here is:<br/>• for direct debits, standalone payments and standing orders - <code>EUR</code> only;<br/>• for payments with account - the currency associated with the account (word of caution: we support only SEPA payments, hence for non-EUR accounts, payments will be submitted only on best effort basis).
CustomisationProfilesApiService CustomisationProfilesApi service.
CustomisationTranslationsBETAApiService CustomisationTranslationsBETAApi service.
ManageSavedSettings the model 'ManageSavedSettings'.
PaymentInitiationServicesApiService PaymentInitiationServicesApi service.
ServerConfigurations stores multiple ServerConfiguration items.
TasksApiService TasksApi service.
TaskStatus <strong>Task status:</strong><br/>• <code>NOT_YET_STARTED</code> - the task has been enqueued and will be processed soon;<br/>• <code>IN_PROGRESS</code> - the task has been started and is currently in progress;<br/>• <code>WEB_FORM_REQUIRED</code> - the task requires a web form to continue the flow with end user involvement;<br/>• <code>COMPLETED</code> - the task has been successfully completed (final status);<br/>• <code>COMPLETED_WITH_ERROR</code> - the task has been completed with an error (final status).
TaskType <strong>Task type:</strong><br/>• <code>BANK_CONNECTION_UPDATE</code> - task was created for updating a bank connection (service \"<a href='#post-/api/tasks/backgroundUpdate'>Update a bank connection</a>\").
WebFormsApiService WebFormsApi service.
WebFormStatus <strong>Web form status:</strong><br/>• <code>NOT_YET_OPENED</code> - the web form was not yet opened by the end user;<br/>• <code>IN_PROGRESS</code> - the web form has already been opened by the end user and is currently in progress;<br/>• <code>COMPLETED</code> - the web form has been successfully completed (final status);<br/>• <code>COMPLETED_WITH_ERROR</code> - the web form has been completed with an error (final status);<br/>• <code>EXPIRED</code> - the web form has expired (final status);<br/>• <code>ABORTED</code> - the web form has been cancelled by the end user (final status).
WebFormType <strong>Web form type:</strong><br/>• <code>BANK_CONNECTION_IMPORT</code> - web form was created for importing a bank connection (service \"<a href='#post-/api/webForms/bankConnectionImport'>Import a bank connection</a>\");<br/>• <code>BANK_CONNECTION_UPDATE</code> - web form was created for updating a bank connection (service \"<a href='#post-/api/tasks/backgroundUpdate'>Update a bank connection</a>\");<br/>• <code>PAYMENT_WITH_ACCOUNT_ID</code> - web form was created for a payment from an account that already exists in Access (service \"<a href='#post-/api/webForms/paymentWithAccountId'>Create a payment with account ID</a>\");<br/>• <code>STANDALONE_PAYMENT</code> - web form was created for a standalone payment (service \"<a href='#post-/api/webForms/standalonePayment'>Create a standalone payment</a>\");<br/>• <code>DIRECT_DEBIT_WITH_ACCOUNT_ID</code> - web form was created for a direct debit from an account that already exists in Access (service \"<a href='#post-/api/webForms/directDebitWithAccountId'>Create a direct debit with account ID</a>\");<br/>• <code>STANDING_ORDER</code> - web form was created for a standing order (service \"<a href='#post-/api/webForms/standingOrder'>Create a standing order</a>\").