HYS Documentation
Api ReferenceWebsiteGo to App
  • INTRODUCTION
    • About HelpYouSponsor
    • Key features overview
    • Concepts & Key Terms
  • GETTING STARTED
    • Navigation
    • Dashboard
    • Quick Start Guide
      • Account Information
      • Email Settings
      • Payment Gateways
        • Stripe Setup
          • Stripe Webhook
        • Flutterwave Setup
        • QPayPro Setup
        • Authorize.net Setup
        • PayPal Setup
    • Account Setup
      • First Program Setup
      • Website Integration
      • Campaign Setup
  • CORE FEATURES
    • Program Management
      • Manage Programs
      • Program Forms
      • Program Settings
      • Auto Emails
      • Additional Gifts
      • Url Generator
    • Donor Management
      • Donors Table
      • Add Donor
      • Household Table
      • Add Household
      • Donor Profile Page
    • Recipient Management
      • Recipients Table
      • Add Recipient
    • Sponsorship Management
      • Sponsorships Table
      • Add Sponsorship
    • Donation Management
      • Donations Table
      • Soft Credit
    • Communication Tools
      • Message Manager
      • Newsletter
  • ADVANCED FEATURES
    • Customization Options
    • Reporting and Analytics
    • Progress Reports
      • Create Progress Report
      • Add Progress Report Data
    • Integrations
      • Mailgun
      • Box Image Storage
      • Zapier
        • Actions
          • Create a New Donor
          • Edit Donor
          • Find Donor By Email Address
          • Find Donor Forms
          • Create a New Entity
          • Edit Entity
          • Find Entity by ID
          • Find Programs
        • Triggers
          • New Form
          • New Program
          • New Donor
          • New Entity
          • New Donations
      • QuickBooks
        • Connect to HelpYouSponsor
        • Adding Donors (Customers)
        • Recipients (Service item)
        • Donations (Sales Receipt)
        • Mapping fields from HYS to QuickBooks fields
        • Synchronized Currency
  • ADMINISTRATION
    • User Management
    • Permissions and Access Control
    • Security Settings
  • BEST PRACTICES
    • Donor Engagement Strategies
    • Fundraising Tips
    • Data Management
  • TROUBLESHOOTING
    • Common Issues and Solutions
    • FAQs
      • How do I import data into my account?
      • How do I bulk upload files?
      • How do I export all the data in my account?
    • Support Resources
      • Priority Support & Enhancements Options
      • How to close my account?
  • API DOCUMENTATION
    • Authentication
    • Endpoints
    • Code Examples
  • RELEASE NOTES
    • Version History
    • Upcoming Features
Powered by GitBook
On this page
  • Getting Client ID and Secret
  • Getting Webhook ID
  1. GETTING STARTED
  2. Quick Start Guide
  3. Payment Gateways

PayPal Setup

PreviousAuthorize.net SetupNextAccount Setup

Last updated 2 months ago

To integrate PayPal into HYS, we’ll require you to provide your Client ID, Secret and Webhook ID.

Getting Client ID and Secret

The PayPal Client ID and Secret can be got from your PayPal developer platform. This will require that you first create a new App in PayPal incase you do not have one. Click "Create App" and follow the procedures. We have shared this resource from PayPal to help with creating of the app

Once you have got the Client ID and secret, the next step is to create a Webhook so as to obtain a Webhook ID.

Getting Webhook ID

After creating the app, you have to choose the one that you want to connect to HelpYouSponsor. Select the app that you want to use. You’ll be taken to that app page, scroll down to where you’ll find live Webhooks.

Click the "Add Webhook" button. You will be presented with a form to place the "Webhook URL". Below is the URL to place there.

You can also get the Webhook URL from the PayPal payment integration in HelpYouSponsor.

After adding the webhook URL, go to the "events type" choose "Payment Sale Completed" under "Payments & Payouts" and then save.

Once saved, the page will appear as shown below showing the Webhook ID.

Then head over to HelpYouSponsor and click "Payment Gateways" under "Settings" on the main menu and then click the "Other Payment Gateways" tab. Click "View Integration" for PayPal and add the Client ID, Secret and Webhook ID.

https://developer.paypal.com/video/watch/?videoId=QTDEeB6xzCg
https://api.helpyousponsor.com/v1/paypal/webhookapi.helpyousponsor.com