Customizing the Acceptance Devices App {#sis-ad-app-customize-intro} ==================================================================== Use this information to customize the Acceptance Devices app in the `Business Center` or by using a REST API request. The Acceptance Devices Customizations feature in the `Business Center` enables you to customize these parameters for a portfolio, merchant, or transacting merchant ID (MID): * User interface * Common * Local mode * Standalone mode {#sis-ad-app-customize-intro_ul_ups_rql_fgc} You can use a REST API request to perform these customization tasks: * Retrieve and review your current parameter customization settings. * Update customization settings for user interface, common, Local mode, and Standalone mode parameters. {#sis-ad-app-customize-intro_ul_nms_mtz_1bc} Customizable User Interface Parameters {#sis-ad-app-customize-ui} ================================================================= You can customize these user interface parameters for the Acceptance Devices app when it is in Local, Standalone, or Cloud mode. Home screen logo : This parameter defines the logo that is shown on the home screen of the app. Toolbar logo : This parameter defines the logo that is shown on the app screen during transaction processing. Primary color : This parameter defines the color of the primary buttons. Color on primary : This parameter defines the color of the text on the primary buttons. Background color : This parameter defines the color of the screen background. Color on background : This parameter defines the color of the text on the screen background. Button shape : This parameter defines the shape of the buttons. Customizable Common Parameters {#sis-ad-app-customize-common} ============================================================= You can customize these common parameters in the Acceptance Devices app when it is operating in Local, Standalone, or Cloud mode. Operating mode : This parameter enables you to choose one of these operating modes: * `Semi-Integrated with Standalone:` The Acceptance Devices app operates in Local and Standalone modes. This setting is the default. * `Semi-Integrated:` The Acceptance Devices app operates in Local mode only. * `Standalone:` The Acceptance Devices app operates in Standalone mode only. * `Cloud with Standalone:` The Acceptance Devices app operates in Cloud and Standalone modes. * `Cloud:` The Acceptance Devices app operates in Cloud mode only. Automatic receipt printing : This parameter enables the automatic printing of the merchant or customer receipt after each transaction. This feature is available only on terminals with integrated printers. The default setting is `Disabled`. Accessibility options : This parameter enables accessibility features during transaction processing. For example, voice-over capabilities that provide information to visually impaired customers. The default setting is `True`. Enable Offline mode : This parameter enables Offline mode, which you can use to process transactions when an internet connection is not available. The default setting is `False`. MOTO options : This parameter enables you to activate these MOTO options: * `MOTO address required:` This parameter enables the customer's address as a required data input for mail order or telephone order (MOTO) transactions. The default setting is `True`. * `MOTO show confirmation screen:` This parameter enables a Confirmation screen to appear during MOTO transactions. The merchant reviews and confirms the MOTO address data shown on the screen before the payment is processed. The default setting is `False`. * `MOTO CVV required:` This parameter enables the Card Verification Value (CVV) as a required data input for MOTO transactions. The default setting is `True`. {#sis-ad-app-customize-common_ul_cky_pyb_nhc} Offline transaction maximum amount : This parameter defines the maximum amount allowed for an offline transaction. Offline transaction batch maximum amount : This parameter defines the maximum amount allowed for an offline transaction batch submitted for authorization. Tipping options : This parameter enables you to choose one of these tipping types: * `Percentage:` The customer chooses from three pre-defined tip percentages or enters a custom tip amount. Define the tip values in the Tipping percentage values parameter. This setting is the default tipping type. * `Tip amount:` The customer enters a custom tip amount. * `Total amount:` The customer enters the total amount to be charged, including the tip amount. Tipping percentage values : This parameter defines the three tipping percentages that appear on the screen. The customer can choose an option. This parameter applies only when the Tipping Type parameter is set to `Percentage`. The default settings are `10, 15, 20`. Tipping confirmation screen : This parameter enables the Tipping Confirmation screen to appear on the device during a sale with on-reader tipping. The customer reviews and confirms the tip amount before the payment is processed. The default setting is `False`. Transaction history view : This parameter defines whether the transaction history view is shown at the merchant or device level. The default setting is `Merchant`. Enable kiosk mode : This parameter enables Kiosk Mode on the PAX device. This mode locks the Acceptance Devices app to the device screen. Users cannot exit the app or access other terminal functions, which helps prevent unauthorized use. The default setting is `False`. Customizable Local Mode Parameters {#sis-ad-app-customize-semi-integrated} ========================================================================== You can customize these local mode parameters for the Acceptance Devices app. Port : This parameter defines the port number used by the server on the terminal. The default setting is `8443`. Security : This parameter defines whether the server on the terminal uses two-way verification (mTLS) or one-way verification (TLS). The default setting is `mTLS`. Protocol : This parameter defines the protocol that is used to process transactions. The default setting is `ADP`. Signature capture type : This parameter defines whether the signature is captured on the terminal screen or paper receipt, or is skipped. The default setting is `On screen`. Skip summary screen : This parameter keeps the Summary screen from appearing after each transaction. The default setting is `True`. Customizable Standalone Mode Parameters {#sis-ad-app-customize-standalone} ========================================================================== You can customize these standalone mode parameters for the Acceptance Devices app. Enable LAC installments : This parameter enables the processing of Latin America and the Caribbean (LAC) installment payments. The default setting is `Disabled`. Enable tax details : This parameter enables tax details to be shown in the app. The default setting is `Disabled`. Enable payment facilitator details : This parameter enables the payment facilitator details to be shown in the app. The default setting is `Disabled`. Additional transaction types : This parameter enables you to choose additional transaction types that the app supports. Sale and refund transactions are supported by default. The default setting for additional transaction types is `None`. Customize Parameters in the `Business Center` {#sis-ad-app-customize-ebc} ========================================================================= Follow these steps to customize common, Local mode, and Standalone mode parameters for the Acceptance Devices app. 1. In the `Business Center`, go to the left navigation panel and choose Acceptance Devices **\>** Customizations. The Customizations page appears. 2. Click the Load customization parameter for drop-down menu. 3. Choose a user level from the list. Click Load. 4. Scroll down to see the various parameter sections and which elements you can customize for the chosen user level. 5. Choose parameters to customize. To see a description of a parameter, hover your mouse over the Information icon. 6. Click Apply Changes. Retrieve Parameters Using a REST API Request {#sis-ad-app-customize-retrieve-param-rest-api-intro} ================================================================================================== You can use a REST API request to retrieve and view customizable parameters and their current values. Your account settings determine the values you can view for a portfolio, merchant, or transacting merchant ID (MID). You must authenticate each request that you send to a `Visa Acceptance Solutions` API. In order to authenticate an API request, you can use a REST shared secret key or a REST certificate. For more information about authentication requirements, see the [*Getting Started with REST Developer Guide*](https://developer.visaacceptance.com/docs/vas/en-us/platform/developer/all/rest/rest-getting-started/restgs-intro.md ""). Endpoints --------- The GET request must include the organization ID for the portfolio, merchant, or transacting merchant ID that is sending the request. **Test:** `GET ``https://apitest.visaacceptance.com``/dms/v2/customization?type=organization&id={{organization id}}` **Production:** `GET ``https://api.visaacceptance.com``/dms/v2/customization?type=organization&id={{organization id}}` Required Fields to Retrieve Parameters Using a REST API Request {#sis-ad-app-customize-retrieve-param-rest-api-reqfields} ========================================================================================================================= The body of the API request is empty. The GET request must include the information required to return the response. REST Example: Retrieve Parameters Using a REST API Request {#sis-ad-app-customize-retrieve-param-api-ex-rest} ============================================================================================================= Request The body of the request is empty. The GET request includes the information required to return the response. ``` { } ``` Response to a Successful Request ``` { "id": "{{organization id}}", "customizations": { Your configured parameters response data appears here. }, "customizationMetadata": { Your possible values for parameters response data appears here. } } ``` Customize Parameters Using a REST API Request {#sis-ad-app-customize-param-rest-api-intro} ========================================================================================== You can use a REST API request to update customizable parameters for a portfolio, merchant, or transacting merchant ID (MID). You must authenticate each request that you send to a `Visa Acceptance Solutions` API. In order to authenticate an API request, you can use a REST shared secret key or a REST certificate. For more information about authentication requirements, see the [*Getting Started with REST Developer Guide*](https://developer.visaacceptance.com/docs/vas/en-us/platform/developer/all/rest/rest-getting-started/restgs-intro.md ""). Endpoints --------- **Test:** `PUT ``https://apitest.visaacceptance.com``/dms/v2/customization` **Production:** `PUT ``https://api.visaacceptance.com``/dms/v2/customization` Required Fields for Customizing Parameters Using a REST API Request {#sis-ad-app-customize-param-rest-api-reqfields} ==================================================================================================================== type : Set the value to `organization`. id : Set the value to `organization id` for the portfolio, merchant, or transacting MID. customizations : Set the value to the parameters to be updated. REST Example: Customizing Parameters Using a REST API Request {#sis-ad-app-customize-param-rest-api-ex-rest} ============================================================================================================ Request ``` { "type": "organization", "id": "{{organization id}}", "customizations": { "OPERATING_MODE": "SEMI_INTEGRATED", "TIPPING_TYPE": "TIP_AMOUNT", "SIGNATURE_TYPE": "ON_RECEIPT" } } ``` Response to a Successful Request The body of the response is empty. A successful response is indicated with a `200 OK` status. ``` { } ```