All Superinterfaces:: KillbillApi

public interface PaymentGatewayApi
extends KillbillApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`HostedPaymentPageFormDescriptor`	`buildFormDescriptor(Account account, UUID paymentMethodId, Iterable<PluginProperty> customFields, Iterable<PluginProperty> properties, CallContext context)`	Build metadata for the client to create a redirect form
`HostedPaymentPageFormDescriptor`	`buildFormDescriptorWithPaymentControl(Account account, UUID paymentMethodId, Iterable<PluginProperty> customFields, Iterable<PluginProperty> properties, PaymentOptions paymentOptions, CallContext context)`	Build metadata for the client to create a redirect form
`GatewayNotification`	`processNotification(String notification, String pluginName, Iterable<PluginProperty> properties, CallContext context)`	Process a notification from the gateway
`GatewayNotification`	`processNotificationWithPaymentControl(String notification, String pluginName, Iterable<PluginProperty> properties, PaymentOptions paymentOptions, CallContext context)`	Process a notification from the gateway

Method Detail

buildFormDescriptor

HostedPaymentPageFormDescriptor buildFormDescriptor(Account account,
                                                    UUID paymentMethodId,
                                                    Iterable<PluginProperty> customFields,
                                                    Iterable<PluginProperty> properties,
                                                    CallContext context)
                                             throws PaymentApiException

Build metadata for the client to create a redirect form

Parameters:: account - account; customFields - form fields; properties - custom properties for the gateway; context - call context
Returns:: redirect form metadata
Throws:: PaymentApiException

buildFormDescriptorWithPaymentControl

HostedPaymentPageFormDescriptor buildFormDescriptorWithPaymentControl(Account account,
                                                                      UUID paymentMethodId,
                                                                      Iterable<PluginProperty> customFields,
                                                                      Iterable<PluginProperty> properties,
                                                                      PaymentOptions paymentOptions,
                                                                      CallContext context)
                                                               throws PaymentApiException

Build metadata for the client to create a redirect form

Parameters:: account - account; customFields - form fields; properties - custom properties for the gateway; paymentOptions - options to control payment behavior; context - call context
Returns:: redirect form metadata
Throws:: PaymentApiException

processNotification

GatewayNotification processNotification(String notification,
                                        String pluginName,
                                        Iterable<PluginProperty> properties,
                                        CallContext context)
                                 throws PaymentApiException

Process a notification from the gateway

This potentially does more than just deserialize the payload. The plugin may have to acknowledge it with the gateway.

Parameters:: notification - serialized notification object; pluginName - the payment plugin name; properties - custom properties for the gateway; context - call context
Returns:: gateway notification object used to build the response to the gateway
Throws:: PaymentApiException

processNotificationWithPaymentControl

GatewayNotification processNotificationWithPaymentControl(String notification,
                                                          String pluginName,
                                                          Iterable<PluginProperty> properties,
                                                          PaymentOptions paymentOptions,
                                                          CallContext context)
                                                   throws PaymentApiException