com.prowidesoftware.swift.model.mx.dic.DebitAuthorisationRequestV10 Maven / Gradle / Ivy
Show all versions of pw-iso20022 Show documentation
package com.prowidesoftware.swift.model.mx.dic;
import java.util.ArrayList;
import java.util.List;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
/**
* Scope
* The DebitAuthorisationRequest message is sent by an account servicing institution to an account owner. This message is used to request authorisation to debit an account.
* Usage
* The DebitAuthorisationRequest message must be answered with a DebitAuthorisationResponse message.
* The DebitAuthorisationRequest message can be used to request debit authorisation in a:
* - request to modify payment case (in the case of a lower final amount or change of creditor);
* - request to cancel payment case (full amount);
* - unable to apply case (the creditor whose account has been credited is not the intended beneficiary);
* - claim non receipt case (the creditor whose account has been credited is not the intended beneficiary).
* The DebitAuthorisationRequest message covers one and only one payment instruction at a time. If an account servicing institution needs to request debit authorisation for several instructions, then multiple DebitAuthorisationRequest messages must be sent.
* The DebitAuthorisationRequest must be used exclusively between the account servicing institution and the account owner. It must not be used in place of a RequestToModifyPayment or CustomerPaymentCancellationRequest or FIToFIPaymentCancellationRequest message between subsequent agents.
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DebitAuthorisationRequestV10", propOrder = {
"assgnmt",
"_case",
"undrlyg",
"dtl",
"splmtryData"
})
public class DebitAuthorisationRequestV10 {
@XmlElement(name = "Assgnmt", required = true)
protected CaseAssignment6 assgnmt;
@XmlElement(name = "Case")
protected Case6 _case;
@XmlElement(name = "Undrlyg", required = true)
protected UnderlyingTransaction8Choice undrlyg;
@XmlElement(name = "Dtl", required = true)
protected DebitAuthorisation2 dtl;
@XmlElement(name = "SplmtryData")
protected List splmtryData;
/**
* Gets the value of the assgnmt property.
*
* @return
* possible object is
* {@link CaseAssignment6 }
*
*/
public CaseAssignment6 getAssgnmt() {
return assgnmt;
}
/**
* Sets the value of the assgnmt property.
*
* @param value
* allowed object is
* {@link CaseAssignment6 }
*
*/
public DebitAuthorisationRequestV10 setAssgnmt(CaseAssignment6 value) {
this.assgnmt = value;
return this;
}
/**
* Gets the value of the case property.
*
* @return
* possible object is
* {@link Case6 }
*
*/
public Case6 getCase() {
return _case;
}
/**
* Sets the value of the case property.
*
* @param value
* allowed object is
* {@link Case6 }
*
*/
public DebitAuthorisationRequestV10 setCase(Case6 value) {
this._case = value;
return this;
}
/**
* Gets the value of the undrlyg property.
*
* @return
* possible object is
* {@link UnderlyingTransaction8Choice }
*
*/
public UnderlyingTransaction8Choice getUndrlyg() {
return undrlyg;
}
/**
* Sets the value of the undrlyg property.
*
* @param value
* allowed object is
* {@link UnderlyingTransaction8Choice }
*
*/
public DebitAuthorisationRequestV10 setUndrlyg(UnderlyingTransaction8Choice value) {
this.undrlyg = value;
return this;
}
/**
* Gets the value of the dtl property.
*
* @return
* possible object is
* {@link DebitAuthorisation2 }
*
*/
public DebitAuthorisation2 getDtl() {
return dtl;
}
/**
* Sets the value of the dtl property.
*
* @param value
* allowed object is
* {@link DebitAuthorisation2 }
*
*/
public DebitAuthorisationRequestV10 setDtl(DebitAuthorisation2 value) {
this.dtl = value;
return this;
}
/**
* Gets the value of the splmtryData property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the Jakarta XML Binding object.
* This is why there is not a {@code set} method for the splmtryData property.
*
*
* For example, to add a new item, do as follows:
*
* getSplmtryData().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link SupplementaryData1 }
*
*
* @return
* The value of the splmtryData property.
*/
public List getSplmtryData() {
if (splmtryData == null) {
splmtryData = new ArrayList<>();
}
return this.splmtryData;
}
@Override
public String toString() {
return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
}
@Override
public boolean equals(Object that) {
return EqualsBuilder.reflectionEquals(this, that);
}
@Override
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(this);
}
/**
* Adds a new item to the splmtryData list.
* @see #getSplmtryData()
*
*/
public DebitAuthorisationRequestV10 addSplmtryData(SupplementaryData1 splmtryData) {
getSplmtryData().add(splmtryData);
return this;
}
}