Skip to main content

OpenEdge Hosted Payments

Sign

This article provides OPS-COM administrators with instructions for configuring OpenEdge Hosted Payments within the system. Setting up this integration allows you to securely process online credit card transactions for yourpermits, newviolations, and other user fees.

Account Registration and Credentials

Before configuring OPS-COM, you must register for an OpenEdge Accountaccount Here:and OPSCOM / OpenEdge.

Onobtain the signnecessary upAPI formcredentials.

you
    will
  1. be

    Navigate asked for Representative Information. Here isto the correctOpenEdge informationsign-up toform.

    enter:

  2. Enter the following details in the Representative Information section:

    Credentials

    3. Required:

Your OpenEdge Account Manager canwill provide you with thean following information:

  • Auth Key: a (multi-digit stringstring), key
  • Terminal ID: a 8 (8-digit numericnumeric), key
    • and
  • X-Web ID: a 12 (12-digit numeric key

This will be given to younumeric) for both a Sandbox and a Production environment.environments.

Create

Setup OpenEdgeand Payment Type:

Configuration

YouOnce you have your credentials, you can create a newthe payment type byin selectingthe administration portal.

  1. Hover over System Configuration (and icon in the OPSCOM admin side menu ) →click Payments →then Setup Payment Types.

    →

  2. Click the Add Type.Type button.

    image.png


  3. Click

    Selectthe "provider drop-down menu and choose EdgeExpress - Hosted".

    as
    4. your
  4. provider

    Click →the Next Step. button.

    image.png

  5. YouEnter shoulda nowname be brought toin the "Edit Payment Type" page:

    image.png

    Type Name:Name Thefield. TypeThis name can be whatever you want it to be, though please note this will also be the nameis displayed to users whenduring usingcheckout.

  6. Select the user types you wish to grant access to this payment checkoutmethod andunder selecting a payment method. You can reference the specific hosted payment provider such as OpenEdge/Edge Express or something more generic such as "Online Credit Card Payment", "Online payment", "Credit Card", etc. Really it's up to you and what you think makes most sense to your site users when making a payment, also might depend on what payment methods your OpenEdge/EdgeExpress.

    Enabled for User Types:.

    Select

  7. Enable the User Types you wish this new Payment Type to be visible to so they can select it during payment checkout. You can change these user types at any time

    There are additional required configuration fields in the Settings area:

    image.png

    Enable for Text2ParkMe: checkbox if youyour aren'torganization usingutilizes this modulemodule.

    leave

  8. Enable the button unchecked.

    Enable for Permit Renewal Payments: checkbox if you aren't usinguse this featurefeature.

    leave

  9. Enable the button unchecked.

    Enable for Guest Payments: checkbox if you aren't usinguse this featurefeature.

    leave

  10. Click the button unchecked.

    Prompt Information: Onlydrop-down "menu and choose Email Address"Address, as this is the only supported withoption for OpenEdge Hosted Payments at this time.

    Credentials:

    • Click the environment drop-down menu and choose Production/Production or Sandbox: Selectto whether you are usingmatch your OpenEdge Production/Live credentials or Sandbox/Testingprovided credentials.

      Additionally,
      • although
    • not required you may find

      Enter your OPSCOM preview space helpful for testing Sandbox/testing credentials, this way you can keep your production/live OPSCOM data (permits, users, payments, violations, etc) clean/untouched during any testing.

    As referenced above, your OpenEdge Account Manager can provide you with the following credentials:

    • Auth Key:, a multi-digit string key.
    • Terminal ID:, aand 8 digit numeric key.
    • X-Web ID: ain 12the digitrespective numericcredential key.fields.

  11. Don'tClick forgetthe Update Payment Type button to save yourthe newconfiguration.

    payment
    12. type
by

Using clickingthis Feature

Administrators should verify the "Updateintegration Paymentbefore Type"making buttonit along the bottom of the page:

Done, the new OpenEdge/Edge Express hosted payment type has been addedavailable to your OPSCOM system and you should be ready to test the payment/checkout process using this new payment type. end-users.

  1. To test: UsingCreate a test user,user account and add a vehicle ifto nonethe alreadyprofile.

    present,
    2. then

  2. Navigate to the user portal and purchase a low-value item, such as a $1.00 permit or violationviolation.

  3. Select your newly created OpenEdge payment method during checkout.

  4. Complete the transaction using thea newvalid paymentcredit type.card.

    Complete
    5. and
  5. pay

    Verify for the transaction. Once completethat the test user will receivereceives an email receipt showingconfirming the successful payment.

  6. Confirm with your finance department that the funds have been successfully deposited into your company has received the payment into your bank accountaccount.

Best Practices and Considerations

  • Test in a preview space: Organizations should utilize their OPS-COM preview environment when testing Sandbox credentials to verifyensure thatproduction thedata setupremains isclean workingand correctly. 

    For some additional reference/clarification this is what the OpenEdge hosted payment page looks like to website usersuntouched during the checkout/paymentvalidation process:phase.

  • image.pngUse descriptive naming conventions: Ensure your Type Name is clear to end-users, as generic names like "Online Credit Card Payment" or specific ones like "OpenEdge Checkout" dictate the clarity of the user experience.

Back to top