Prerequisites
Before you begin, make sure you have:- An active PayPal Business account
- Access to your Aikeedo admin panel
- Basic understanding of payment gateways (don’t worry, we’ll guide you through the process!)
Step 1: Set Up Your PayPal Business Account
If you haven’t already, sign up for a PayPal Business account:- Visit the PayPal Business website and click “Sign Up”
- Follow the prompts to create and verify your business account
- Complete any additional verification steps required by PayPal
Step 2: Obtain PayPal API Credentials
To connect Aikeedo with PayPal, you’ll need to retrieve your API credentials:- Log in to the PayPal Developer Dashboard
- Navigate to Apps & Credentials
- Click on Create App to generate a new app for your integration
- Set the following details:
- App Name: Choose a name for your integration (e.g., “Aikeedo Payments”)
- Select “Merchant” as the app type
- Click “Create App”
- On the next page, you’ll find your Client ID and can generate a Secret Key
Keep your Secret Key confidential! Never share it publicly or include it in client-side code.
Step 3: Set Up PayPal Webhooks
Webhooks are crucial for handling recurring payments and keeping your Aikeedo platform in sync with PayPal. Here’s how to set them up:- In the PayPal Developer Dashboard, go to your app’s details page
- Scroll down to the Webhooks section and click “Add Webhook”
- Enter your webhook URL:
https://your-aikeedo-domain.com/webhooks/paypal
- Select the following events:
INVOICING.INVOICE.CANCELLED
INVOICING.INVOICE.CREATED
INVOICING.INVOICE.PAID
INVOICING.INVOICE.REFUNDED
INVOICING.INVOICE.SCHEDULED
INVOICING.INVOICE.UPDATED
BILLING.SUBSCRIPTION.CANCELLED
- Click “Save” to create the webhook
- After creation, you’ll see a “Webhook ID” - copy this for later use
If you’re not sure which events to select, it’s safe to choose all relevant billing and invoicing events for comprehensive coverage.
Step 4: Enable PayPal in Aikeedo
Now that you have your PayPal account set up, it’s time to configure Aikeedo:- Log in to your Aikeedo admin panel
- Navigate to Settings > Payments > PayPal
- Toggle the switch to enable PayPal payments
- Choose the appropriate mode:
- Sandbox: For testing payments
- Live: For processing real transactions
- Enter the following details:
- Client ID: Your PayPal app’s Client ID
- API Secret Key: Your PayPal app’s Secret Key
- Webhook ID: The Webhook ID from your webhook setup
- Set your preferred Charge Currency
- Click “Save changes” to apply your settings
Congratulations! PayPal payments are now enabled on your Aikeedo platform.
Testing Your Integration
Before going live, it’s crucial to test your PayPal integration:- Set Aikeedo to “Sandbox” mode
- Use PayPal’s sandbox accounts to simulate various payment scenarios
- Create a test subscription or product purchase
- Verify that payments are processed correctly and webhooks are functioning
Troubleshooting
If you encounter any issues with your PayPal integration, try these steps:- Double-check all API credentials and Webhook ID for accuracy
- Ensure your webhook URL is correct and accessible
- Review PayPal’s developer dashboard for any error logs or failed webhook attempts
- Check Aikeedo’s error logs for any integration-related issues