Standing Orders

{
  bankId: "Bank id to authorise payment from", // required
  payeeId: "Id of payee", // payeeId or payee required
  payee: { // payeeId or payee required
    accountNumber: "12345678",
    sortCode: "123456",
    name: "payee name"
  },
  payeeType: "Payee type [api-payee|mh-user-account]", // optional - 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 standing order",
  frequency: {
    repeat: "The frequency to repeat the standing order [Daily,Weekly,Monthly]",
    day: "The number of the day of the repeating period to make the payment",
    week: "The number of the week of the repeating period to make the payment",
    onlyWorkDays: "Specifies whether the payment should only be made on working days",
    month: "The number of the month on which to repeat the payment",
    region: "The region for dates of quarterly payments"
  },
  numberOfPayments: "The number of payments to complete the standing order", // required if finalPaymentDate is not specified
  firstPaymentAmount: "Amount in pence to authorize payment",
  recurringPaymentAmount: "Amount in pence to authorize payment", // optional when it is the same as the first amount
  finalPaymentAmount: "Amount in pence to authorize payment", // optional when it is the same as the first amount
  currency: "The currency code for the standing order amount [GBP]",
  firstPaymentDate: "The date to make the first payment",
  recurringPaymentDate: "The date to make the first repeating payment",
  finalPaymentDate: "The date to make the final payment", // required if numberOfPayments is not specified
  state: "your state value",
  nonce: "your nonce value", // optional
  context: "Payment context [Other,BillPayment,PartyToParty]", // optional - defaults to PartyToParty
  claims: claimsObject, // optional
}

{
      payeeId: "14edab6d-7aed-4ed3-b01b-9592a5d539c6", // An API Payee
      bankId: "5233db2a04fe41dd01d3308ea92e8bd7", // Ozone bank
      reference: "Payments over 6 days",
      frequency: {
        repeat: "Daily"
      },
      firstPaymentAmount: 10000,
      recurringPaymentAmount: 3023,
      finalPaymentAmount: 1554,
      currency: "GBP",
      firstPaymentDate: "2021-03-16T00:00:00.000Z",
      recurringPaymentDate: "2021-03-17T00:00:00.000Z",
      finalPaymentDate: "2021-03-22T00:00:00.000Z",
      state: "foo",
      nonce: "bar",
}

{
      payeeId: "70c863f4-4840-4b98-babb-aeb8089eeba1", // An API Payee
      bankId: "5233db2a04fe41dd01d3308ea92e8bd7", // Ozone bank
      reference: "20 Pounds Monthly",
      frequency: {
        repeat: "Monthly",
        day: 30, // On the 30th of the month
      },
      numberOfPayments: 12,
      firstPaymentAmount: 2000,
      currency: "GBP",
      firstPaymentDate: "2021-03-16T00:00:00.000Z",
      state: "foo",
      nonce: "bar",
}