WABA and Wallet Management Guide for Partners onboarded on Gupshup - 6th March '24 onwards

Last updated : 05th March 2024

Target Audience

The target audience for this document is ISV partners who have signed up as a Tech Provider Program by Meta and have also done Gupshup ISV onboarding with a joint solution. Refer steps here to know the same

STEPS TO FOLLOW : 

1 : Set up Partner Wallet

On getting approved as a Partner on Gupshup, go to the 'Wallet' tab on your partner portal.

Click on the 'create wallet' button

Set up a Wallet name and select the default currency 'USD' for the wallet.

What is this Wallet for?

This wallet once created will be owned by you (as a Gupshup partner). Here are some things to note about a partner owned wallet - 

• Only you (as the admin of the partner portal) will have access to the partner wallet
• When you create apps, the deduction for those apps will be done through this partner wallet
• If any capping based daily discounts are applicable, they will be credited to the same wallet at the end of the day
• You need to recharge the partner wallet from time to time, and also just before going live
• (Note : We do not have a customer managed wallet at the moment)

2: Create Apps to create WABAs / PNs

On creating wallet, go to 'Apps' tab on partner portal

Click on 'create app' every time you need to onboard a Phone Number on a WABA.

Once app is created, it will show in the Apps listing. 

Click on show details to see the 'App token' and 'API key' for the app.

3: View the API docs

For creating or sending templates or other management, view the partner API documentation here

For session messaging, use the endpoint here

4: Go live with a WABA 

On the Apps tab, click on the 'Go Live' button of the app when you are ready to create a PN on a WABA or migrate an existing PN from another BSP (ensure 2FA is disabled). 

a) By default Tech Providers will be taken to the embedded signup flow as a method for onboarding WABAs. This will require you to log in to Facebook with the account with access to the Facebook Business Manager of the desired business or you can share the Embed Signup link with the customer to complete the flow.

Also the hosting will be on Cloud API (FBC) and the solution ID will be mapped to the app when you register a PN on Meta.

B) Enter your business details (these details will not be shared with Meta) if ISV please enter your contact details and not the end client details. If the email is already registered before this step will be skipped, please check and understand the terms and conditions.

c) Now a screen will pop up to enter the OTP. Please copy the OTP from your email and proceed. Once OTP is confirmed please click Confirm and Continue.

d) The new pop-up will show 'Continue with Facebook', now you will leave the Gupshup UI and go to the Facebook Business Manager profile. (please make sure that you are already logged into the FB Business  account that has access to the business's Facebook Business Manager or Share the Embed link with the customer)

SHARE THE BELOW STEPS e to k WITH CUSTOMER IF YOU ARE SHARING THE EMBED LINK WITH THEM -

e) Follow the prompt on Facebook Business Manager to share your account with Gupshup.

f) Verify Meta Business Profile

Confirm and proceed to the next step.

g) Enter the number you wish to go live with. Do not enter existing WhatsApp App or WhatsApp Business App phone numbers. To use an existing WhatsApp app or business app number, delete the account from the app first, and then try here. To migrate an existing PN live with other BSP, enter the same number

h) Now you will be shown the WhatsApp business account name WhatsApp business profile display name and category business description and website add all the details and click next. 

i) OTP Confirmation

Select "text message" to receive the OTP on text, and confirm it once received. Optionally you can do the same on a Phone call

j): Wait for WhatsApp Approval

WhatsApp will verify your details, and the display name is approved instantly but it might take upto 24 to 48 hours in some cases. 

k) Confirmation from Gupshup

Upon approval from WhatsApp, you will receive a notification from your WhatsApp manager that your WABA (WhatsApp Business Account) is now live. Gupshup will also email you that your app and WABA are live. You're now ready to start sending messages to your customers.

5 : Now you can start to do the following through the partner APIs - 

- Create templates and send templates

- Send session messages through the endpoint here

- Set webhook to subscribe for events and incoming messages

- Use the other useful APIs to manage wallet, analytics and so on for the apps 

6 : Commissions

If you are earning commissions, ensure to transfer your commissions to the wallet.

Reach out to us at partner.support@gupshup.io