Recurring Payments Data Requirements

Xplor Schools automates the processing of recurring payments for schools on behalf of parents. Xplor schools supports FIXED recurring payment plans that use the following frequencies.

Supported Frequencies

    • Quarterly
    • Monthly
    • Fortnight
    • Weekly

Xplor schools allow schools to import existing recurring payments that use "Bank Transfer" as the payment method. 

NOTE: If an existing recurring payment plan uses "Credit Card" as the payment method, these recurring payment plan will have to be manually entered into Xplor. This is so that we maintain PCI compliance when handling credit card details. 

Field Name

Comments

Data Type

Mandatory

ext_ref

 

External ID held in the SMS that is unique identifier for this parent. 

This should match your parents ext_ref against their parent file, you have previously imported into Xplor

Varchar(25)

Y

debtor_ref

Debtor ID or customer reference/Number held within the SMS that relates to an Debtor Account.

This should match your parents ext_ref against their parent file, you have previously imported into Xplor

Varchar(25)

Y

bsb

This the BSB that is associated with the parents payment method

Varchar (255

Y

account_number

This the bank account number that is associated with the parents payment method

Varchar(25)

Y

account_name

Parents name associated with the Debtor

Varchar (255)

Y

start_date

This is the date when the next transaction will  be taken out. This will also be the regular date or day in which all recurring payments will come out.

Varchar (255)

Y

end_date

The date that this recurring payment plan needs to end

Varchar (255)

Y

frequency

The frequency at which the payments will be taken out. 

 

Available frequencies

- quarterly

  • monthly
  • fortnightly
  • weekly

Varchar (255)

Y

amount

Total amount owing for this recurring payment.   

 

If this is an existing recurring payment plan, then this amount must be the remaining balance of the plan.  We use this to calculate the instalment amounts based on frequency, start and end date.

Varchar (255)

Y