Bookings Configuration End Point

The core Bookings configuration is managed via a single getConfig end point.

The BookAndPay.getConfig end point holds all of the configuration for Bookings. It is the only component that should be edited during the installation process. Its namespace follows the standard GOSS configuration structure: config.environment.application.getConfig.

For example, a Bookings configuration end point set up in a development environment will have the namespace config.dev.BookAndPay.getConfig.

The end point contains the following properties.

Email Links

These links are used in the confirmation email (see Email and Message Template Configuration) and allow the booker to manage their booking.

Core Settings

Payment Provider Configuration

A single payment provider can be configured per Bookings installation, set in the paymentProvider property. The current supported providers are:

• Adelante Smart Pay (Multi-Item)
• Capita Paye.net (Pay360)
• Capita SCP (Pay360)
• Capita SCP Multi Item (Pay360)
• Civica
• Civica eStore
• PayPal
• GOV.UK Pay
• Secure Trading Payments
• WorldPay

Payment Reconciliation

The Civica, Worldpay and Capita SCP Multi-Item payment field types support payment reconciliation. Sites that use these providers follow the same booking and payment steps as other payment providers, but in the background additional calls are made to the payment provider portal to confirm the success of the payment, releasing the tickets if the payment is not successful.

These payment providers require the following additional configuration:

1. Configuration end points
   • Civica - config.[environment].BookAndPay.getConfig add the URL of the Query Payments API to the baseUrl property
     config.civicaSettings.settings = [{
    settingsId: "1",
    baseUrl: "https://www.civicaepay.co.uk/MyOrganisationXMLTest",
    callingApplicationId: "GOSSTest"
}]
     The IP address of the iCM site needs to be whitelisted with Civica before the payment API can be used. 
   • World Pay - If payment reconciliation is not already set up, a configuration end point needs to be created at config.[environment].Worldpay.getConfig with the following:
     function(params, credentials) {
    return {
        credentials: [{
            username: "example",
            password: "example"
        }],
        defaults: {
            username: "example"
        }
    };
}
   • Capita SCP Multi-Item - If payment reconciliation is not already set up, a configuration end point needs to be created at config.[environment].CapitaSCP.getConfig with the following:
     function(params, credentials) {
    return {
        keys: [{
            id: 456,
            secret: "my==secret"
        }],
        defaults: {
            key: 456
        }
    };
}
2. All website users who need to pay for bookings must be added to a user group called PAYMENT RECONCILIATION for the reconciliation workflow to start
3. A Data Retention Policy should be set up for the Payment Reconciliation process. The schedule cannot be set up until the first process has started (because the DRM looks for existing histories)