uk.org.openbanking.datamodel.payment.OBInternational1 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openbanking-sdk Show documentation
Show all versions of openbanking-sdk Show documentation
A Java SDK to help implementing the Open Banking standard : https://www.openbanking.org.uk/read-write-apis/
/**
*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at https://forgerock.org/cddlv1-0/. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2019 ForgeRock AS.
*/
package uk.org.openbanking.datamodel.payment;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.springframework.validation.annotation.Validated;
import uk.org.openbanking.datamodel.account.OBCashAccount3;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import java.util.Objects;
/**
* The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
*/
@ApiModel(description = "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.")
@Validated
@javax.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2018-10-10T14:05:22.993+01:00")
public class OBInternational1 {
@JsonProperty("InstructionIdentification")
private String instructionIdentification = null;
@JsonProperty("EndToEndIdentification")
private String endToEndIdentification = null;
@JsonProperty("LocalInstrument")
private String localInstrument = null;
@JsonProperty("InstructionPriority")
private OBPriority2Code instructionPriority = null;
@JsonProperty("Purpose")
private String purpose = null;
@JsonProperty("ChargeBearer")
private OBChargeBearerType1Code chargeBearer = null;
@JsonProperty("CurrencyOfTransfer")
private String currencyOfTransfer = null;
@JsonProperty("InstructedAmount")
private OBActiveOrHistoricCurrencyAndAmount instructedAmount = null;
@JsonProperty("ExchangeRateInformation")
private OBExchangeRate1 exchangeRateInformation = null;
@JsonProperty("DebtorAccount")
private OBCashAccount3 debtorAccount = null;
@JsonProperty("Creditor")
private OBPartyIdentification43 creditor = null;
@JsonProperty("CreditorAgent")
private OBBranchAndFinancialInstitutionIdentification3 creditorAgent = null;
@JsonProperty("CreditorAccount")
private OBCashAccount3 creditorAccount = null;
@JsonProperty("RemittanceInformation")
private OBRemittanceInformation1 remittanceInformation = null;
public OBInternational1 instructionIdentification(String instructionIdentification) {
this.instructionIdentification = instructionIdentification;
return this;
}
/**
* Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
* @return instructionIdentification
**/
@ApiModelProperty(required = true, value = "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.")
@NotNull
@Size(min=1,max=35)
public String getInstructionIdentification() {
return instructionIdentification;
}
public void setInstructionIdentification(String instructionIdentification) {
this.instructionIdentification = instructionIdentification;
}
public OBInternational1 endToEndIdentification(String endToEndIdentification) {
this.endToEndIdentification = endToEndIdentification;
return this;
}
/**
* Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
* @return endToEndIdentification
**/
@ApiModelProperty(required = true, value = "Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.")
@NotNull
@Size(min=1,max=35)
public String getEndToEndIdentification() {
return endToEndIdentification;
}
public void setEndToEndIdentification(String endToEndIdentification) {
this.endToEndIdentification = endToEndIdentification;
}
public OBInternational1 localInstrument(String localInstrument) {
this.localInstrument = localInstrument;
return this;
}
/**
* User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
* @return localInstrument
**/
@ApiModelProperty(value = "User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.")
@Size(min=1,max=35)
public String getLocalInstrument() {
return localInstrument;
}
public void setLocalInstrument(String localInstrument) {
this.localInstrument = localInstrument;
}
public OBInternational1 instructionPriority(OBPriority2Code instructionPriority) {
this.instructionPriority = instructionPriority;
return this;
}
/**
* Get instructionPriority
* @return instructionPriority
**/
@ApiModelProperty(value = "")
@Valid
public OBPriority2Code getInstructionPriority() {
return instructionPriority;
}
public void setInstructionPriority(OBPriority2Code instructionPriority) {
this.instructionPriority = instructionPriority;
}
public OBInternational1 purpose(String purpose) {
this.purpose = purpose;
return this;
}
/**
* Specifies the external purpose code in the format of character string with a maximum length of 35 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
* @return purpose
**/
@ApiModelProperty(value = "Specifies the external purpose code in the format of character string with a maximum length of 35 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.")
public String getPurpose() {
return purpose;
}
public void setPurpose(String purpose) {
this.purpose = purpose;
}
public OBInternational1 chargeBearer(OBChargeBearerType1Code chargeBearer) {
this.chargeBearer = chargeBearer;
return this;
}
/**
* Get chargeBearer
* @return chargeBearer
**/
@ApiModelProperty(value = "")
@Valid
public OBChargeBearerType1Code getChargeBearer() {
return chargeBearer;
}
public void setChargeBearer(OBChargeBearerType1Code chargeBearer) {
this.chargeBearer = chargeBearer;
}
public OBInternational1 currencyOfTransfer(String currencyOfTransfer) {
this.currencyOfTransfer = currencyOfTransfer;
return this;
}
/**
* Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
* @return currencyOfTransfer
**/
@ApiModelProperty(required = true, value = "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.")
@NotNull
@Pattern(regexp="^[A-Z]{3,3}$")
public String getCurrencyOfTransfer() {
return currencyOfTransfer;
}
public void setCurrencyOfTransfer(String currencyOfTransfer) {
this.currencyOfTransfer = currencyOfTransfer;
}
public OBInternational1 instructedAmount(OBActiveOrHistoricCurrencyAndAmount instructedAmount) {
this.instructedAmount = instructedAmount;
return this;
}
/**
* Get instructedAmount
* @return instructedAmount
**/
@ApiModelProperty(required = true, value = "")
@NotNull
@Valid
public OBActiveOrHistoricCurrencyAndAmount getInstructedAmount() {
return instructedAmount;
}
public void setInstructedAmount(OBActiveOrHistoricCurrencyAndAmount instructedAmount) {
this.instructedAmount = instructedAmount;
}
public OBInternational1 exchangeRateInformation(OBExchangeRate1 exchangeRateInformation) {
this.exchangeRateInformation = exchangeRateInformation;
return this;
}
/**
* Get exchangeRateInformation
* @return exchangeRateInformation
**/
@ApiModelProperty(value = "")
@Valid
public OBExchangeRate1 getExchangeRateInformation() {
return exchangeRateInformation;
}
public void setExchangeRateInformation(OBExchangeRate1 exchangeRateInformation) {
this.exchangeRateInformation = exchangeRateInformation;
}
public OBInternational1 debtorAccount(OBCashAccount3 debtorAccount) {
this.debtorAccount = debtorAccount;
return this;
}
/**
* Get debtorAccount
* @return debtorAccount
**/
@ApiModelProperty(value = "")
@Valid
public OBCashAccount3 getDebtorAccount() {
return debtorAccount;
}
public void setDebtorAccount(OBCashAccount3 debtorAccount) {
this.debtorAccount = debtorAccount;
}
public OBInternational1 creditor(OBPartyIdentification43 creditor) {
this.creditor = creditor;
return this;
}
/**
* Get creditor
* @return creditor
**/
@ApiModelProperty(value = "")
@Valid
public OBPartyIdentification43 getCreditor() {
return creditor;
}
public void setCreditor(OBPartyIdentification43 creditor) {
this.creditor = creditor;
}
public OBInternational1 creditorAgent(OBBranchAndFinancialInstitutionIdentification3 creditorAgent) {
this.creditorAgent = creditorAgent;
return this;
}
/**
* Get creditorAgent
* @return creditorAgent
**/
@ApiModelProperty(value = "")
@Valid
public OBBranchAndFinancialInstitutionIdentification3 getCreditorAgent() {
return creditorAgent;
}
public void setCreditorAgent(OBBranchAndFinancialInstitutionIdentification3 creditorAgent) {
this.creditorAgent = creditorAgent;
}
public OBInternational1 creditorAccount(OBCashAccount3 creditorAccount) {
this.creditorAccount = creditorAccount;
return this;
}
/**
* Get creditorAccount
* @return creditorAccount
**/
@ApiModelProperty(required = true, value = "")
@NotNull
@Valid
public OBCashAccount3 getCreditorAccount() {
return creditorAccount;
}
public void setCreditorAccount(OBCashAccount3 creditorAccount) {
this.creditorAccount = creditorAccount;
}
public OBInternational1 remittanceInformation(OBRemittanceInformation1 remittanceInformation) {
this.remittanceInformation = remittanceInformation;
return this;
}
/**
* Get remittanceInformation
* @return remittanceInformation
**/
@ApiModelProperty(value = "")
@Valid
public OBRemittanceInformation1 getRemittanceInformation() {
return remittanceInformation;
}
public void setRemittanceInformation(OBRemittanceInformation1 remittanceInformation) {
this.remittanceInformation = remittanceInformation;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
OBInternational1 obInternational1 = (OBInternational1) o;
return Objects.equals(this.instructionIdentification, obInternational1.instructionIdentification) &&
Objects.equals(this.endToEndIdentification, obInternational1.endToEndIdentification) &&
Objects.equals(this.localInstrument, obInternational1.localInstrument) &&
Objects.equals(this.instructionPriority, obInternational1.instructionPriority) &&
Objects.equals(this.purpose, obInternational1.purpose) &&
Objects.equals(this.chargeBearer, obInternational1.chargeBearer) &&
Objects.equals(this.currencyOfTransfer, obInternational1.currencyOfTransfer) &&
Objects.equals(this.instructedAmount, obInternational1.instructedAmount) &&
Objects.equals(this.exchangeRateInformation, obInternational1.exchangeRateInformation) &&
Objects.equals(this.debtorAccount, obInternational1.debtorAccount) &&
Objects.equals(this.creditor, obInternational1.creditor) &&
Objects.equals(this.creditorAgent, obInternational1.creditorAgent) &&
Objects.equals(this.creditorAccount, obInternational1.creditorAccount) &&
Objects.equals(this.remittanceInformation, obInternational1.remittanceInformation);
}
@Override
public int hashCode() {
return Objects.hash(instructionIdentification, endToEndIdentification, localInstrument, instructionPriority, purpose, chargeBearer, currencyOfTransfer, instructedAmount, exchangeRateInformation, debtorAccount, creditor, creditorAgent, creditorAccount, remittanceInformation);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OBInternational1 {\n");
sb.append(" instructionIdentification: ").append(toIndentedString(instructionIdentification)).append("\n");
sb.append(" endToEndIdentification: ").append(toIndentedString(endToEndIdentification)).append("\n");
sb.append(" localInstrument: ").append(toIndentedString(localInstrument)).append("\n");
sb.append(" instructionPriority: ").append(toIndentedString(instructionPriority)).append("\n");
sb.append(" purpose: ").append(toIndentedString(purpose)).append("\n");
sb.append(" chargeBearer: ").append(toIndentedString(chargeBearer)).append("\n");
sb.append(" currencyOfTransfer: ").append(toIndentedString(currencyOfTransfer)).append("\n");
sb.append(" instructedAmount: ").append(toIndentedString(instructedAmount)).append("\n");
sb.append(" exchangeRateInformation: ").append(toIndentedString(exchangeRateInformation)).append("\n");
sb.append(" debtorAccount: ").append(toIndentedString(debtorAccount)).append("\n");
sb.append(" creditor: ").append(toIndentedString(creditor)).append("\n");
sb.append(" creditorAgent: ").append(toIndentedString(creditorAgent)).append("\n");
sb.append(" creditorAccount: ").append(toIndentedString(creditorAccount)).append("\n");
sb.append(" remittanceInformation: ").append(toIndentedString(remittanceInformation)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}