Open API Framework for Third-Party Payments and Cashiering

Agencies can use third-party payment providers (including cashiering systems) to process payments. They can outsource the settlement of payments (how the agency or consumer would want to pay) to a third-party payment system to offer flexibility and scalability for agencies to process OPAL payments.

The Open API Framework:

  • Provides a lookup service to support requests for permits, planning and zoning applications, business licenses, citations, code violations, or hearing fees that are due.
  • Provides an API to receive a payment confirmation and mark the fees as paid.• Provides an API to receive a void payment and reverse the payment and mark the fees as due.
  • Enables agency staff to issue an offline refund for payments processed by the third-party payment provider.
  • Enables agency staff to redirect the self-service user to an authenticated third-party payment provider page to make a payment.

Agency staff can:

  • Configure Third Party Payment Options to enable payments in a third-party payment system.
  • Configure contextual help to display the Third-Party Disclaimer that should be displayed before re-directing the user to the third-party payment page.
  • Configure contextual help to display the Payment Method list that will be supported by the third-party payment system.

Registered public users can make payments for fees in the third-party payment system.

The Open API Framework provides agencies with the option to lookup fees, process payments and manage payment returns in a third-party payment platform, including cashiering solutions.

Steps to Enable

To enable the open API framework for Third-party payments and cashiering requires you to:

  • Set up users and a new role.
  • Configure third-party payment options.
  • Configure contextual help to display the third-party disclaimer.
  • Configure contextual help to display the payment method list.
  • Configure the third-party re-direct.
  • Configure the fee lookup service.
  • Configure payment confirmation.

All configuration details are documented in the "Setting Up Third-Party Payment Integration (Document ID: 2987980.1) on My Oracle Support.

Tips And Considerations

Agencies can choose to implement one of the following options:

  1. Engage with a third-party payment service provider and configure the system to process payments by the third-party payment service provider through open API framework.
  1. Engage with a payment gateway supported by Oracle and configure the system to process online payments through the payment gateway.

Key Resources