Administration Guide for Oracle Billing Insight > Configuring the Payments Module >

Configuring a Payment Gateway


You must configure at least one payment gateway for ACH or credit card payments for the biller application that you defined on the Main Console.

The payment gateway or the biller's bank must provide information specific to the payment gateway. You must have this information in-hand before configuring. You can update a payment gateway at any time to add or remove information about a particular payee.

You must specify global settings for applications. If needed, you can override some of these settings in certain job configurations for each application.

To configure a payment gateway and specify global configuration settings

  1. From the Command Center menu, click Settings, then click the Payment Settings tab. Click Application Configuration. Click Create for the DDN, or application, you are configuring. Specify an implementation of Implementation of com.edocs.payment.imported.IBillDepot and click Add.
  2. Click Global Configuration. Select the payee DDN application. Select the billing application, and choose the same application from the DDN for External Payment field. Specify the global configuration parameters shown in Table 61 and click Update.
  3. Click Create next to the check payment type. Select the gateway, ACH, and click Add. Specify the payment gateway settings for checks shown in Table 62. The parameters in this table are for the ACH payment gateway. Click Add.

    If you are migrating, then use the same settings as the old payment configuration that you wrote down before deleting the old configuration.

    NOTE:  Fields with an asterisk (*) are required.

  4. For the same DDN, click Create next to the ccard, or credit card, payment type. Select the gateway, either paypal or orbital, and click Add. Specify the credit card gateway settings for the gateway you are using:
    • PayPal Payflow Pro. Use the parameters in Table 64.
    • Chase Paymentech Orbital Payment Gateway (PNS, or the Salem platform for both credit and debit card functionality). Use the parameters in Table 65.
  5. Click Add.
  6. You must configure at least one gateway account for a credit card gateway. Click Configure Gateway Account next to ccard (credit card) payment type. Click New, and specify the parameters shown in Table 67.
  7. You must configure at least one payee bank account for each payee DDN. Click Payee Account Configuration, then Click New. Select the biller payee DDN. Specify bank account details for the application. For details on configuring parameters for a payee bank account, see Table 66.
  8. Click Add to save the settings.
  9. Click Payee Biller Configuration, then click New. Choose the Biller ID to map with the payee bank account, the payee application, and the payee bank account to use. Click Add. Repeat this step for any additional Biller IDs you're using.

NOTE:  It is possible to use multiple payee bank accounts for the biller application. For help using the DDN for external payments feature, contact your Oracle sales representative to request assistance from Oracle's Professional Services.

Parameters for Configuring Global Payment Settings

Table 61 describes the global parameters required when configuring a payment gateway for a Self-Service application.

Table 61. Parameters for Global Payment Configuration
Parameter
Description

Payee DDNs

Select the application DNN that you defined on the Main Console for use with your Self-Service application. In the Command Center, an application is also referred to as a payee Data Definition Name (DDN).

Payment Payee Account Plugin Implementation

Select com.edocs.common.payment.plugin.DefaultPayeeAccountPlugin or select Custom if you're using a custom plugin.

Gateway Account Plugin Implementation

If you are supporting more than two gateway accounts based on convenience fee type or billing account type, choose the Custom plugin type, then specify the (customized) IGatewayAccountPlugin plug-in. Otherwise, use the default.

For the main transaction, the default implementation gets the gateway account with the type MAIN_TRANSACTION_ACCOUNT, and for the fee transaction it gets the account with the type FEE_TRANSACTION_ACCOUNT.

Payment Notification Service Implementation

Always select com.edocs.common.notification.payment.ConsolidatedPaymentNotificationService' class.

DDN for External Payment

This field is for use with the DDN for external payments feature. It is possible to use multiple payee bank accounts for the biller application. For help using the DDN for external payments feature, contact your Oracle sales representative to request assistance from Oracle's Professional Services. Otherwise, leave as the default value.

Enable Payment Reminder Audit

Selecting Y causes any actions that affect the PAYMENT_REMINDERS table to be audited. These actions can be from the Web application or from the payment jobs. The value N disables auditing. The default is N.

Enable Bill Summary Audit

Selecting Y causes any actions that affect the PAYMENT_BILL_SUMMARIES table to be audited. These actions can be from Web application or from the Payment jobs. The value N disables auditing. The default is Y.

