Bank Interfaces (BOQ, NAB, St George): St George Interface NBI2
Banking integrations for finance applications
St George Interface NBI2
Warning: This interface has been decommissioned and is no longer available in Catch-e.
This interface allows you to submit a finance application to Soverein directly by using the Quotes / Finance "Apply" button.
If this application is transferred successfully, an "Application Reference" will populate into Catch-e.
You can login to Sovereign directly to view and further edit the application, but you can also use other Catch-e features to eliminate the need to do so.
Data transfers you can do between Catch-e and Sovereign include:
- Submit a new application to Sovereign (all new applications come from a quote)
- Resubmit an existing application to Sovereign (to update any relevant data that may have changed)
- Obtain the latest Sovereign application status
- Request lease documents from Sovereign
- Submit (signed) lease documents to Sovereign
Note: If you created a finance application directly in Sovereign, you will not be able to perform any updates to the finance application from Catch-e.
Note: The NBI2 interface replaces the first generation of St George's interface to Sovereign. Click here to read about it.
Multiple or Refinance Applications
For Catch-e users there is a simple principle to remember prior to clicking ‘Apply’ which is:
Is an existing Sovereign application to be updated with this submission?
If Yes, then user should ensure that the ‘Application Reference’ is populated.
If No, then user should ensure that the ‘Application Reference’ is removed.
When an ‘Application Reference’ is removed from a Quote, the following fields will be cleared as well to maintain data integrity in Catch-e and Sovereign:
- ‘Application Date’
- ‘Status’
- ‘Application Status’
- ‘Application Collection Date’ (this is a hidden field)
- ‘Finance Unique ID’ (this is a hidden field)
Product Type
This interface can only be used for Novated Least Contract Types. Each application is identified by a St George Product Type. The Product Type code used for an application is determined by Catch-e Contract Type to St George Product Type mapping.
FLE = Finance Lease. This product type is typically used for both an Individual Driver and Company finance application.
The option to use the St George interface is given when you set the Financier code to St George (recognised by the appropriate supplier_id advised to Catch-e).
Data Validation
This interface has been designed to eliminate the need for users to enter some data in Catch-e then additional details in Sovereign.
Catch-e performs many validations and alerts you to missing data before the application is submitted for the first time. However, in some cases, Sovereign may return alerts requiring you to enter further data before you can resubmit the application. Known errors are listed on St George Interface NBI2 Validation Errors and this also gives you an indication of how to distinguish Catch-e and Sovereign errors from each other.
Submitting a new Finance Application
An "Apply" button appears on the Quote / Finance tab when certain criteria are met:
a) The "Financier" needs to have their Suppliers / Account "Interface Type" field set as 'stgeorgenbi2'
b) The "Application Status" field is not displaying as 'successful'.
c) Login credentials for Sovereign must have been set up for the relevant user in . These are usually matched to the logged in user.
d) The Contract Type must be mapped to a St George Product Type in .
e) An active "Originator" must be selected in the "Financier Application" section.
When Apply is clicked, the application details are transmitted to Sovereign, which in turn transfers a response: (successful or unsuccessful) and if successful, the "Application Reference" is returned and displays on the Quote / Finance tab and (if created) the Contracts / Finance tab. This process takes only a few seconds.
Advance/Arrears vs. Months Deferred
When a quote has 'Arrears' selected, St. George require the application to be sent with '0' 'Months Deferred'. If Catch-e has the value of '2' entered, the application will automatically default to a '0' value to ensure the application is successful.
When a quote has 'Advance' selected, St. George require the application to be sent with the value stored in the 'Advance/Arrears' field. For example, if Catch-e has a value of '2' entered, then this value will be passed to St. George in the xml file.
Resubmitting an Application / Resubmit Triggers
When an Application Reference exists on the respective Quote / Finance or Contract / Finance tab, if any of the fields in the table below are edited, the existing application will need to be resubmitted to Sovereign. All associated quotes and contracts with the same Application Reference will be updated to 'Resubmit'.
To resubmit the application, simply go to the Quote / Finance and click Apply or the Contract / Finance tab and click Resubmit Application.
If for some reason you wish to resubmit an application manually, you can edit the "Status" field on the Quote / Finance or Contract / Finance to 'Resubmit'. Once saved, click Apply (on Quote / Finance) or Resubmit Application (on Contract / Finance).
Get Application Status
A Get Application Status button has been added to the Quote / Finance or Contract / Finance screens. This will obtain the latest Sovereign Applications status. The Get Application Status button is only be available when an Application Reference is evident. If the "Status" is 'Resubmit' or 'Failed", the Get Application Status button is disabled.
"Status" shows the status of the application from Catch-e's point of view. If 'Successful', the application data has successfully been submitted to Sovereign, if 'Failed', the application data has not reached Sovereign for some reason.
"Application Status" is the status of the application from Sovereign's point of view. This field is not editable. It can only be updated by using the Get Application Status button.
If a Quote is linked to a Contract (or vice versa) and the Get Application Status button is used, both "Application Status" fields will be updated on the Quote / Finance and Contract / Finance tabs.
Contracts / Finance tab Get Documents button
A Get Documents button is located on the Contracts / Finance tab.
If the Finance Application "Status" is ? the Get Documents button is visible, otherwise it's hidden.
When the Get Documents button is clicked, the following documents will be requested from St George and if successful, will be created as Contracts / Events.
- DOC03 - Finance Lease Agreement
- DOC32 - New Settlement Fax Header
- DOC39 - Novated Lease Agreement
There are a small number of fields that are only available from the Contract tabs that can be used to populate data on these documents (eg VIN, Engine Number & Reg No). If you wish to have these fields populated in the documents you will need to add the data in Catch-e fields, then Resubmit the application (see notes above) and wait for the email from St George advising when the documents are ready to be retrieved.
If the Sovereign documents are unavailable at the time this service is triggered you will be notified via a pop up message:
Message from St George: No attachments can be found for the request.
Typically you will be notified by email from St George when the documents are ready to be retrieved. Documents will then be available within 1-2 minutes of receipt of the email notification from St George.
The Get Documents button will only be available when the Financier’s "Interface Type" = 'stgeorgenbi2' and an Application Reference is evident.
If any of the Resubmit fields are updated the "Application Status" will be updated to 'Resubmit' as mentioned above. At the same time any documents stored in Contracts / Events will be updated to 'deleted' and will no longer be visible, no matter what its current status is .
If "Status" is 'Resubmit" the Get Documents button is disabled. New Contract Events will be created every time, due to the re-submit requirements as mentioned above. A fresh set of documents will need to be created by clicking the Get Documents button to commence the document retrieval process, (Note you may need to wait for the email from St George when the documents are ready to be retrieved again).
Submit Documents (to Sovereign)
A Contract Event is to used to send documents to Sovereign.
The Event type is 'STG Settlement Documents'.
Please follow these steps to submit the documents to St George:
1) Create new Contract Event. At this stage the icon to the left of the Event ‘Type’ field will be ** to signify that the document is not ready to be sent.
2) Attach a single document to the Contract Event. At this stage the icon to the left of the Event ‘Type’ field will be ** to signify that the document is ready to be sent. **
You will need to scan the complete document set and save it as a *.tiff, or *.tif file. St George/Sovereign cannot accept other file types and will be rejected if attempted. The maximum file size is 10MB.**
3) Click the ** icon to send the document to Sovereign.
At this stage the icon will be updated to either ** if a successful submission response to St George is received, or ** if the submission failed.
If the transmission failed, hover mouse pointer over the ** icon to view the error description then correct the issue and click the ** icon again to send the document to Sovereign.
Establishment Fee
The 'Establishment Fee' defaults from establishmentfee, however the data sent to St George for the Sovereign field 'Establishment Fee' will come from establishmentfeecost. If there is a positive balance (ie a difference between establishmentfee and establishmentfeecost) the amount will be added to the Brokerage calculation and sent to St George for the Sovereign field 'Brokerage'. For the entire 'Establishment Fee' value to be sent to St George the fields establishmentfee and establishmentfee_cost must be equal.
Other Lease Inclusion
Other Lease Inclusion is mapped to the "Other Brokerage" field in Sovereign. To map this to "Other Insurance" instead, set the to 'no'.
Data Mapping
Please open the attached spreadsheet to see how data is mapped from Catch-e to Sovereign. Note the mapping document is a work in progress and does not contain every mapped field.