com.adyen.model.nexo.AmountsResp Maven / Gradle / Ivy

Go to download
package com.adyen.model.nexo;

import io.swagger.v3.oas.annotations.media.Schema;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import java.math.BigDecimal;


/**
 * Definition: Various amounts related to the payment response from the POI System. -- Usage: Amounts approved by the POI and the Acquirer for the payment and loyalty transaction, containing: The authorised amount to be paid The amount of the rebates The amount of financial fees The cash back part of the requested amount for a
 *
 * Java class for AmountsResp complex type.
 *
 * 
The following schema fragment specifies the expected content contained within this class.
 *
 * 
 * <complexType name="AmountsResp">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <attribute name="Currency" type="{}ISOCurrency3A" />
 *       <attribute name="AuthorizedAmount" use="required" type="{}SimpleAmountType" />
 *       <attribute name="TotalRebatesAmount" type="{}SimpleAmountType" />
 *       <attribute name="TotalFeesAmount" type="{}SimpleAmountType" />
 *       <attribute name="CashBackAmount" type="{}SimpleAmountType" />
 *       <attribute name="TipAmount" type="{}SimpleAmountType" />
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AmountsResp")
public class AmountsResp {

    /**
     * The Currency.
     */
    @XmlElement(name = "Currency")
    @Schema(description = "Currency of a monetary amount. --Rule: Mandatory for currency conversion.")
    protected String currency;
    /**
     * The Authorized amount.
     */
    @XmlElement(name = "AuthorizedAmount", required = true)
    @Schema(description = "The amount authorized by the Acquirer for the payment transaction.")
    protected BigDecimal authorizedAmount;
    /**
     * The Total rebates amount.
     */
    @XmlElement(name = "TotalRebatesAmount")
    @Schema(description = "Sum of rebates in amount (total amount or line item amount) for all the loyalty programs.")
    protected BigDecimal totalRebatesAmount;
    /**
     * The Total fees amount.
     */
    @XmlElement(name = "TotalFeesAmount")
    @Schema(description = "Total amount of financial fees.")
    protected BigDecimal totalFeesAmount;
    /**
     * The Cash back amount.
     */
    @XmlElement(name = "CashBackAmount")
    @Schema(description = "The cash-back part of the amount requested by the Sale for the payment. --Rule: if payment with cash back")
    protected BigDecimal cashBackAmount;
    /**
     * The Tip amount.
     */
    @XmlElement(name = "TipAmount")
    @Schema(description = "Amount paid for a tip. --Rule: If payment with tip requested by the Sale System.")
    protected BigDecimal tipAmount;

    /**
     * Gets the value of the currency property.
     *
     * @return possible      object is     {@link String }
     */
    public String getCurrency() {
        return currency;
    }

    /**
     * Sets the value of the currency property.
     *
     * @param value allowed object is     {@link String }
     */
    public void setCurrency(String value) {
        this.currency = value;
    }

    /**
     * Gets the value of the authorizedAmount property.
     *
     * @return possible      object is     {@link BigDecimal }
     */
    public BigDecimal getAuthorizedAmount() {
        return authorizedAmount;
    }

    /**
     * Sets the value of the authorizedAmount property.
     *
     * @param value allowed object is     {@link BigDecimal }
     */
    public void setAuthorizedAmount(BigDecimal value) {
        this.authorizedAmount = value;
    }

    /**
     * Gets the value of the totalRebatesAmount property.
     *
     * @return possible      object is     {@link BigDecimal }
     */
    public BigDecimal getTotalRebatesAmount() {
        return totalRebatesAmount;
    }

    /**
     * Sets the value of the totalRebatesAmount property.
     *
     * @param value allowed object is     {@link BigDecimal }
     */
    public void setTotalRebatesAmount(BigDecimal value) {
        this.totalRebatesAmount = value;
    }

    /**
     * Gets the value of the totalFeesAmount property.
     *
     * @return possible      object is     {@link BigDecimal }
     */
    public BigDecimal getTotalFeesAmount() {
        return totalFeesAmount;
    }

    /**
     * Sets the value of the totalFeesAmount property.
     *
     * @param value allowed object is     {@link BigDecimal }
     */
    public void setTotalFeesAmount(BigDecimal value) {
        this.totalFeesAmount = value;
    }

    /**
     * Gets the value of the cashBackAmount property.
     *
     * @return possible      object is     {@link BigDecimal }
     */
    public BigDecimal getCashBackAmount() {
        return cashBackAmount;
    }

    /**
     * Sets the value of the cashBackAmount property.
     *
     * @param value allowed object is     {@link BigDecimal }
     */
    public void setCashBackAmount(BigDecimal value) {
        this.cashBackAmount = value;
    }

    /**
     * Gets the value of the tipAmount property.
     *
     * @return possible      object is     {@link BigDecimal }
     */
    public BigDecimal getTipAmount() {
        return tipAmount;
    }

    /**
     * Sets the value of the tipAmount property.
     *
     * @param value allowed object is     {@link BigDecimal }
     */
    public void setTipAmount(BigDecimal value) {
        this.tipAmount = value;
    }

}