Check Gateway Configuration Parameters

Table 62 describes the parameters you must specify when configuring an ACH check gateway. These parameters are used for both PayPal Payflow Pro and Chase Paymentech Orbital Payment Gateway

Table 62. Parameters for Configuring a Check Gateway
Parameter
Description

DDN

The selected application DNN.

Payment Type

check

Gateway

ach

Batch Size for Payment Reminder Table

Specifies the number of payment reminders to be read into memory from the Oracle Billing Insight database for the pmtReminder job. Note that specifying a batch size that is too small increases the number of times the database is accessed, and specifying a batch size value that is too large could result in an excessive amount of memory being used.

A batch size of 100 is suggested for a medium-sized database, and a batch size of 1000 is suggested for a large database.

You can enter a batch size of zero to disable batched table reads, however, doing so requires a lot of memory. Entering zero means that one partition ID is created for all payments, and that all payments are processed at once instead of in batches. The resulting batch file does not have multiple batch records, which some banks prefer.

Send Email Notification when Payment Jobs are Done (With or Without Error)

The value Y enables and N disables sending of email about the status of the Payment jobs that support job status notification. Additional email information is specified in the following fields.

Mail-to Addresses (Separated by ";" Semicolon) for Job Status Notification

One or more email addresses that must be sent job status notification, separated by semicolons.

JNDI Name of IAccount

Implementation of IAccount, which must match the enrollment model, single or multiple DDNs for each user account, used by applications that use this payment gateway (DDN). Select the JNDI name edx/ejb/AdminAccount.

Implementation of IUserAccountAccessor

The name of the class that handles getting Oracle Billing Insight user information, which is determined by the type of enrollment supported.

Select the class com.edocs.common.payment.plugin.DefaultUserAccountAccessor.

Implementation of IPaymentAccountAccessor

The name of the class that handles getting payment user information. Select the class com.edocs.common.payment.payenroll.payacct.DefaultPaymentAccountAccessor.

Enable Convenience Fee Payments for End User

Indicates whether to enable convenience fees in the Self-Service application: Y, Yes or N, No.

Enable Convenience Fee Payments for CSR

Indicates whether to enable convenience fees in the Assisted Service application: Y, Yes or N, No.

Convenience Fee Configuration Class

The name of the custom class for calculating the convenience fee. The default value is: com.edocs.common.payment.cassette.plugin.DefaultConvenienceFeeConfig.

Include Convenience Fee in Refunds

Indicates whether to refund the convenience fee.

Batch Size for Check Payment Table

The number of scheduled checks to read into memory from the payment database as a batch job. Note that specifying a batch size that is too small increases the number of database accesses, and specifying a batch size value that is too large might result in an excessive amount of memory being used.

A batch size of 100 is suggested for a medium-sized database, and a batch size of 1000 is suggested for a large database.

A batch size of zero can be entered to disable batched table reads, but it is not recommended because it requires a lot of memory. Entering zero means that one partition ID is created for all payments, and that all payments are processed together, instead of in batches. The resulting ACH file will not have multiple batch records, which some banks prefer.

Batch Submit Transaction Time Out

The number of minutes after which batch submit transactions time out.

Number of Business Days After Pay Date to Clear the Check

The number of business days for a check to be marked as paid after submitting to the payment gateway without returns or failures. The default is five business days.

Days to Activate Pending Subscribers

The number of business days to wait before approving a customer for online payment. If a prenote file is returned before this time, then the customer is rejected for the causes stated in the prenote file. The default is three days.

Batch File Name Prefix

The text used as a prefix to each batch file name.

Batch File Name Time Stamp

The format used for each batch file time stamp.

Batch File Name Suffix

The text used as a suffix to each batch file name.

ACH Prenote File Name Prefix

The text used as a prefix to each ACH prenote file name.

ACH Prenote File Name Time Stamp

The format used for each ACH prenote file name

ACH Prenote File Name Suffix

The text used as a suffix to each ACH prenote file name

Update Payment Enrollment in Case of NOC

The value Y causes the pmtCheckUpdate job to update enrollment status when a NOC is returned. The value N means this value is updated by the customer through the user interface

