com.rapidclipse.framework.server.webapi.payment

Class Payment

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.polymertemplate.AbstractTemplate<M>

com.vaadin.flow.component.polymertemplate.PolymerTemplate<M>

com.rapidclipse.framework.server.webapi.JavascriptTemplate<Payment.PaymentTemplateModel>

com.rapidclipse.framework.server.webapi.payment.Payment

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable

@HtmlImport(value="frontend://webapi/payment.html")
 @Tag(value="rap-payment")
public class Payment
extends JavascriptTemplate<Payment.PaymentTemplateModel>

With this class you can ask the browser to display an payment interface. It lets the user select his preferred way of paying and will also cache his information so he does not have to retype his information.

Since:

10.02.00

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Payment.PaymentTemplateModel
static class	Payment.Result The different results the payment completion can have.

Constructor Summary

Constructors

Constructor and Description
Payment(com.vaadin.flow.component.HasElement parent)

Method Summary

Modifier and Type	Method and Description
void	complete(Payment.Result result, Consumer<JavascriptError> onErrorOccurred) This method can be used to show the user that the transaction is complete.
void	requestPayment(List<PaymentRequestMethodData> methodData, PaymentRequestDetails details, PaymentRequestOptions options, Consumer<PaymentResult> onResultReceived, Consumer<JavascriptError> onErrorReceived) Request the browser to display the payment interface.
void	retry(PaymentValidationError errorFields, Consumer<PaymentResult> onResultReceived, Consumer<JavascriptError> onErrorOccurred) This method can be used if a payment request failed and the error is recoverable.

Methods inherited from class com.rapidclipse.framework.server.webapi.JavascriptTemplate

clearConsumers, notifyConsumers, registerConsumer, registerConsumer, unregisterAllConsumers, unregisterAllConsumers

Methods inherited from class com.vaadin.flow.component.polymertemplate.PolymerTemplate

getChildren

Methods inherited from class com.vaadin.flow.component.polymertemplate.AbstractTemplate

getModel, getModelType, getModelType, getStateNode, initModel, isSupportedClass

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

Payment

public Payment(com.vaadin.flow.component.HasElement parent)

Method Detail

requestPayment

public void requestPayment(List<PaymentRequestMethodData> methodData,
                           PaymentRequestDetails details,
                           PaymentRequestOptions options,
                           Consumer<PaymentResult> onResultReceived,
                           Consumer<JavascriptError> onErrorReceived)

Request the browser to display the payment interface. The user can then input his information and preferred payment method. When the user is done and the dialog was successful the onResultReceived callback is triggered. If the user aborts the dialog or something goes wrong the onErrorReceived callback will be triggered.

Parameters:

methodData - A List of different payment methods that are accepted. Currently only basic-card is available.

details - Details such as total and a list of items. This is to show the user the list of items that he will receive, once the transaction is over.

options - Various options such as requesting the user to input his email or phone number.

onResultReceived - The callback triggered when the dialog was successful and the user clicked on pay. It will consume a PaymentResult that contains information needed for the payment.

onErrorReceived - The callback triggered when the dialog was aborted by the user or something else went wrong. It will consume the JavaScript error that was thrown on the client side.

retry

public void retry(PaymentValidationError errorFields,
                  Consumer<PaymentResult> onResultReceived,
                  Consumer<JavascriptError> onErrorOccurred)

This method can be used if a payment request failed and the error is recoverable. It will redisplay the payment interface. With the errorFields parameter the invalid fields can be highlighted.

Parameters:

errorFields - The fields that made the error occur.

onResultReceived - The callback triggered when the dialog was successful and the user clicked on pay. It will consume a PaymentResult that contains information needed for the payment.

onErrorOccurred - The callback triggered if the dialog fails again. It conumes the JavaScript error that is thrown on the client side.

complete

public void complete(Payment.Result result,
                     Consumer<JavascriptError> onErrorOccurred)

This method can be used to show the user that the transaction is complete.

Parameters:

result - The result of the transaction. The Payment.Result enum is used for if the transaction has succeeded or failed.

onErrorOccurred - The callback triggered when something goes wrong and the payment can not be completed. It will consume the JavaScript error thrown on the client side.