---
title: "Slyp Receipts Integration - Configuration and Setup (2)"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28383574/Slyp%20Receipts%20Integration%20-%20Configuration%20and%20Setup%20(2)"
format: markdown
---
Overview Slyp is a third-party software application that allows you to send electronic receipts to either your customer's bank (a Bank Receipt) or as a link contained in an SMS message sent to your customer’s smart phone (a Smart Receipt). This enhancement is primarily for sending a Smart Receipt if the customer’s mobile number is entered at the Point Of Sale or when processing Credit Return. Current Known Issues Bank Receipts can ONLY be sent from Frameworks to the customer via Slyp if the customer is using  Configure Windcave EFTPOS as a Tender Type . Using the Quick Tender options does not currently provide the user the opportunity to change the customer default mobile number. You can still send a Smart Receipt, provided the customers default mobile number is correct. How to Setup and Configure Slyp Receipts Create an Account with Slyp Before configuring Frameworks you will need to contact  Sylp  and become a  Retail Partner.  Once you have become a retail partner you will need configure your account. Define the  POS Provider  as Sterland Create a  Company The Company Information includes the Slyp Merchant ID, which is is to be added to the Slyp Configuration in Frameworks. From the Company Screen, you can access the API Key, which is also to be added to the Slyp Configuration screen in Frameworks. Add your  Stores,  making sure the  Store ID's  match that of your  Branch Id's , as defined in  Branch Maintenance - Field Definitions .  Define your store's opening hours Ensure the stores are enabled. Refer to  https://www.slyp.com.au/home  and their documentation for more information on becoming a  Retail Partner  and setting up your account with them. Enable Slyp Receipts in Frameworks There are 2 parts to configuring and enabling Slyp Bank Receipts and Smart Receipts within Frameworks, perform the following:  Important:  You will required the  Slyp Merchant ID  and  API Key  to complete this part of the setup. The Slyp API requires an SSL certificate to be installed. Contact  Sterland Support  if you required assistance with installing the requires SSL certificate. Enable Slyp and Bank Receipts (Minimum Requirement) Click  and navigate to  System Administration > System Tables > Miscellaneous Table Maintenance  from the navigation tree. In the  Table  field type  System Settings - General  and click  . Find the following codes and ensure the values are defined as per the table below.  Tip : In the  Code  filter field enter  SLYP  to quickly find the required codes. Code Setting Purpose Value SLYPAPIKEY Key for Slyp Smart Receipts API Copy the SLYP API KEY under the Company > API Keys in your Slyp Portal. SLYPAPIURL URL for Slyp Smart Receipts API You will be advised of this when you define your API key.  For Example: https://api.slyp.com.au/ SLYPMERCHKEY Key for Slyp Smart Receipts Merchant ID Copy the SLYP MERCHANT ID under the Company > Company Info in your Slyp Portal. Click  to commit the changes Enable Smart Receipts Important:  The above API configuration is required to be configured for Smart Receipts. Click  and navigate to  System Administration > System Tables > Miscellaneous Table Maintenance  from the navigation tree. In the  Table  field type  System Settings - Flag  and click  . Enable    SLYPMobile  for  a Mobile Phone Number to be entered in the Tender Receipts screen, allowing you to send a Smart Receipt to the customer’s Smart Phone. Enable the TenderReceipt Event Notification When a Enabling the  TenderReceipt  event notification and actions is required to   Subscribe to the TenderReceipt Event (Required) Click   and navigate to  System Administration > Event Notifications > Setup & Administration > Event Definition Maintenance  from the navigation tree. Click  , at the bottom of the page to enable the  Event ID Information   section. From the  Event ID  drop-down menu select  TenderReceipt . Tick  the  subscribe   checkbox. This can be unticked if you no longer want to subscribe to this event. In the  Description  field enter a description about the event, for example,  Tender Receipts for Slyp Integration . Add the Slyp-Receipt Action (Required) In the  Actions Details  section, click  . The  Action  drop-down menu s elect  Slyp-Receipt. Tick    Subscribed  to subscribe  to the action for the event notification. You can un-tick  Subscribed at any time to disable the action. In the  Description  field enter a description to explain what is the action for, for example,  Send a Slyp Receipt . If required, in the  Condition  field enter  tenderReceipt:slypPhone ne ""  to help filter the transactions being sent to Slyp. The condition  tenderReceipt:slypPhone ne ""  enables only those transactions where a mobile number has been entered to be sent to Slyp.  With this condition active, if the mobile number is left blank on the transaction, it will not appear in the Slyp Receipt Feed. The company should omit this condition if: They intend to use Slyp to view historical receipts  They intend to use Slyp for the bank receipts functionality   If you require assistance with coding the condition text, please contact  Sterland Support . Click   to add the  Slyp-Receipt  action to the Event. Subscribe to an Event Notification (Optional) In the  Actions Details  section, click  . The  Action  drop-down menu s elect  Notification. Tick    Subscribed  to subscribe  to the action for the event notification. You can un-tick  Subscribed at any time to disable the action. In the  Description  field enter a description to explain what is the notification for, for example,  Send a Frameworks Notification . If required, in the  Condition  field enter  tenderReceipt:valueTernder gt 100  to send a Frameworks Notification to the user only if the value of the Tender Receipt exceeds $100. If you require assistance with coding the Condition text, please contact  Sterland Support . Click   to add the  Notification  action to the Event. Send Slyp Receipts from Frameworks Slyp Receipts are available for Point of Sale Invoices and for Credit Returns once Slyp is enabled as above. A  Slyp Smart Receipt  will be sent to the customer’s Smartphone only if: The  SLYPMobile  flag is ticked, and A valid customer Mobile Phone Number is entered in the Tendering screen that appears after entry of a POS Invoice or a Credit Return. A  Slyp Bank Receipt  will be sent to the customer's bank, if it is a Slyp partnered bank. A Diary Note will appear in the  Notes  screen accessed from  Customer Transaction Enquiry Dashboard  showing the reference provided by Slyp for the Smart receipt as per the following example:  TenderReceipt Slyp XREF: R-X-ff8c42bb787b4e548882b35e6a219793 The Slyp Portal provides a  Receipt Feeds  option from the left side-menu which you can view the Slyp Smart Receipts sent to a customer’s Smartphone. Additional Information Refer to  Tendering with Slyp Receipts  for more information. Refer to  Configure Windcave EFTPOS as a Tender Type  for additional information Refer to  Integrated EFTPOS The below system settings may be used to customise the functionality of your Frameworks instance. InstallerFW14145 – Slyp API Settings  may be required to be run for System Settings - Flags to be defined. System Settings - Flags Flag Purpose SLYPMobile  Description from Frameworks System Setting - General Setting Purpose SLYPAPIKEY Key for Slyp Smart Receipts API SLYPAPIURL URL for Slyp Smart Receipts API SLYPMERCHKEY Key for Slyp Smart Receipts Merchant ID Refer to  Point of Sale Related System Settings  for more information Refer to  Credit Notes Related System Settings  for more information