Send Email Notification in Case of NOC

The value Y sends email to customers whose payment returns a NOC. The value N means the customer does not receive email when a NOC is returned.

Skip Non-Business Days for Batch Entry Effective Dates

Whether batch effective dates skip U.S. Federal holidays and weekends.

Generate an Empty ACH File if No Checks to Submit

Whether the pmtCheckSubmit job generates an empty ACH file if there are no checks to submit.

Immediate Destination

The routing number of the Biller DDN. A routing number is assigned to you by your bank, and follows a format specified by the Biller's bank (ODFI). The pmtCheckSubmit job inserts this information into the ACH File Header record's Company Name field. The pmtCheckUpdate job uses this value to validate entries in the ACH return file. Must be exactly 10 characters in length and must start with a blank. The leading blank is counted as one of the 10 characters.

Immediate Origin

The routing number of the biller's bank (ODFI). A routing number is assigned to you by your bank. The pmtCheckSubmit job writes this information to the ACH file header record's Immediate Destination field. The pmtCheckUpdate job uses this value to validate entries in the ACH return file. Must be exactly 10 characters in length. The value assigned to you by your bank might have a leading blank. If the value is less than 10 characters in length, including the leading blank, if there is one, then you must pad the entry with trailing blanks to reach a total length of 10 characters.

Immediate Destination Name

The name of the Biller. This information is assigned to you by your bank, and follows a format specific to the needs of the ODFI. The pmtCheckSubmit job inserts this information into the ACH File Header record's Immediate Destination Name field. The pmtCheckUpdate job uses this value to validate entries in the ACH return file.

Immediate Origin Name

The name of the biller's bank (ODFI). This information is assigned to you by your bank, and follows a format specific to the needs of the ODFI. The pmtCheckSubmit job inserts this information into the ACH File Header record's Immediate Destination Name field. The pmtCheckUpdate job uses this value to validate entries in the ACH return file.

ACH File Output Directory

The directory where ACH files are created to be sent to the originating bank. Payment does not create this directory.

ACH File Input Directory

The directory where the originating bank sends ACH return files. Oracle Billing Insight does not create this directory.

ACH Template File Directory

The directory where the ACH XML files are stored.

Implementation of IAchPlugIn

The plug-in allows modification of whether a check payment is submitted, plus other actions dependent on a check selected for payment. For example, to generate a remittance file with a format different from the standard ACH file specification.

For information about implementing this class, contact Oracle Professional Services. The default value of this parameter is com.edocs.common.payment.cassette.bank.ach.DefaultAchPlugin.

Flexible Field 1 (for plugin)

You can specify an additional field for the IAchPlugin plug in.

Flexible Field 2 (for plugin)

You can specify an additional field for the IAchPlugin plug in.

.

ACH Federal Holidays

You can configure an ACH check payment gateway to skip nonbusiness days for the batch-effective entry date. The Skip non-business days for batch effective entry date field lets you determine when a payment must be made.

NOTE:  If a U.S. Federal holiday falls on a Saturday, then the previous Friday is a holiday for Federal employees, but it is not a holiday for most businesses and employees.

Nonbusiness days in the Payment module include the U.S. Federal holidays listed in Table 63.

Table 63. U.S. Federal Holidays
Holiday
Description

New Year's Day

January first.

Martin Luther King's Birthday

The third Monday in January.

Presidents' Day

The third Monday in February.

Memorial Day

The last Monday in May.

Independence Day

The 4th of July.

Labor Day

The first Monday in September.

Columbus Day

The second Monday in October.

Veterans' Day

The 11th of November.

Thanksgiving

Fourth Thursday in November.

Christmas Day

The 25th of December.

Credit Card Gateway Parameters for PayPal Payflow Pro

Table 64 describes the parameters you must specify when configuring a credit card gateway to PayPal Payflow Pro.

Table 64. Parameters for Configuring a Credit Card Gateway for PayPal Payflow Pro
Parameter
Description

DDN

Name of the DDN

Payment Type

ccard

Gateway

paypal

Batch Size for Payment Reminder Table

Specifies the number of payment reminders to be read into memory from the Oracle Billing Insight database for the pmtReminder job. Note that specifying a batch size that is too small increases the number of times the database is accessed, and specifying a batch size value that is too large could result in an excessive amount of memory being used.

