com.onlinepayments.domain.SurchargeSpecificOutput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of onlinepayments-sdk-java Show documentation

SDK to communicate with the payment platform using the server API

There is a newer version: 4.24.0

Show newest version

/*
 * This class was auto-generated.
 */
package com.onlinepayments.domain;

/**
 * Object containing specific surcharging attributes applied to an order.
 */
public class SurchargeSpecificOutput {

	private String mode = null;

	private AmountOfMoney surchargeAmount = null;

	private SurchargeRate surchargeRate = null;

	/**
	 * The surcharge mode which defines how a merchant will apply surcharging.
	 * * pass-through - Merchant to define and apply surcharge amount for a transaction for processing. This mode is not supported on Create Hosted Checkout Session.
	 * * on-behalf-of - Merchant to instruct the payment platform to calculate and apply a surcharge amount to a transaction, based on the merchant’s surcharge configuration, net amount, and payment product type.
	 */
	public String getMode() {
		return mode;
	}

	/**
	 * The surcharge mode which defines how a merchant will apply surcharging.
	 * * pass-through - Merchant to define and apply surcharge amount for a transaction for processing. This mode is not supported on Create Hosted Checkout Session.
	 * * on-behalf-of - Merchant to instruct the payment platform to calculate and apply a surcharge amount to a transaction, based on the merchant’s surcharge configuration, net amount, and payment product type.
	 */
	public void setMode(String value) {
		this.mode = value;
	}

	/**
	 * The surcharge mode which defines how a merchant will apply surcharging.
	 * * pass-through - Merchant to define and apply surcharge amount for a transaction for processing. This mode is not supported on Create Hosted Checkout Session.
	 * * on-behalf-of - Merchant to instruct the payment platform to calculate and apply a surcharge amount to a transaction, based on the merchant’s surcharge configuration, net amount, and payment product type.
	 */
	public SurchargeSpecificOutput withMode(String value) {
		this.mode = value;
		return this;
	}

	/**
	 * Object containing amount and ISO currency code attributes
	 */
	public AmountOfMoney getSurchargeAmount() {
		return surchargeAmount;
	}

	/**
	 * Object containing amount and ISO currency code attributes
	 */
	public void setSurchargeAmount(AmountOfMoney value) {
		this.surchargeAmount = value;
	}

	/**
	 * Object containing amount and ISO currency code attributes
	 */
	public SurchargeSpecificOutput withSurchargeAmount(AmountOfMoney value) {
		this.surchargeAmount = value;
		return this;
	}

	/**
	 * A summary of surcharge details used in the calculation of the surcharge amount. null if result = NO_SURCHARGE
	 */
	public SurchargeRate getSurchargeRate() {
		return surchargeRate;
	}

	/**
	 * A summary of surcharge details used in the calculation of the surcharge amount. null if result = NO_SURCHARGE
	 */
	public void setSurchargeRate(SurchargeRate value) {
		this.surchargeRate = value;
	}

	/**
	 * A summary of surcharge details used in the calculation of the surcharge amount. null if result = NO_SURCHARGE
	 */
	public SurchargeSpecificOutput withSurchargeRate(SurchargeRate value) {
		this.surchargeRate = value;
		return this;
	}
}