Recurring Payments (VRP)

{
  bankId: "Bank id to authorise payment from",
  payeeId: "Id of payee", // required or payee
  payeeType: "Payee type [api-payee|mh-user-account]", // defaults to api-payee
  payerId: "Id of payer", // required only if payerType is defined
  payerType: "Payer type [mh-user-account]", // required only if payerId is used
  reference: "The reference for recurring payment",
  validFromDate: "The date from which the authorisation is effective", // should be in an international format, e.g. 15-MAR-2021 or ISO date
  validToDate: "The date to which the authorisation is effective", // optional - should be in an international format, e.g. 15-MAR-2021 or ISO date
  maximumIndividualAmount: "The maximum single amount that will be allowed", // the valid in whole minor units (i.e. pence)
  currency: "The currency code for the maxiumum recurring payment amount [GBP]",
  periodicLimits: [
    {
      amount: "The maximum amount for this recurring payment limit", // the valid in whole minor units (i.e. pence)
      currency: "The currency code for this recurring payment limit [GBP]",
      periodType:
        "The period over which the limit is effective [Day, Week, Fortnight, Month, Half-year, Year]",
      periodAlignment:
        "Specifies whether the period starts on the date of consent creation or lines up with a calendar [Consent, Calendar]",
    },
  ],
  type: [
    "Sweeping", // Specifies that the recurring payment is for the purpose of sweeping payments
    "Other", // Specifies that the recurring payment is for other payments of another purpose
  ],
  context: "Payment context [Other,BillPayment,PartyToParty]", // optional - defaults to PartyToParty
  state: "your state value",
  nonce: "your nonce value", // optional
}

{
  payeeId: "14edab6d-7aed-4ed3-b01b-9592a5d539c6", // An API Payee
  payeeType: "api-payee",
  bankId: "5233db2a04fe41dd01d3308ea92e8bd7", // Ozone bank
  reference: "VRP01",
  validFromDate: "2022-03-01T00:00:00.000Z",
  validToDate: "2022-04-01T00:00:00.000Z",
  maximumIndividualAmount: 1000, // £10
  currency: "GBP",
  periodicLimits: [
    {
      amount: 2000,
      currency: "GBP",
      periodType: "Day",
      periodAlignment: "Consent",
    }
  ],
  type: "Sweeping",
  context: "PartyToParty",
  state: "foo",
  nonce: "bar",
}

{
  payeeId: "payee-id", // optional if specified in the consent
  payeeType: "api-payee", // [api-payee|mh-user-account] 
  amount: 150, // in pence
  payeeRef: "Payee ref",
  payerRef: "Payer ref",
}

{      
  payeeId: "03d1bb92-dff1-49ed-8721-62090936bb3a",
  payeeType: "api-payee",
  amount: 1000,
  payeeRef: "PAYEE-REF",
  payerRef: "PAYER-REF",
}