A batch size of 100 is suggested for a medium-sized database, and a batch size of 1000 is suggested for a large database.

You can enter a batch size of zero to disable batched table reads, however, doing so requires a lot of memory. Entering zero means that one partition ID is created for all payments, and that all payments are processed at once instead of in batches. The resulting batch file does not have multiple batch records, which some banks prefer.

Send Email Notification when Payment Jobs are Done (With or Without Error)

The value Y enables and N disables sending of email about the status of the Payment jobs that support job status notification. Additional email information is specified in the following fields.

Mail-to Addresses (Separated by ";" Semicolon) for Job Status Notification

One or more email addresses that must be sent job status notification, separated by semicolons.

JNDI Name of IAccount

Implementation of IAccount, which must match the enrollment model, single or multiple DDNs for each user account, used by applications that use this payment gateway (DDN). Select the JNDI name edx/ejb/AdminAccount.

Implementation of IUserAccountAccessor

The name of the class that handles getting Oracle Billing Insight user information, which is determined by the type of enrollment supported.

Select the class com.edocs.common.payment.plugin.DefaultUserAccountAccessor.

Implementation of IPaymentAccountAccessor

The name of the class that handles getting Payment user information. Select the class com.edocs.common.payment.payenroll.payacct.DefaultPaymentAccountAccessor.

Enable Convenience Fee Payments for End User

Indicates whether to enable convenience fees in the Self-Service application: Y, Yes or N, No.

Enable Convenience Fee Payments for CSR

Indicates whether to enable convenience fees in the Assisted Service application: Y, Yes or N, No.

Convenience Fee Configuration Class

The name of the custom class for calculating convenience fees. The default value is: com.edocs.common.payment.cassette.plugin.DefaultConvenienceFeeConfig.

Make Authorize Reversal Payments

Y, Yes or N, No.

Batch Size for Credit Card Payment Table

Specifies the number of scheduled credit card payments to be read into memory from the Payment database for the pmtCreditCardSubmit job. Note that specifying a batch size that is too small increases the number of times the database is accessed, and specifying a batch size value that is too large might result in an excessive amount of memory being used.

A batch size of 100 is suggested for a medium-sized database, and a batch size of 1000 is suggested for a large database.

A batch size of zero can be entered to disable batched table reads, but is not recommended because it requires a lot of memory. Entering zero means that one partition ID is created for all payments, and that all payments are processed together, instead of in batches. The resulting batch file will not have multiple batch records, which some banks prefer.

Gateway Host Name

The URL to the PayPal Payflow Pro host that processes credit card transactions for this payment gateway:

pilot-payflowpro.paypal.com

Gateway Host Port

The TCP port number to be used when contacting the PayPal Payflow Pro host. The default is 443.

Gateway Timeout Period for Transaction

The number of seconds the pmtCreditCardSubmit job will wait for a transaction to complete with the PayPal Payflow Pro host before timing out.

Proxy Address

The address of the proxy server. If you are using the proxy network connection, then enter your proxy setting. This parameter is optional.

Proxy Port

The port number of the proxy server: 80. If you are using the proxy network connection, then enter your proxy setting. This parameter is optional.

PayPal Vendor

The case-sensitive vendor name assigned by registering with PayPal Payflow Pro. See your PayPal Payflow Pro representative for this value.

PayPal Partner

The partner name used by PayPal: PayPal.

URL StreamHandler class of application server

The name of the class used for the application server StreamHandler. For Oracle WebLogic, use
sun.net.www.protocol.https.Handler.

Number of Threads

Specifies the number of connections to open with the PayPal Payflow Pro payment gateway at one time. More threads consume more resources, including network resources, but decrease the time it takes the pmtCreditCardSubmit job to complete processing credit card payments. The maximum allowed is 10. The default is 1.

Enable PayPal Address Verification Service

The value Y enables address verification for credit card payments. AVS support must be set up with PayPal Payflow Pro. Y is the default.

Implementation of IPaypalPlugIn

The plug-in allows modification of whether a credit card payment is submitted, plus other actions dependent on the payments selected for settlement. For example, to deny a credit card payment dependent on additional business rules.

