Set up Hardware Profiles for the Shift4 Payment Connector for Dynamics 365

Description: Follow the steps below to configure the Shift4 connector to begin using it for Retail POS once payment methods and card types have been added to the channel.

• Set up Hardware Profiles
• Setting up your Store & Registers
  • Store Payment Methods, Timezone & Channel Profile Setup
  • Assigning Hardware Profile to a Store
  • Assigning Hardware Profile to a Register

---

Set up Hardware Profiles

1. Navigate to Retail and Commerce > Channel setup > POS setup > POS profiles > Hardware profiles.
   
2. Select the desired hardware profile. You may choose any one of them; just remember your choice, as this will be important later on.
   
3. Scroll down to EFT service.
   
   • Under Device, select Payment Connector 
   • Under Legacy profile version, set to AX 2012 R2 or later
   • Increase the Max no. of card payments to whatever number desired
4. Under Connectors, select New or edit the existing connector and select Shift4Connector.
   
5. If using Commerce Engine (Cloud or On-Premise), ensure the following value is set for TestEnvironmentUrl and ProdEnvironmentUrl:
   
   • TestEnvironmentUrl: api.shift4test.com
   • ProdEnvironmentUrl: api.shift4api.net
6. Configure the settings for CardTypeMapping. This will differ depending on the integration.
   
   • UTG Integrations: AMEXPRESS=AX;DISCOVER=NS;GIFTCARD=GC;MASTER=MC;VISA=VS;DEBIT=DB;EXTGC=YC
   • PAX Integrations: VISA=01;MASTER=02;AMEXPRESS=03;DISCOVER=04;DEBIT=17
7. Ensure that "ImmediateCapture" is set to True.
   
   

8. Set the desired TerminalType for the integration setup you're using:

   • PAX - For PAX POSLink integration

   • UTG - For UTG and Commerce Engine On-Premise

   • CLOUD - For Commerce Engine Cloud

9. Set the Environment to Prod (for UAT environments, you can use Test).
   
10. Enter the access token for the account payments will be going to in the Access Token field.
    
    
    Important: In order to get the access token, you will need to perform the exchange from the Channel Payment Parameters form. You can use the steps found here to configure the Payment Services in order to allow the token exchange to work.
11. Scroll down to PIN pad.
    
    • PIN pad: Network (This is how Dynamics 365 communicates with UTG, the PIN pad itself can still be Ethernet or USB)
    • Device name: 
      • UTG/CommEng Integrations: SHIFT4PAYMENT
      • PAX Integrations: SHIFT4PAXPAYMENT
    • Make & Model: Enter device information (not required)
12. Once done, select the Save icon and run a Distribution Schedule task to push the parameter changes to the POS Software module. If you still have other changes to make, leave this step for last.

Setting up your Store & Registers

Store Payment Methods, Time zone & Channel Profile Setup

1. Navigate to Retail and Commerce > Channel > Stores > All Stores.
   
2. Select the desired store from the list.
   
3. From the General section, select your Channel profile and Live channel database from the dropdown.
   
4. Upon doing so, you will see a time zone setting under the General section. If you do, change this to the desired time zone.
   
5. If you do not see the time zone form in the General section, right-click anywhere in General and select Personalize: General.
   
6. Select + Add a field and add the Store time zone.
   
7. Change the time zone settings from here, then Save.
   
8. If you are using Offline Mode with this register, enable the Offline toggle. Upon doing so, an Offline DB will be automatically selected for this register.
   
9. Select the Set up tab, and under Set up, select Payment methods.
   
10. Select the Payment Method for Cards then navigate to Electronic payment setup.
    
11. Ensure that the following options are Disabled:
    • Enter fleet information
    • Check modules
    • Check expiration date
    • Process locally
      
