PolicyCenter components for communication with a payment gateway

The following sections describe the PolicyCenter components that support communication with a payment gateway.

Payment gateway plugin components

The following table describes the plugins that support communication with a payment gateway.

Plugin	Description
Payment gateway configuration plugin	Purpose Specifies key information about a payment gateway, such as the URL. Class or interface Interface: `gw.plugin.paymentgateway.PaymentGatewayConfigPlugin` Demonstration implementation: `gw.plugin.paymentgateway.DefaultPaymentGatewayConfig Plugin` See also Payment gateway configuration plugin Implementing the payment gateway configuration plugin
Payment gateway plugin	Purpose Communicates with the payment gateway, sending payments, and receiving responses. Class or interface Interface: `gw.plugin.paymentgateway.PaymentGatewayPlugin` Demonstration implementation: `gw.plugin.paymentgateway.StandAlonePaymentGatewayPlugin` See also Payment gateway plugin Implementing the payment gateway plugin

The following table describes the servlet that supports communication with a payment gateway.

Servlet	Description
Payment gateway silent post servlet	Purpose Processes a postback action from the payment gateway after the gateway processes a payment. This servlet ensures that PolicyCenter and the billing system receive information about a payment even if the user closes the browser. Class Demonstration implementation: `gw.payment.paymentgateway.PaymentGatewaySilentPost Servlet` See also Implementing the silent post servlet for the payment gateway

Servlet

Description

Payment gateway silent post servlet

Purpose: Processes a postback action from the payment gateway after the gateway processes a payment. This servlet ensures that PolicyCenter and the billing system receive information about a payment even if the user closes the browser.
Class: Demonstration implementation: gw.payment.paymentgateway.PaymentGatewaySilentPost Servlet
See also: Implementing the silent post servlet for the payment gateway

Payment gateway PCF file components

The following table describes the navigation and user-interface PCF files that support communication with a payment gateway.

PCF file	Description
Exit point from PolicyCenter to the payment gateway	Purpose Maps variables to URL parameters and transfers control to the payment gateway. File Demonstration implementation: PaymentGateway.pcf See also Implementing the payment gateway exit point
Entry point to PolicyCenter from the payment gateway	Purpose Maps URL parameters to location parameters and passes control to the navigation forward PCF. File Demonstration implementation: PaymentGatewayEntryPoint.pcf See also Implementing the payment gateway entry point
Navigation forward to PolicyCenter location	Purpose Performs an action that processes the parameters from the entry point, and then redirects to the appropriate PolicyCenter location. File Demonstration implementation: PaymentGatewayForward.pcf See also Implementing the payment gateway entry point
User interface for adding up-front payments for a job	Purpose Provides a list of the available types of payment instrument, a list of the available electronic payment instruments, suggests an amount to pay, and communicates with the payment gateway. File UpFrontPaymentDV.Editable.pcf See also Using and controlling the up-front payment user interface

Payment gateway state control components

The following table describes the Gosu classes and interfaces that support state control of communication with a payment gateway.

Gosu component	Description
Payment method and payment plan manager	Purpose Tracks the payments that the selected payment plan requires and controls the information that appears on the Up-front Payment user interface. Class or interface Interfaces: All delegated to other implementation classes. Demonstration implementation: `gw.billing.PolicyPeriod BillingInstructionsManager` See also Using and controlling the up-front payment user interface
Up-front payments manager	Purpose Tracks the up-front payments that the user enters. Class or interface Interface: `gw.billing.UpFrontPayment StateContainer` Demonstration implementation: `gw.billing.UpFrontPayment StateContainerImpl` See also Using and controlling the up-front payment user interface
Payment gateway response processor	Purpose Processes the information in a response object that implements the `PaymentGatewayResponse` interface. The PolicyPeriod BillingInstructionsManager object uses controls . Class or interface Demonstration implementation: `gw.payment.paymentgateway .PaymentGatewayResponse Processor` See also Implementing payment gateway data transfer

Payment gateway data transfer components

The following table describes the Gosu classes and interfaces that support data transfer in communication with a payment gateway.

Gosu component	Description
Tokenized basic information about a credit card	Purpose Provides two `String` values. One value, which typically has a format similar to `xxxx-1234`, identifies a credit card on the Up-front Payment user interface. The other value is a token that identifies the card to the payment gateway. Class or interface Interface: gw.api.payment.paymentgateway.Payment InstrumentDetails Demonstration implementation: `gw.payment.paymentgateway.impl.TokenizedCreditCardDetails`
Information that links an electronic payment instrument and the policy to which it applies	Purpose Provides basic information about each payment instrument for which the billing system is the system of record. The PolicyPeriodBillingInstructionsManager object uses these objects in communication with the external payment gateway. Class or interface Interface: gw.plugin.billing.BillingPaymentInstrument Demonstration implementation: `gw.plugin.billing.BillingPaymentInstrumentImpl`
Information about a payment to process	Purpose Transfers information about a payment to the payment gateway for processing. Class or interface Interface: gw.api.payment.paymentgateway.Payment Information Demonstration implementation: `gw.payment.paymentgateway.impl.PaymentInformationBase`
Information from the payment gateway	Purpose Contains the information that a payment gateway returns from a request that PolicyCenter makes. Class or interface Interface: gw.api.payment.paymentgateway.Payment GatewayResponse Demonstration implementation: `gw.payment.paymentgateway.impl.PaymentGatewayResponseBase`