For information about implementing this class, contact Oracle Professional Services. The default is:

com.edocs.common.payment.cassette.creditcard.DefaultCreditCardPlugin

Flexible Field 1 (for Plug-in)

You can specify an additional field for use with the plug-in. This parameter is optional.

Flexible Field 2 (for Plug-in)

Can specify an additional field for use with the plug-in. This parameter is optional.

Credit Card Gateway Parameters for Chase Paymentech Orbital Payment Gateway (PNS or Salem)

Table 65 describes the parameters you must specify when configuring a credit card gateway for Chase Paymentech.

Table 65. Parameters for Configuring a Chase Paymentech Orbital Payment Gateway
Parameter
Description

DDN

Name of the selected application DDN.

Payment Type

ccard

Gateway

orbital

Batch Size for Payment Reminder Table

Specifies the number of payment reminders to be read into memory from the Oracle Billing Insight database for the pmtReminder job. Note that specifying a batch size that is too small increases the number of times the database is accessed, and specifying a batch size value that is too large could result in an excessive amount of memory being used.

A batch size of 100 is suggested for a medium-sized database, and a batch size of 1000 is suggested for a large database.

You can enter a batch size of zero to disable batched table reads, however, doing so requires a lot of memory. Entering zero means that one partition ID is created for all payments, and that all payments are processed at once instead of in batches. The resulting batch file does not have multiple batch records, which some banks prefer.

Send Email Notification when Payment Jobs are Done (With or Without Error)

The value Y enables and N disables sending of email about the status of the Payment jobs that support job status notification. Additional email information is specified in the following fields.

Mail-to Addresses (Separated by ";" Semicolon) for Job Status Notification

One or more email addresses that must be sent job status notification, separated by semicolons.

JNDI Name of IAccount

Implementation of IAccount, which must match the enrollment model, single or multiple DDNs for each user account, used by applications that use this payment gateway (DDN). Select the JNDI name edx/ejb/AdminAccount.

Implementation of IUserAccountAccessor

The name of the class that handles getting Oracle Billing Insight user information, which is determined by the type of enrollment supported.

Select the class com.edocs.common.payment.plugin.DefaultUserAccountAccessor.

Implementation of IPaymentAccountAccessor

The name of the class that handles getting Payment user information. Select the class com.edocs.common.payment.payenroll.payacct.DefaultPaymentAccountAccessor.

Enable Convenience Fee Payments for End User

Indicates whether to enable convenience fees in the Self-Service application: Y, Yes or N, No.

Enable Convenience Fee Payments for CSR

Indicates whether to enable convenience fees in the Assisted Service application: Y, Yes or N, No.

Convenience Fee Configuration Class

The name of the custom class for calculating the convenience fee. The default value is: com.edocs.common.payment.cassette.plugin.DefaultConvenienceFeeConfig.

Make Authorize Reversal Payments

Y, Yes or N, No.

Batch Size for Credit Card Payment Table

Specifies the number of scheduled credit card payments to be read into memory from the Payment database for the pmtCreditCardSubmit job. Note that specifying a batch size that is too small increases the number of times the database is accessed, and specifying a batch size value that is too large might result in an excessive amount of memory being used.

A batch size of 100 is suggested for a medium-sized database, and a batch size of 1000 is suggested for a large database.

A batch size of zero can be entered to disable batched table reads, but is not recommended because it requires a lot of memory. Entering zero means that one partition ID is created for all payments, and that all payments are processed together, instead of in batches. The resulting batch file will not have multiple batch records, which some banks prefer.

Gateway Host Name

The URL to the Chase Paymentech Orbital Payment Gateway host that processes credit card transactions for this payment gateway: orbitalvar1.paymentech.net

Gateway Host Port

The TCP port number to be used when contacting the Chase Paymentech Orbital Payment Gateway host. Use the default value, 443.

Gateway Timeout Period for Transaction

The number of seconds the pmtCreditCardSubmit job will wait for a transaction to complete with the Chase Paymentech Orbital Payment Gateway host before timing out. Use the default value of 60.

Proxy Address

The address of the proxy server. If you are using the proxy network connection, then enter your proxy setting. This parameter is optional.

Proxy Port

