Passing additional payment detail for Get Agreed Payment Schedule

Question

In the response to the Get Agreed Payment Schedule API, should the DH provide details of any once-off payment arrangements, or payment extensions, such as deferrals or any once-off top-up plan details? 

For example, if a customer usually pays $50 every fortnight via direct debit, and seeks a 21-day deferral to pay their upcoming payment, is it acceptable to pass only the usual payment schedule details rather than the additional deferral details?     

Answer

It is perfectly acceptable to provide only the usual payment schedule details as a response to the Get Agreed Payment Schedule API call. In this case, the field mapping for the example provided is:

amount = 50
paymentscheduleUtype = directdebit
PaymentFrequency = fortnightly