--- title: "Slyp Receipts Integration - Configuration and Setup" canonical: "https://kb.myframeworks.com.au/space/FRAM/28378582/Slyp%20Receipts%20Integration%20-%20Configuration%20and%20Setup" format: markdown --- # Overview Slyp is a third-party software application that delivers Smart Receipts - itemised, tax compliant receipts delivered automatically into a customer's bank app, or via SMS. No need to print or send receipts via email, we’ve done the hard work for you. Customer’s simply tap and go. Smart Receipts are so much more than just a digital receipt. Beyond elevated convenience they provide an untapped channel for businesses to digitally connect and engage with offline customers post-purchase. Smart Receipts are sent at 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 [Windcave for its POS Devices](https://kb.myframeworks.com.au/space/FRAM/435978301/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 ## 1. 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. 1. Define the **POS Provider **as Sterland 2. Create a **Company** 1. The Company Information includes the Slyp Merchant ID, which needs to be added to the Slyp Configuration in Frameworks. 2. From the Company Screen, you can access the API Key, which is also to be added to the Slyp Configuration screen in Frameworks. 3. Add your **Stores, **making sure the **Store ID's **match that of your **Branch Id's**, as defined in [Branch Maintenance](https://kb.myframeworks.com.au/space/FRAM/542484345/Branch+Maintenance). 1. Define your store's opening hours 2. Ensure the stores are enabled. > ✅ Refer to [https://www.slyp.com.au/retailers](https://www.slyp.com.au/retailers) and their documentation for more information on becoming a **Retail Partner** and setting up your account with them. ## 2. Enable Slyp Receipts in Frameworks There are two parts to configuring and enabling Slyp Bank Receipts and Smart Receipts within Frameworks, perform the following:  > ⚠️ **Important: ** > ⚠️ > ⚠️ - You will require 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](https://kb.myframeworks.com.au/page/support) if you require assistance with installing the SSL certificate. ### Enable Slyp and Bank Receipts (Minimum Requirement) 1. Click the **Frameworks Menu** and navigate to **System Administration > System Tables > Miscellaneous Table Maintenance** from the navigation tree. 2. In the **Table** field type **System Settings - General** and click **Find**. 3. 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. | 4. Click **Save **to commit the changes. ### Enable Smart Receipts > ⚠️ **Important: **The above API configuration is required to be configured for Smart Receipts. 1. Click the **Frameworks Menu **and navigate to **System Administration > System Tables > Miscellaneous Table Maintenance** from the navigation tree. 2. In the **Table** field type **System Settings - Flag **and click **Find**. 3. 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. ## 3. Enable the TenderReceipt Event Notification When Enabling the TenderReceipt event notification and actions is required to: ### Subscribe to the TenderReceipt Event (Required) 1. Click the **Frameworks Menu** and navigate to **System Administration > Event Notifications > Setup & Administration > Event Definition Maintenance **from the navigation tree. 2. Click **New**, at the bottom of the page to enable the **Event ID Information** section. 3. From the **Event ID **drop-down menu select **TenderReceipt.** 4. Enable the **subscribe** checkbox. > ℹ️ This can be unticked if you no longer want to subscribe to this event. 5. In the **Description **field enter a description about the event, for example, **Tender Receipts for Slyp Integration**. ### Add the Slyp-Receipt Action (Required) 1. In the **Actions Details** section, click **Add**. 2. The **Action **drop-down menu select **Slyp-Receipt.** 3. Enable **Subscribed** to subscribe to the action for the event notification. > ℹ️ You can disable Subscribed at any time to disable the action. 4. In the **Description** field enter a description to explain what the action is for, for example, **Send a Slyp Receipt**. 5. 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](https://kb.myframeworks.com.au/page/support). 6. Click **Save **to add the **Slyp-Receipt **action to the Event. ### Subscribe to an Event Notification (Optional) 1. In the **Actions Details** section, click **Add**. 2. The **Action **drop-down menu select **Notification.** 3. Enable **Subscribed** to subscribe to the action for the event notification. > ℹ️ You can disable Subscribed at any time to disable the action. 4. In the **Description** field enter a description to explain what the notification is for, for example, **Send a Frameworks Notification**. 5. 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](https://kb.myframeworks.com.au/page/support). 6. Click **Save **to add the **Notification **action to the Event. ## 4. Send Slyp Receipts from Frameworks Slyp Receipts are available for Point-of-Sale Invoices and for Credit Returns once Slyp is enabled as above. 1. A **Slyp Smart Receipt** will be sent to the customer’s Smartphone only if: 1. The **SLYPMobile** flag is ticked, and 2. A valid customer Mobile Phone Number is entered in the Tendering screen that appears after entry of a POS Invoice or a Credit Return. 2. 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](https://kb.myframeworks.com.au/space/FRAM/580715749/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](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30529558) for more information. > ✅ - Refer to [Configure Windcave EFTPOS as a Tender Type](https://kb.myframeworks.com.au/space/FRAM/435978301/Configure+Windcave+EFTPOS+as+a+Tender+Type) for additional information > ✅ - Refer to [Integrated EFTPOS](https://kb.myframeworks.com.au/space/FRAM/556435310/Integrated+EFTPOS)
Related System Settings - Flags/Numeric/General The below system settings may be used to customize 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** - **SLYPMobile**: Enable Mobile Phone for Slyp Receipt --- #### **System Settings - General** - **SLYPAPIKEY**: Key for Slyp Smart Receipts API - **SLYPMERCHKEY: **Key for Slyp Smart Receipts Merchant ID - **SLYPAPIURL: **URL for Slyp Smart Receipts API