The port number of the proxy server: 80. If you are using the proxy network connection, then enter your proxy setting.This parameter is optional.

Orbital Terminal ID

Your Orbital terminal ID. Choose 001 for both the Salem and PNS.

Orbital BIN

Your Orbital BIN number. For the Salem platform, choose 000001; for PNS choose 000002.

Enable Orbital Address Verification Service

The value Y enables address verification for credit card payments. AVS support must be set up with Chase Paymentech. Use the default value, Y.

Paymentech Orbital Config File Location

The default location of the Paymentech properties configuration file: EDX_HOME\payment\paymentech\config\
linehandler.properties

Implementation of IOrbitalPlugIn

The plug-in allows modification of whether a credit card payment is submitted, plus other actions dependent on the payments selected for settlement. For example, to deny a credit card payment dependent on additional business rules.

For information about implementing this class, contact Oracle Professional Services. The default is:

com.edocs.common.payment.cassette.creditcard.DefaultCreditCardPlugin

Flexible Field 1 (for Plug-in)

You can specify an additional field for use with the plug-in. This parameter is optional.

Flexible Field 2 (for Plug-in)

Can specify an additional field for use with the plug-in. This parameter is optional.

Number of Threads

Specifies the number of connections to open with the Chase Paymentech Orbital Payment Gateway at one time. More threads consume more resources, including network resources, but decrease the time it takes the pmtCreditCardSubmit job to complete processing credit card payments. The maximum allowed is 10. Use the default value of 1.

Parameters for Configuring a Payee Bank Account

Table 66 shows the parameters you configure when adding a new payee bank account.

Table 66. Configuration Parameters for a New Payee Bank Account
Parameter
Description

Payee

The name of the payee DDN. The payee bank account will be assigned to this payment DDN.

Company ID

This information is assigned to you by your bank, and follows a format specific to the needs of the ODFI. The pmtCheckSubmit job inserts this information into the ACH Batch Header record's Company ID field. The pmtCheckUpdate job uses this value to identify the biller in the ACH return file.

Company Name

The name given to the Biller by the Biller's bank (ODFI). This information is assigned to you by your bank, and follows a format specific to the needs of the ODFI. The pmtCheckSubmit job inserts this information into the ACH File Header record's Company Name field. The pmtCheckUpdate job uses this value to identify the biller in the ACH return file.

Company Entry Description

Describes the purpose of the detail records and is dependent on the type of details records. For example, this could be Gas Bill if the ACH Detail records following this Batch Header record are of type PPD. This value is provided by your bank, the payment gateway. The pmtCheckSubmit job inserts this information into the ACH Batch Header record's Company Entry Description field.

ODFI

The routing number of the Biller's bank (ODFI). This value is provided by the payment gateway. The pmtCheckSubmit job inserts this information into the ACH Batch Header record's Originating DFI ID field.

Business Unit

The name of the business unit associated with this account.

Vertical Field 1, Vertical Field 2, Vertical Field 3

Fields that can be customized for use with your application. These parameters are optional.

Flexible Field 1, Flexible Field 2, Flexible Field 3

Fields that can be customized for use with your application. These parameters are optional.

Parameters for Configuring a Gateway Account

Table 67 shows the parameters you configure when adding a new gateway account.

Table 67. Configuration Parameters for a New Gateway Account
Parameter
Description

Payee

The name of the payee DDN. The gateway will be assigned to this payment DDN.

Gateway

The name of gateway you are configuring.

Gateway Account Name

A unique name for the gateway account.

Gateway Account Type

The type of gateway account, either:

  • MAIN_TRANSACTION_ACCOUNT. For the main transaction.
  • FEE_TRANSACTION_ACCOUNT. For the convenience fee transaction.

User Name

The user name for connecting to the payment gateway server.

Password

The password for connecting to the payment gateway server.

Additional Parameter(key=value separated by ",", comma)

Any additional parameters to pass to the payment gateway server. Place the additional parameter and values in the format shown:

Additional_Parameter(key=Value1,Value2)

Chase Paymentech Orbital Payment Gateway requires MerchantId as an additional parameter, for example: MerchantId=1111111111.

Administration Guide for Oracle Billing Insight Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Legal Notices.