com.worldline.connect.sdk.java.v1.domain

Class DisplayedData

java.lang.Object

com.worldline.connect.sdk.java.v1.domain.DisplayedData

public class DisplayedData
extends Object

Constructor Summary

Constructors

Constructor and Description
DisplayedData()

Method Summary

Modifier and Type	Method and Description
String	getDisplayedDataType() Action merchants needs to take in the online payment process.
String	getRenderingData() This property contains the blob with data for the instructions rendering service.
List<KeyValuePair>	getShowData() Array of key value pairs of data that needs to be shown to the customer.
void	setDisplayedDataType(String value) Action merchants needs to take in the online payment process.
void	setRenderingData(String value) This property contains the blob with data for the instructions rendering service.
void	setShowData(List<KeyValuePair> value) Array of key value pairs of data that needs to be shown to the customer.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayedData

public DisplayedData()

Method Detail

getDisplayedDataType

public String getDisplayedDataType()

Action merchants needs to take in the online payment process. Possible values are:

• SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData
• SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData

setDisplayedDataType

public void setDisplayedDataType(String value)

Action merchants needs to take in the online payment process. Possible values are:

• SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData
• SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData

getRenderingData

public String getRenderingData()

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

• instructionsRenderingData (required, the content of this property)
• locale (optional, if present overrides default locale, e.g. "en_GB")
• variant (optional, code of a variant, if present overrides default variant, e.g. "100")
• customerId (required for Pix, otherwise optional, the customerId from a client session)

You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

setRenderingData

public void setRenderingData(String value)

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

• instructionsRenderingData (required, the content of this property)
• locale (optional, if present overrides default locale, e.g. "en_GB")
• variant (optional, code of a variant, if present overrides default variant, e.g. "100")
• customerId (required for Pix, otherwise optional, the customerId from a client session)

You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

getShowData

public List<KeyValuePair> getShowData()

Array of key value pairs of data that needs to be shown to the customer. This is returned for both the SHOW_INSTRUCTION as well as the SHOW_TRANSACTION_RESULTS actionType.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.

setShowData

public void setShowData(List<KeyValuePair> value)

Array of key value pairs of data that needs to be shown to the customer. This is returned for both the SHOW_INSTRUCTION as well as the SHOW_TRANSACTION_RESULTS actionType.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.