App Partner Guide
      Back to home
      1. Help for Partners
      2. App Partner Guide

      Using the Doshii Referral API

      Introduction

      Within the Doshii context a referral represents a request from a partner to get a merchant connected to Doshii to allow a direct API connection between the partners consumer facing App and the merchant's Point of Sale (POS). This creates the most seamless experience for the merchant's onboarding process.

      This document assumes Subscription and Onboarding has been implemented as per requirements.

      Typical Referral Scenario

      diagram.png

      Referral Status Workflow

      image__2_.png

       

      Getting started

      Using Referrals

      Referrals are facilitated by the use of Doshii's referrals endpoint.

      Referral_Sequence.png

       

      Referral parameters

       

      Example:  

      POST https://sandbox.doshii.co/partner/v3/referrals
      {
      "merchantContactEmail"      : "user@host.com", "merchantContactFirstName": "Jim", "merchantContactLastName": "Belushi", "merchantPhone": "411000000", "merchantVenueName": "Belushi Sushi", "partnerLocationId": "string", "doshiiLocationId": "string", "doshiiOrganisationId": "string", "merchantAddress": { "line1": "string", "line2": "string", "city": "Sydney", "state": "NSW", "postalCode": "2000", "country": "AU", "latitude": 33.8688, "longitude": 151.2093  },
"referrerName": "string", "referrerEmail": "string", "doshiiVendorId": "string", "triggerMerchantEmail": true
      }

       

      For all required fields refer to the swagger documentation here

       

      What happens after you submit a referral?

      When the referral is submitted via the api, the api response will include a referral url link. This link can either 

      1. Be passed on to Merchant via your own onboarding process or
      2. Will be sent to the Merchant in an email sent by Doshii

      When the Merchant accesses the referral url link, the Doshii merchant platform uses the data included to auto populate the merchants onboarding experience to increase ease and reduce drop offs.

       

      To understand the merchants onboarding process please   view  this prototype.

       

      Additional Benefit

      All referrals that are submitted to Doshii for a particular partner are visible within Doshii dashboard with functionality that indicates the referral status progression and venue onboarding progress so that your team can keep up to date on the closure of sales.

       

      Simulating in the Sandbox Environment

      Before implementing referrals ensure you have done the following:

      • Update your app's service channels to accept referrals:

       

      Screenshot_2023-02-02_at_5.22.17_pm.png

      • Activate the referrals API endpoint:

      Screenshot_2023-02-02_at_5.23.47_pm.png

      • Ensure the app has been connected to Doshii's sandbox marketplace
      • Check that you can see the referrals section (which was previously red) on the details page. Screenshot_2023-02-02_at_5.32.48_pm.png
      • Hit the '+' icon and find the venue you are looking to onboard. It is best practice to fill as much information for the merchant as possible.
      • Once you hit submit, the merchant will receive a referral url at the designated email.
      • Your referral table should now populate with a venue in status of PENDING.

      Status Guide

       

      Other support