# aforms ## General Information aforms is a company specializing in the creation and management of digital forms for e-government and e-business applications. With the AFS software, public authorities and businesses can create multilingual, accessible, and standards-compliant forms without any programming knowledge – whether online, on mobile devices, or in PDF format. ### Links * aforms [Website](https://www.aforms.com/) * [Form creation](https://www.aforms.com/en/produkte/designer-formserver) with aforms ## Integration The following guide outlines how to integrate Payrexx into the AFS Designer by aforms solutions & services. {% hint style="info" %} Please note that integration with aforms is only available in the Standard and Premium plans. [For more information](https://payrexx.com/en/prices) {% endhint %} ### Configuration of Payrexx {% hint style="info" %} Make sure you're [logged in](https://login.payrexx.com/) to your Payrexx account before you begin. If you don’t have a Payrexx account yet, you can [register](https://signup.payrexx.com/) now. {% endhint %} * Navigate to the **API and Plugins** section in the main menu of your merchant administration. * Scroll down to "Add API Integration" and click on "Add API Key":

Adding an API Key for integration with aforms

* Give the integration any name you prefer, such as "aforms". * Click on "Add":

* You will now find the new API Key under "Active Integrations." * Click on "Copy" to copy the API Key to your clipboard. You will need it in a later step:

Copying the API key to the clipboard for later use with aforms

### Configuration of aforms #### Form server property * In the AFS Designer, navigate to **Administration > Resources**:

Starting the configuration in the AFS Designer

* Search the resource list for a form server property or create a new one using the plus icon:

* Enter your properties and save with the check mark icon:

Examples Formserver Property: ``` # Payrexx-URLcom.anecon.afs.common.extender.payrexx.url= ``` First part (up to the first dot) of the Payrexx administration URL: ``` https://aforms2web.payment...com.anecon.afs.common.extender.payrexx.instanceId=xxx ``` Default API key from the Payrexx administration: ``` com.anecon.afs.common.extender.payrexx.secret=xxx ``` {% hint style="info" %} Replace 'xxx' with the API Key that you copied to your clipboard during the Payrexx configuration. {% endhint %} Currency: ``` com.anecon.afs.common.extender.payrexx.currency=xxx ``` #### Form, page, and block * Navigate to **Forms** and create a new form using the plus icon:

* Enter the form name, the general ID, and the description of the form:

* Create a new form page, fill in the corresponding fields, and save your settings:

* Create a new block within the created form page:

* Add the required fields to the newly created block:

* Automatically create the layout of the block by clicking the table icon, define the field names and placeholder texts for the layout, and save the block:

* This is what the created block looks like:

* Place the newly created block on the first page of the form:

* Save the page and form details by clicking the check mark icon. Form, page, and block are now ready for integration with Payrexx. #### Creating and configuring the extender {% hint style="info" %} With the Payrexx extender, you can offer form users the option to make a payment directly upon submission. Communication between AFS and Payrexx takes place via REST web services. This function is available at the form level. {% endhint %} * Create a new extender at the form level by clicking the plus icon:

* Select the "Form: Payrexx" option from the extender selection list:

Creating an extender of type "Form: Payrexx"

* Configure the extender according to your requirements and save it by clicking the check mark icon:

* Using the condition =#V1=="1" (SpeL expression), the extender will only be executed if the payment method "Credit Card" has been selected in the form:

Restricting extender execution to payment method "credit card"

* This is what the payment method selection looks like in the form:

{% hint style="info" %} Kindly note that the purchase on invoice payment method will always be shown. {% endhint %} * Fields can be assigned to the extender via the form tree:

**Usage of the Fields:** * **Payment Note:** The payment note consists of the reference ID and the form title and is used to identify the payment in the Inbox/APF. * **Reference ID:** The reference ID is a unique ID used to identify the payment. * **Amount:** Transaction amount * **First Name:** First name of the applicant * **Last Name**: Last name of the applicant * **Email Address for Payment Confirmation:** The invoice and payment confirmation will be sent to this email address. **Purpose of Use in the Invoice (Product Description):**

Invoice with purpose of use (product description)

#### Transfer form collection * By clicking the arrow icon, the form collection is transmitted to the form server and thus made available online:

Transmitting the form collection to the form server

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.payrexx.com/merchant/english/integration/business-software/aforms.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.