uk.org.openbanking.datamodel.payment.OBDomesticStandingOrder3 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.
*/
/*
* Payment Initiation API
* Swagger for Payment Initiation API Specification
*
* OpenAPI spec version: v3.1.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package uk.org.openbanking.datamodel.payment;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.joda.time.DateTime;
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 domestic standing order.
*/
@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 domestic standing order.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-23T11:45:43.255+01:00")
public class OBDomesticStandingOrder3 {
@JsonProperty("Frequency")
private String frequency = null;
@JsonProperty("Reference")
private String reference = null;
@JsonProperty("NumberOfPayments")
private String numberOfPayments = null;
@JsonProperty("FirstPaymentDateTime")
private DateTime firstPaymentDateTime = null;
@JsonProperty("RecurringPaymentDateTime")
private DateTime recurringPaymentDateTime = null;
@JsonProperty("FinalPaymentDateTime")
private DateTime finalPaymentDateTime = null;
@JsonProperty("FirstPaymentAmount")
private OBDomesticStandingOrder3FirstPaymentAmount firstPaymentAmount = null;
@JsonProperty("RecurringPaymentAmount")
private OBDomesticStandingOrder3RecurringPaymentAmount recurringPaymentAmount = null;
@JsonProperty("FinalPaymentAmount")
private OBDomesticStandingOrder3FinalPaymentAmount finalPaymentAmount = null;
@JsonProperty("DebtorAccount")
private OBCashAccountDebtor4 debtorAccount = null;
@JsonProperty("CreditorAccount")
private OBCashAccountCreditor3 creditorAccount = null;
@JsonProperty("SupplementaryData")
private OBSupplementaryData1 supplementaryData = null;
public OBDomesticStandingOrder3 frequency(String frequency) {
this.frequency = frequency;
return this;
}
/**
* Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(EvryDay)$|^(EvryWorkgDay)$|^IntrvlDay:(0?[2-9]|[1-2][0-9]|3[0-1])$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
*
* @return frequency
**/
@NotNull
@Pattern(regexp = "^(EvryDay)$|^(EvryWorkgDay)$|^IntrvlDay:(0?[2-9]|[1-2][0-9]|3[0-1])$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$")
@Size(min = 1, max = 35)
@ApiModelProperty(required = true, value = "Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(EvryDay)$|^(EvryWorkgDay)$|^IntrvlDay:(0?[2-9]|[1-2][0-9]|3[0-1])$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$")
public String getFrequency() {
return frequency;
}
public void setFrequency(String frequency) {
this.frequency = frequency;
}
public OBDomesticStandingOrder3 reference(String reference) {
this.reference = reference;
return this;
}
/**
* Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
*
* @return reference
**/
@Size(min = 1, max = 35)
@ApiModelProperty(value = "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.")
public String getReference() {
return reference;
}
public void setReference(String reference) {
this.reference = reference;
}
public OBDomesticStandingOrder3 numberOfPayments(String numberOfPayments) {
this.numberOfPayments = numberOfPayments;
return this;
}
/**
* Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
*
* @return numberOfPayments
**/
@Size(min = 1, max = 35)
@ApiModelProperty(value = "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.")
public String getNumberOfPayments() {
return numberOfPayments;
}
public void setNumberOfPayments(String numberOfPayments) {
this.numberOfPayments = numberOfPayments;
}
public OBDomesticStandingOrder3 firstPaymentDateTime(DateTime firstPaymentDateTime) {
this.firstPaymentDateTime = firstPaymentDateTime;
return this;
}
/**
* The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
*
* @return firstPaymentDateTime
**/
@NotNull
@Valid
@ApiModelProperty(required = true, value = "The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00")
public DateTime getFirstPaymentDateTime() {
return firstPaymentDateTime;
}
public void setFirstPaymentDateTime(DateTime firstPaymentDateTime) {
this.firstPaymentDateTime = firstPaymentDateTime;
}
public OBDomesticStandingOrder3 recurringPaymentDateTime(DateTime recurringPaymentDateTime) {
this.recurringPaymentDateTime = recurringPaymentDateTime;
return this;
}
/**
* The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
*
* @return recurringPaymentDateTime
**/
@Valid
@ApiModelProperty(value = "The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00")
public DateTime getRecurringPaymentDateTime() {
return recurringPaymentDateTime;
}
public void setRecurringPaymentDateTime(DateTime recurringPaymentDateTime) {
this.recurringPaymentDateTime = recurringPaymentDateTime;
}
public OBDomesticStandingOrder3 finalPaymentDateTime(DateTime finalPaymentDateTime) {
this.finalPaymentDateTime = finalPaymentDateTime;
return this;
}
/**
* The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
*
* @return finalPaymentDateTime
**/
@Valid
@ApiModelProperty(value = "The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00")
public DateTime getFinalPaymentDateTime() {
return finalPaymentDateTime;
}
public void setFinalPaymentDateTime(DateTime finalPaymentDateTime) {
this.finalPaymentDateTime = finalPaymentDateTime;
}
public OBDomesticStandingOrder3 firstPaymentAmount(OBDomesticStandingOrder3FirstPaymentAmount firstPaymentAmount) {
this.firstPaymentAmount = firstPaymentAmount;
return this;
}
/**
* Get firstPaymentAmount
*
* @return firstPaymentAmount
**/
@NotNull
@Valid
@ApiModelProperty(required = true, value = "")
public OBDomesticStandingOrder3FirstPaymentAmount getFirstPaymentAmount() {
return firstPaymentAmount;
}
public void setFirstPaymentAmount(OBDomesticStandingOrder3FirstPaymentAmount firstPaymentAmount) {
this.firstPaymentAmount = firstPaymentAmount;
}
public OBDomesticStandingOrder3 recurringPaymentAmount(OBDomesticStandingOrder3RecurringPaymentAmount recurringPaymentAmount) {
this.recurringPaymentAmount = recurringPaymentAmount;
return this;
}
/**
* Get recurringPaymentAmount
*
* @return recurringPaymentAmount
**/
@Valid
@ApiModelProperty(value = "")
public OBDomesticStandingOrder3RecurringPaymentAmount getRecurringPaymentAmount() {
return recurringPaymentAmount;
}
public void setRecurringPaymentAmount(OBDomesticStandingOrder3RecurringPaymentAmount recurringPaymentAmount) {
this.recurringPaymentAmount = recurringPaymentAmount;
}
public OBDomesticStandingOrder3 finalPaymentAmount(OBDomesticStandingOrder3FinalPaymentAmount finalPaymentAmount) {
this.finalPaymentAmount = finalPaymentAmount;
return this;
}
/**
* Get finalPaymentAmount
*
* @return finalPaymentAmount
**/
@Valid
@ApiModelProperty(value = "")
public OBDomesticStandingOrder3FinalPaymentAmount getFinalPaymentAmount() {
return finalPaymentAmount;
}
public void setFinalPaymentAmount(OBDomesticStandingOrder3FinalPaymentAmount finalPaymentAmount) {
this.finalPaymentAmount = finalPaymentAmount;
}
public OBDomesticStandingOrder3 debtorAccount(OBCashAccountDebtor4 debtorAccount) {
this.debtorAccount = debtorAccount;
return this;
}
/**
* Get debtorAccount
*
* @return debtorAccount
**/
@Valid
@ApiModelProperty(value = "")
public OBCashAccountDebtor4 getDebtorAccount() {
return debtorAccount;
}
public void setDebtorAccount(OBCashAccountDebtor4 debtorAccount) {
this.debtorAccount = debtorAccount;
}
public OBDomesticStandingOrder3 creditorAccount(OBCashAccountCreditor3 creditorAccount) {
this.creditorAccount = creditorAccount;
return this;
}
/**
* Get creditorAccount
*
* @return creditorAccount
**/
@NotNull
@Valid
@ApiModelProperty(required = true, value = "")
public OBCashAccountCreditor3 getCreditorAccount() {
return creditorAccount;
}
public void setCreditorAccount(OBCashAccountCreditor3 creditorAccount) {
this.creditorAccount = creditorAccount;
}
public OBDomesticStandingOrder3 supplementaryData(OBSupplementaryData1 supplementaryData) {
this.supplementaryData = supplementaryData;
return this;
}
/**
* Get supplementaryData
*
* @return supplementaryData
**/
@Valid
@ApiModelProperty(value = "")
public OBSupplementaryData1 getSupplementaryData() {
return supplementaryData;
}
public void setSupplementaryData(OBSupplementaryData1 supplementaryData) {
this.supplementaryData = supplementaryData;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
OBDomesticStandingOrder3 obDomesticStandingOrder3 = (OBDomesticStandingOrder3) o;
return Objects.equals(this.frequency, obDomesticStandingOrder3.frequency) &&
Objects.equals(this.reference, obDomesticStandingOrder3.reference) &&
Objects.equals(this.numberOfPayments, obDomesticStandingOrder3.numberOfPayments) &&
Objects.equals(this.firstPaymentDateTime, obDomesticStandingOrder3.firstPaymentDateTime) &&
Objects.equals(this.recurringPaymentDateTime, obDomesticStandingOrder3.recurringPaymentDateTime) &&
Objects.equals(this.finalPaymentDateTime, obDomesticStandingOrder3.finalPaymentDateTime) &&
Objects.equals(this.firstPaymentAmount, obDomesticStandingOrder3.firstPaymentAmount) &&
Objects.equals(this.recurringPaymentAmount, obDomesticStandingOrder3.recurringPaymentAmount) &&
Objects.equals(this.finalPaymentAmount, obDomesticStandingOrder3.finalPaymentAmount) &&
Objects.equals(this.debtorAccount, obDomesticStandingOrder3.debtorAccount) &&
Objects.equals(this.creditorAccount, obDomesticStandingOrder3.creditorAccount) &&
Objects.equals(this.supplementaryData, obDomesticStandingOrder3.supplementaryData);
}
@Override
public int hashCode() {
return Objects.hash(frequency, reference, numberOfPayments, firstPaymentDateTime, recurringPaymentDateTime, finalPaymentDateTime, firstPaymentAmount, recurringPaymentAmount, finalPaymentAmount, debtorAccount, creditorAccount, supplementaryData);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OBDomesticStandingOrder3 {\n");
sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n");
sb.append(" reference: ").append(toIndentedString(reference)).append("\n");
sb.append(" numberOfPayments: ").append(toIndentedString(numberOfPayments)).append("\n");
sb.append(" firstPaymentDateTime: ").append(toIndentedString(firstPaymentDateTime)).append("\n");
sb.append(" recurringPaymentDateTime: ").append(toIndentedString(recurringPaymentDateTime)).append("\n");
sb.append(" finalPaymentDateTime: ").append(toIndentedString(finalPaymentDateTime)).append("\n");
sb.append(" firstPaymentAmount: ").append(toIndentedString(firstPaymentAmount)).append("\n");
sb.append(" recurringPaymentAmount: ").append(toIndentedString(recurringPaymentAmount)).append("\n");
sb.append(" finalPaymentAmount: ").append(toIndentedString(finalPaymentAmount)).append("\n");
sb.append(" debtorAccount: ").append(toIndentedString(debtorAccount)).append("\n");
sb.append(" creditorAccount: ").append(toIndentedString(creditorAccount)).append("\n");
sb.append(" supplementaryData: ").append(toIndentedString(supplementaryData)).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 ");
}
}