StandingOrderDetails Data Type

Details of underlying standing orders.

Properties
name data type constraints description
startDate string required The first applicable day of execution starting from this date is the first payment.
frequency FrequencyCode required Get frequency
endDate string   The last applicable day of execution. If not given, it is an infinite standing order.
executionRule ExecutionRule   Get executionRule
withinAMonthFlag boolean   This element is only used in case of frequency equals \"monthly\". If this element equals false it has no effect. If this element equals true, then the execution rule is overruled if the day of execution would fall into a different month using the execution rule. Example: executionRule equals \"preceding\", dayOfExecution equals \"02\" and the second of a month is a Sunday. In this case, the transaction date would be on the last day of the month before. This would be overruled if withinAMonthFlag equals true and the payment is processed on Monday the third of the Month. Remark: This attribute is rarely supported in the market.
monthsOfExecution array of MonthOfExecution   The format is following the regular expression \d{1,2}. The array is restricted to 11 entries. The values contained in the array entries shall all be different and the maximum value of one entry is 12. This attribute is contained if and only if the frequency equals "MonthlyVariable". Example: An execution on January, April and October each year is addressed by ["1", "4", "10"].
multiplicator number   This is multiplying the given frequency resulting the exact frequency, e.g. Frequency=weekly and multiplicator=3 means every 3 weeks. Remark: This attribute is rarely supported in the market.
dayOfExecution DayOfExecution   Get dayOfExecution
limitAmount Amount   Get limitAmount

Example

{
  "startDate" : "...",
  "frequency" : "EVERYTWOWEEKS",
  "endDate" : "...",
  "executionRule" : "FOLLOWING",
  "withinAMonthFlag" : true,
  "monthsOfExecution" : [ "_8", "_7" ],
  "multiplicator" : 12345,
  "dayOfExecution" : "_31",
  "limitAmount" : {
    "currency" : "...",
    "amount" : "..."
  }
}