Interface HPSProvider
- All Known Implementing Classes:
DefaultHPSProvider
public interface HPSProvider
Service component responsible for interacting with Chase's Hosted Payment Service (HPS) APIs.
-
Method Summary
Modifier and TypeMethodDescriptionperformUidInitRequest(BroadleafHPSOrderAbstractionInitRequest hpsInitRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Execute the 'UID Init Request' from the Chase HPS Order Abstraction flow.performUidQueryRequest(String uid, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Execute the 'UID Query Request' to obtain details/results about a particular UID.
-
Method Details
-
performUidInitRequest
BroadleafHPSOrderAbstractionInitResponse performUidInitRequest(BroadleafHPSOrderAbstractionInitRequest hpsInitRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Execute the 'UID Init Request' from the Chase HPS Order Abstraction flow.- Parameters:
hpsInitRequest- caller-provided details for the init requestcontextInfo- context information around multitenant state- Returns:
- response details about the result
- Throws:
MissingRequiredConfigurationException- if key system configuration elements were not foundcom.broadleafcommerce.common.error.validation.ValidationException- if there was an error with the input payloadProviderApiException- if something goes wrong with the API request
-
performUidQueryRequest
HPSOrderAbstractionQueryResponse performUidQueryRequest(String uid, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Execute the 'UID Query Request' to obtain details/results about a particular UID.- Parameters:
uid- the UID for which to obtain detailscontextInfo- context information around multitenant state- Returns:
- response details about the result
- Throws:
MissingRequiredConfigurationException- if key system configuration elements were not foundProviderApiException- if the request is unsuccessful. Note that the endpoint will throw a 404 until the customer has submitted the HPS form/page.
-