Service NSW Vouchers

This integration allows for the automatic validation and redemption of Service NSW Creative Kids vouchers when they are used to enrol into specific courses. The process invloves allowing users with a valid creative kids voucher to use an oncourse voucher product which you’ll call Creative Kids $100 Voucher to pay for their online enrolment, and then use the scripts and integration to redeem the value of the voucher from the NSW Government.

Be aware, you must seek approval from Service NSW before you can access their API. They will not give you credentials needed to use this integration without completing their 'compliance check and risk assessment'

To seek approval prior to using this integration, email the following details to [email protected]:

  • Business name
  • Provider name (if different)
  • ABN/ACN

We’re told this process can take anywhere between 10-15 days to complete.

There are a number of steps to getting this integration working so ensure that you go through them carefully, as missing any step will cause the entire process to not work.

  1. Create three new custom fields and ensure that you match exactly the details below:

    • Name = Creative Kids Student Full Name, key = creativeKidsStudentName, Data Type = Text, Record Type = Sale (Voucher)
    • Name = Creative Kids Voucher Number, key = serviceNswVoucher, Data Type = Pattern Text, Record Type = Sale (Voucher), Pattern = 9[0-9a-zA-Z]{15}
    • Name = Service NSW Redeemed On, key = serviceNswRedeemedOn, Data Type = Date time, Record Type = Sale (Voucher)
  2. Create a new Voucher Type, called 'Creative Kids $100 Voucher'. This voucher will be used to allow people to enrol online using their CK vouchers. The voucher type should be set as 'can be redeemed for value', with a value of $100 and cost of $0. You’ll also need to set a data collection rule for the voucher type, use whatever choice you deem suitable.

  3. You’ll then need to add relations between the kids courses you’ll want to allow folks to enrol in using this voucher. Make sure to use a relationship type that includes the 'Suggestion' cart action. By default the 'Similar courses' relationship will use this. This means that in the Checkout, users will be suggested that they add the voucher to their cart.

  4. Set up a new data collection form for Vouchers, and add into it two of your custom field questions; Creative Kids Student Full Name and Creative Kids Voucher Number.

  5. Go to Integrations (in the Automation window) and in the Service NSW Vouchers box click 'Next'.

  6. There are several details you’ll need to add here. All of these details come from Service NSW so if none of these sections make sense, your contact at Service NSW should be able to help you get these. Add a name for the integration (this can be anything of your choice), select a voucher type (CK - creative kids, or AK - active kids, you want to select CK). Store channel code, POS terminal id, Programme and API key are all fields need to get the details for from Service NSW before you finish.

  7. Once that is set, the last step is to activate the two Service NSW scripts in the Scripts section. The validation script runs on enrolment creation, and will validate the details of any CK Voucher used to enrol online. If the details are incorrect, you’ll be sent an email with details to contact the student with. The redemption script will complete the redemption process by checking that the CK vouchers stored in your system are valid, and then redeem them.

Service NSW Vouchers integration window

Service NSW Vouchers integration window