Al Faisal — Integrations¶
Integration Overview¶
| # | External System | Direction | Type | Status |
|---|---|---|---|---|
| INT-001 | Central (SIS) | Inbound | API (built, not in active use) | On hold — using CSV interim |
| INT-002 | eway (credit card) | Outbound | API | Active |
| INT-003 | Bank (direct debit / ABA) | Outbound | File (ABA) | Active |
INT-001: Central (SIS Integration)¶
Purpose¶
Imports student and campus data from Al Faisal's Student Information System (Central) into NetSuite to support billing instruction generation.
Technical Details¶
- Protocol: API
- Direction: Central → NetSuite
- Built By: MJ
- Data: Student records, campus assignments, enrollment status
- Current Status: On hold — integration was built and ran for approximately one year but is not currently being used due to data quality issues (see Known Issues)
Current Workaround¶
Billing instructions are prepared via CSV. The team manually reconciles student counts per campus with the school before each billing cycle. Corrections are applied manually where Central's campus assignments are incorrect.
Path Forward¶
The Central API integration should be re-evaluated and stabilized before re-activating the automated configurator. Requires investigation into Central's data quality issues and API reliability.
INT-002: eway (Credit Card Processing)¶
Purpose¶
Processes credit card payments from parents as part of the daily RPS run.
Technical Details¶
- Protocol: API (eway payment gateway)
- Direction: NetSuite → eway
- Trigger: Daily scheduled script, per RPS processing date
- Response: Authorization code —
00= approved; other codes = declined - Data: Card details (stored encrypted), payment amount, reference
Flow¶
- Daily script picks up all credit card RPS records with today's processing date
- Submits payment request to eway API
- Receives authorization response
- On success: creates payment record in NetSuite, applies to invoice
- On failure: stores decline code on RPS record for school follow-up
INT-003: Bank — Direct Debit (ABA File)¶
Purpose¶
Processes direct debit payments from parents via ABA file upload to the school's bank portal.
Technical Details¶
- Protocol: File-based (ABA format)
- Direction: NetSuite → ABA file → Bank portal
- Trigger: Daily scheduled script, per RPS processing date
- Format: Australian Bankers' Association (ABA) fixed-width file
Flow¶
- Daily script generates ABA file for all direct debit RPS records due today
- School downloads file from NetSuite
- School uploads file to bank portal
- Bank processes direct debits (typically overnight)
- School downloads bank report and applies deposit in NetSuite
- Payments move from Undeposited Funds to bank account
Authentication¶
| Method | Used For | Notes |
|---|---|---|
| OTP (One-Time Password) | Parent payment suitelet | Unique URL per family (debtor code + transaction ID); OTP verification on access |