12. Save the changes, then navigate back to Payment Methods.
13. Set up the Shift4 Gift Card Payment Method.
    1. Select New.
    2. Under Payment methods, select the record you created previously from the dropdown. 
       1. Enter the Payment method name as "Shift4 Gift Card."
       2. Select Card from the Function dropdown.
          
    3. In the General section, under POS, set the Operation name to "Pay gift card" and set the Connector Name to "Shift4Connector."
       
    4. In the Amount section, under CASH OUT GIFT CARD. input a numeric value under the "Gift card cash out threshold" to limit the amount a gift card can be cashed out for. In this example, we are setting $500 as the limit.
       
    5. In the Posting section, under ACCOUNT, select the Account type and Account number applicable to your environment, then select an appropriate Difference account under the DIFFERENCE ACCOUNT section. (These options depend on the merchant).
       
    6. In the Posting section, set the Gift card item number to ‘9999’.
       
    7. Select Save.
14. Set up the Card Token Payment Method.
    1. Select New.
    2. Under Payment methods, select Card Token.
       1. Enter the Payment method name as "Card Token."
       2. Select Card from the Function dropdown.
          
          Important: The Payment method name MUST contain the word “Token.”
       3. In the General section, under POS set the Operation name to "Pay card."
          
       4. In the Amount section, input a value under the "Maximum amount per transaction." In this example, we are setting this to 10,000.00 for the maximum amount allowed per transaction.
          
       5. In the Posting section, under ACCOUNT, select the Account type and Account number applicable to your environment, then select an appropriate Difference account under the DIFFERENCE ACCOUNT section. (These options depend on the merchant).
          
15. Select Save.

Assigning Hardware Profile to a Store

1. Navigate to Retail and Commerce > Channels > Stores > All stores.
   
2. Locate the Retail store location that you are going to be working with and select it.
   
3. Navigate to the Hardware stations tab at the bottom of the page.
   
4. Configure the following fields to the required settings for your integration. Anything not mentioned should be left blank.
   
   • Hardware Station type: This will differ depending on the integration that you’re working with
     • Dedicated: A Dedicated payment device/UTG instance where payments will flow through
       
     • Shared: A Local or Cloud hosted hardware station that is used with the payment devices specified in the POS request
       
   • Description: A name to help you identify the Hardware station
   • Host name & Port: This will differ depending on the Hardware station type selected
     • Dedicated: Leave name blank and set port to 0
     • Shared: Set this to the name and port that you will configure for the Hardware Station
   • Hardware profile: Select the hardware profile you configured Shift4 Payment Connector to previously
   • EFT POS Number: Leave this blank; we will configure the API TID at the Register level later.
5. Navigate to the Screen layout tab, and from the dropdown, make sure that there is a default Screen layout ID. Keep a record of this information as it will become important later on.
   
6. Navigate to the Statement/Closing tab and set the Closing method to Shift.
   
7. Once done, select Save.

Assigning Hardware Profile to a Register

1. Log into the Back Office and navigate to Retail and Commerce > Channel setup > POS setup > Registers.
   
2. Select the desired register; you may choose any one of them; just remember your choice, as this will be important later on.
   
3. Under Hardware profiles, select the one where you configured Shift4 Payment Connector to previously.
   
4. Under EFT POS register number, enter any number you desire. This will have to match the API TID on UTG/LTM.
   
5. Navigate back to the top of the page, select Register, and then Configure IP address.
   
   • For UTG integrations, add the IP address and Port of the REST API Interface for the UTG session being hosted on the server workstation.
     
   • For Commerce Engine On-Premise integrations, add the IP address of the PAX Device and Port 8085 for the REST API Interface of the Commerce Engine application.
     
   • For Commerce Engine Cloud integrations, add the Serial Number of the PAX device associated with that workstation.
   • For PAX integrations, add the IP address and Port of the PAX device that’s running the BroadPOS Shift4 application.
     
6. After configuring the terminal, navigate to the Display tab from the dropdown and make sure a Screen layout ID is selected. Keep a record of this information, as it will become important later on.
   
7. Under the General section, make sure the appropriate Visual profile for the screen layout you’re working with is selected; in this case, since we are using A3MGR, the visual profile will be A3MP.
   
8. Follow these same steps for any additional stations that you are configuring.
9. Once done, select Save and run a Distribution Schedule task to push the parameter changes to the POS Software module. If you still have other changes to make, leave this step for last.