Introduction
The following notes on scheduled payments, and related CDS schema, are gathered from Subject Matter Expert guidance and responses to participant support issues.
BankingScheduledPayment
The following items are related to the BankingScheduledPayment schema. See also the BankingScheduledPaymentTo schema.
The payeeReference field
The payeeReference
field indicates the default value of the reference in any payment generated from the schedule.
The paymentSet
array must contain at least one entry, which in turn must contain a BankingScheduledPaymentTo object value in the to
field.
The payeeReference
field in the BankingScheduledPaymentTo object applies to that specific payment. If a payment in the array has no payeeReference
, its payeeReference takes the default value supplied for BankingScheduledPayment.payeeReference.
In the BankingScheduledPayment example below, the third entry for Louise has an empty payeeReference
field, so the applicable payee reference is "AAA", the value for the parent BankingScheduledPayment.
[
{
...
"payeeReference": "AAA", /* Default payeeReference for payments in paymentSet with no payeeReference */
...
},
"paymentSet": [
{
"to": {
...
"nickname": "Janice",
"payeeReference": "BBB",
...
},
...
},
{
"to": {
"nickname": "Kate",
"payeeReference": "CCC",
...
},
},
to": {
"nickname": "Louise",
"payeeReference": "", /* Louise defaults to payeeReference "AAA" */
...
},
...
}
]
BankingScheduledPaymentInterval
The following items are related to the BankingScheduledPaymentInterval schema.
The interval and dayInInterval fields
Scheduled payment intervals are to be formatted according to ISO 8601 Durations. An example is the CDS schema BankingScheduledPaymentInterval.
This schema includes the fields interval
and dayInInterval
.
Examples of ISO 8601 durations follow.
A dayInInterval
value of P90D
indicates payment on the 90th day of the interval.
To indicate the last day of a three month interval, set interval
= P3M
and dayInInterval
= P0D
.
If the value of dayInInterval
is greater than the number of days in the interval, the payment takes place on the last day of the interval, so P100D
also indicates the last day of a three month interval.
If the payment is made on the 10th day once every 3 months, then the dayInInterval
is P10D
.
If the payment is instead made on the 10th day of every month, then the interval
= P1M
and the dayInInterval
= P10D
.
Further examples are available in the knowledge base article Scheduled Payment Recurrence and intervals.
If scheduled payment intervals begin on the day the first payment is made, then dayInInterval
=P1D
.
The dayInInterval
field was introduced in response to a request to make the next payment date optional.
See the dayInInterval
field description in BankingScheduledPaymentInterval.
Comments
1 comment
dayInInterval
'P10D' or '10' in the example above?
if a payment is made weekly on a Monday, is this correct?
Please sign in to leave a comment.