com.broadleafcommerce.paymentgateway.service

Interface CustomerPaymentGatewayService

public interface CustomerPaymentGatewayService

This is designed as a generic contract for allowing payment modules to tokenize payments and add it to a customer profile represented in Broadleaf while still staying decoupled from any of the Broadleaf core framework concepts.

Author:

Elbert Bautista (elbertbautista)

Method Summary

Modifier and Type	Method and Description
Long	createCustomerPaymentFromResponseDTO(PaymentResponse responseDTO, PaymentGatewayConfiguration config)
void	deleteCustomerPaymentFromResponseDTO(PaymentResponse responseDTO, PaymentGatewayConfiguration config)
Long	updateCustomerPaymentFromResponseDTO(PaymentResponse responseDTO, PaymentGatewayConfiguration config)

Method Detail

createCustomerPaymentFromResponseDTO

Long createCustomerPaymentFromResponseDTO(PaymentResponse responseDTO,
                                          PaymentGatewayConfiguration config)
                                   throws IllegalArgumentException

Parameters:

responseDTO - the response from the gateway

config - configuration values for the payment gateway

Returns:

a unique ID of the payment token

Throws:

IllegalArgumentException

updateCustomerPaymentFromResponseDTO

Long updateCustomerPaymentFromResponseDTO(PaymentResponse responseDTO,
                                          PaymentGatewayConfiguration config)
                                   throws IllegalArgumentException

Parameters:

responseDTO - the response from the gateway

config - configuration values for the payment gateway

Returns:

a unique ID of the payment token

Throws:

IllegalArgumentException

deleteCustomerPaymentFromResponseDTO

void deleteCustomerPaymentFromResponseDTO(PaymentResponse responseDTO,
                                          PaymentGatewayConfiguration config)
                                   throws IllegalArgumentException

Parameters:

responseDTO - the response from the gateway

config - configuration values for the payment gateway

Throws:

IllegalArgumentException