Skip to main content

Fields

endDate : Date

The date on which the instalment schedule will end.

frequency : String

The base unit of frequency at which payments are to be taken.

frequencyMultiplier : Int

The multiple of the frequency at which payments are taken.

paymentDay : Int

The day of the month/week at which to take payment.

totalGrossAmount : Int

The total amount to be paid as part of the instalment schedule.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "endDate": "2019-12-04", "frequency": "agency-modern-bed-song-beat", "frequencyMultiplier": 5, "paymentDay": 50, "totalGrossAmount": 8 }