com.ingenico.connect.gateway.sdk.java.domain.hostedmandatemanagement.definitions.HostedMandateManagementSpecificInput Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of connect-sdk-java Show documentation
SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API
There is a newer version: 6.47.0
/*
 * This class was auto-generated from the API references found at
 * https://epayments-api.developer-ingenico.com/s2sapi/v1/
 */
package com.ingenico.connect.gateway.sdk.java.domain.hostedmandatemanagement.definitions;

public class HostedMandateManagementSpecificInput {

	private String locale = null;

	private String returnUrl = null;

	private Boolean showResultPage = null;

	private String variant = null;

	/**
	 * Locale to use to present the hosted mandate pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
	 */
	public String getLocale() {
		return locale;
	}

	/**
	 * Locale to use to present the hosted mandate pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
	 */
	public void setLocale(String value) {
		this.locale = value;
	}

	/**
	 * The URL that the customer is redirect to after the mandate flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

	 * Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

	 * URLs without a protocol will be rejected.
	 */
	public String getReturnUrl() {
		return returnUrl;
	}

	/**
	 * The URL that the customer is redirect to after the mandate flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.

	 * Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.

	 * URLs without a protocol will be rejected.
	 */
	public void setReturnUrl(String value) {
		this.returnUrl = value;
	}

	/**
	 * true - MyMandate will show a result page to the customer when applicable. Default.
	 * 
false - MyMandate will redirect the customer back to the provided returnUrl when this is possible.
	 * 
	 * The default value for this property is true.
	 */
	public Boolean getShowResultPage() {
		return showResultPage;
	}

	/**
	 * true - MyMandate will show a result page to the customer when applicable. Default.
	 * 
false - MyMandate will redirect the customer back to the provided returnUrl when this is possible.
	 * 
	 * The default value for this property is true.
	 */
	public void setShowResultPage(Boolean value) {
		this.showResultPage = value;
	}

	/**
	 * The ID of the variant used to create the Hosted Mandate Management Session in which the payment was made.
	 */
	public String getVariant() {
		return variant;
	}

	/**
	 * The ID of the variant used to create the Hosted Mandate Management Session in which the payment was made.
	 */
	public void setVariant(String value) {
		this.variant = value;
	}
}