Set Up Converge API User

1. Log into https://www.convergepay.com/converge-webapp/#!/login

   For Kodaris systems that are processing card payments through the Elavon Converge gateway, an API User is required to be set up so payment transactions can be transmitted from the Kodaris Operations platform to Converge. To start, log into the Converge Pay user portal: https://www.convergepay.com/converge-webapp/#!/login

   

2. Navigate to "Employees"

   Navigate to the "Employees" section.

   

3. Create new employee

   To create a new API User, click "CREATE NEW EMPLOYEE" button.

   

4. Enter "User ID"

   Create a User ID in the "User ID" field.

   

5. Create and confirm passwords

   Create and confirm passwords.

   

6. The "First Name" and "Last Name" fields are optional

   The "First Name" and "Last Name" fields are optional.

   

7. Enter employee email address

   Enter the employee's active email address.

   

8. Select your Converge Account ID number from the "Supervisor" dropdown

   Click the "Supervisor" dropdown and select your Converge Account ID number from the dropdown.

   

9. "Supervisor" or Account ID number

   You'll find your "Supervisor" or Account ID number at the top right-corner of the screen.

   

10. Click "Select a Terminal to Add" dropdown

    Next, add your Associated Terminals by clicking on the dropdown.

    

11. Select the correct terminal

    Select the correct terminal for your account. For this example, we are selecting the "DEMO" terminal.

    

12. Click "SAVE"

    Now, click "Save".

    

13. Click "New employee created. User Rights can be assigned now."

    Confirmation of new employee creation will show as "New employee created. User Rights can be assigned now."

    

14. Click "Default Selection Options" dropdown

    The "USER RIGHTS" tab has been added. Click the "Default Selection Options" dropdown.

    

15. Select "Administrator"

    Select "Administrator".

    

16. Permissions have been assigned

    Notice that the API User has been assigned with the permissions.

    

17. Click "Save"

    Click "Save".

    

18. A confirmation "User has been successfully saved" will appear

    After saving, a confirmation message will appear.

    

19. Click "Show PIN"

    To get the Converge PIN, just click on the "SHOW PIN" button.

    

20. View API User details

    You will be redirected to the "Employee Management" screen. Click on "VIEW DETAILS" icon of the API User you created.

    

21. Find the Converge PIN under the Terminal Name/PIN field

    You'll find the Converge PIN under the Terminal Name/PIN field.

    

22. "HIDE PIN" option

    Click the "HIDE PIN" button if you want the PIN hidden.

    

23. Your Converge account number is the "Converge Merchant ID"

    Your Converge account number is also your "Converge Merchant ID".

    

24. Click "Save"

    If you made any updates, don't forget to hit "Save" to save the changes. Now that you have the Converge API user set up, follow the separate Kodaris instructions for setting up Converge Credentials in the Operations Portal.