1. Implementing Your Financials Framework
  2. Setting Up Payment Adapters

Setting Up Payment Adapters

Payment adapters enable you to define attributes for your payment gateway that are used during payment processing. You should define a separate payment adapter for each merchant ID associated with a payment gateway. You add, modify, and delete payment adapters on the Payment Adapter page.

Adding a Payment Adapter

  1. Select Payment Setup > Payment Adapter.

  2. On the Payment Adapter page, click Add.

  3. On the Adapter Summary tab, enter information for the following fields:

    Page Element

    Description

    Payment Adapter ID

    Enter a name for the payment adapter.

    Payment Gateway

    Select the delivered payment gateway that you want to use for this payment adapter.

    Adapter Mode

    Select whether the payment adapter is in Live or Test mode.

    Enabled

    Turn the Enabled switch on to make the row available as a lookup value on other pages.

  4. Access the Adapter Configuration tab and click Add to add a configuration for the payment adapter.

  5. You can set different configuration values for credit card and debit card payment adapters. Enter an ID, name, and value for the configuration. Here are some options:

    Configuration ID

    Description

    TIMEOUT

    This is a configurable Timeout and is read as minutes. The timeout value is used in the following areas:

    1. Hosted payment page countdown.

    2. Online (manual) reconcile API wait time.

    3. Sync card ESS job reconcile wait time.

    If no value is set for this configuration, the defaults below are used:

    1. Hosted payment page, 5 minutes.

    2. ESS sync job, 6 minutes.

    3. Online reconcile, 12 minutes.

    If the administrator sets a different timeout value, certain areas will have a multiplier:

    1. Hosted payment page, defined timer .

    2. ESS sync job, defined timer + 1 minute.

    3. Online reconcile, 2x defined timer + 1 minute.

    The timer starts as soon as the user clicks the Make Payment button.

    A countdown timer is displayed on the card details page.

    The system does not check if the card details page has data or not, the timer will run regardless.

    When processing times out, a message is displayed to the user

    HELPDESK

    This is a configurable HelpDesk value that enables customers to set a custom help desk value.

    The system will append the value as is to the error messages on card payment.

    MAX_LIMIT_AMT

    MAX_LIMIT_CURR

    This is a configurable transaction limit that enables customers to set a maximum amount and a currency limit per transaction. Both values have to be set up, or else no validation will take place.

    If set, the system performs a comparison of the checkout amount total and the currency.

    The system first validates if the checkout currency is the same as the max_limit_curr. If so, it compares the amount. If not, the validation ends.

    If the currency equals max_limit_curr and the checkout amount total is greater than the max_limit_amt, the payment request is denied and a message is displayed to the user.

    REFUND_PERIOD

    This is a configurable refund period validation that enables customers to validate a refund window upfront.

    The value can be an agency specific refund window (for example, 30 days) but cannot be more than the 3rd party provider refund window.

  6. Access the Adapter Method tab and click Add to add a payment method for the payment adapter.

  7. Select a Payment Method.

  8. Turn the Enabled switch on to make the row available as a lookup value on other pages.

  9. Click Save.

Modifying a Payment Adapter

  1. Select Payment Setup > Payment Adapter.

  2. Click a row on the Payment Adapter page.

  3. You can:

    • Update the field values on the Adapter Summary.

      Note:

      You cannot edit the Adapter Name field.

    • Enable or disable the payment adapter using the Enabled switch. Only enabled payment adapters are available on other pages.

    • Access the Adapter Configuration tab and click a row to update the configuration value, or delete a configuration.

    • Access the Adapter Method tab and click a row to update the payment method field values, or delete a payment method.

    • Delete the payment adapter. You will be prompted to confirm the permanent deletion.

  4. Click Save.

Deleting Payment Adapters

  1. Select Payment Setup > Payment Adapter.

  2. Click Edit.

  3. Select the checkboxes next to all the payment adapters you want to delete.

  4. Click Delete. You will be prompted to confirm the permanent deletion.