Just want to check with you, I noticed when you create a payment schedule, it deletes all existing scheduled payments. Is it possible to have an option to NOT delete existing payments?

Ezidebit API has a flag that allows you to keep existing payments, it would be useful to do the same, is it possible in IntegraPay?

Thanks,

Mark

Alistair here from the IntegraPay Customer Integration team, to assist with your query about payment schedules.

We do allow the creation of new payment schedules without deleting existing scheduled payments; however, doing so is currently subject to some fairly strict requirements.

To create the new schedule, you will need to use the ScheduleGenerate function described in our general Integration API document (attached).  The scheduleType must be “LIMITED”, either by transaction count or total amount, and you must provide a scheduleID to uniquely identify the new schedule.  As you may have guessed, this allows you to associate multiple schedules with a payer, leaving any existing schedules unchanged.  Note that you can later re-use the ScheduleGenerate function with the same scheduleID to modify or cancel the specified schedule.

Unfortunately the creation of multiple schedules is not currently possible via our Console website: only via the API.

If I have misunderstood your query, or you have any further questions, please just let me know.

Cheers,

Alistair Grant

Senior .NET / SQL Developer

P +61 7 3040 4320

E [email protected] | www.integrapay.com.au

IntegraPay |  IntegraPay | @IntegraPay | /company/integrapay-pty-ltd

Say if a payer currently has no schedule. Business then scheduled a $100 payment, not as a schedule but just a single payment. Later, business also wants to create a schedule of $50 per month with no end date (ongoing). The $100 single payment needs to stay as it is unrelated to the schedule.

What would we need to do in this case?

thanks,

mark

Luckily, your example is actually simpler than using multiple schedules with different scheduleID values.

If the business has scheduled a $100 payment, and wants to schedule ongoing $50 payments starting after the $100 payment, just use ScheduleGenerate with a removeAllPaymentsBeforeStartDate value of false, as per the following example (which has a start date of 30 Sep 2017):

<ScheduleGenerate>

<username>****</username>

< password>***********</password>

<payerUniqueID>????????</payerUniqueID>

<scheduleType>UNENDING</scheduleType>

<transactionAmountInCents>5000</transactionAmountInCents>

<frequency>MONTHLY</frequency>

<frequencyDay>15</frequencyDay>

<startDate>20170930</startDate>

<removeAllPaymentsBeforeStartDate>false</removeAllPaymentsBeforeStartDate>

</ScheduleGenerate>

As long as the startDate is after the date of the $100 payment, that initial payment will be unaffected by the new schedule.

Cheers,

Alistair Grant

Senior .NET / SQL Developer

P +61 7 3040 4320

E [email protected] | www.integrapay.com.au

IntegraPay |  IntegraPay | @IntegraPay | /company/integrapay-pty-ltd

But if it was AFTER the new schedule start date then what are our options in terms of keeping all existing payments there?

The reason I’m asking this is because I don’t know what situation it may be, it could be before or could be after the schedule start date. We just don’t want the schedule to remove ANY previously scheduled payment.

E.g. it could be that a payer has an invoice to pay across 12 monthly instalments so there are 12 single payments scheduled. The fact that we now also want to add a $50 per fortnight DD should not mean the previously generated payments are going to be removed. In my mind any previously generated payments should just stay as-is, otherwise business could easily lose a previously scheduled payment?

In the scenario you described, the easiest solution would be to generate both schedules as per my initial suggestion: a monthly schedule of 12 payments with scheduleID value ‘A’, and a second $50 fortnightly schedule with a scheduleID value ‘B’ (where ‘A’ and ‘B’ are, of course, actually unique schedule IDs).

As noted, both these schedules will need to be “LIMITED” by either count or total amount.  The first schedule can simply be limited by a count of 12 payments; for the second “unending” schedule, it is currently possible to specify up to 500 payments (which, for fortnightly payments, equates to around 20 years).

One other alternative is to set up multiple “payer” entries: one for each schedule.  This allows considerable flexibility in terms of scheduling, but does have a number of downsides, including having to duplicate information about the same actual payer across each of these “payer” entries.

If the above still does not allow you to implement the behaviour you’re after, please just let me know.

Cheers,

Alistair Grant

Senior .NET / SQL Developer

P +61 7 3040 4320

E [email protected] | www.integrapay.com.au

IntegraPay |  IntegraPay | @IntegraPay | /company/integrapay-pty-ltd