AffiliateWP Stripe Payout - Overview

AffiliateWP Stripe Payouts allows you to pay your affiliates from your Stripe account with a single click. This add-on also allows you to automate payments by scheduling the affiliate-earning payouts individually and in bulk. As a result, you can dramatically decrease the amount of time you spend processing payouts, giving you more time to run your business. At the same time, you will be able to boost affiliate satisfaction by giving them quick access to their funds.  

This document will walk you through the steps you need to follow to use the add-on to pay your affiliates through stripe.

Prerequisites

  • AffiliateWP (Installed and Activated).
  • The site admin should have a stripe standard account.
  • SMTP configured by any 3rd party plugins like WP SMTP or Easy WP SMTP etc.

Installation:

  • Install and activate the AffiliateWP plugin.
  • Install and activate the AffiliateWP Stripe Payout.
  • There will be a sub-menu labeled as “Stripe Payout Settings” under the menu of Affiliates on the WP Dashboard.

Stripe Payout Settings:

Navigate to Affiliates > Stripe Payout Settings from the WP Dashboard. Here you will find the general settings for all the features this addon offers.

License Settings:

The license key can be added here. Place your license key in the field and click on Activate. License keys can be found in the email received when you purchased the addon.

Stripe Integration Settings:

Navigate to Affiliates > Stripe PayoutSettings > Stripe Integration Settings. Here you will find all the settings you need to integrate Stripe Account with this addon to pay AffiliateWP referrals.

General Settings:

Under this tab, you will find the general deactivation settings for your addon.  The options that are enabled will come into effect if you deactivate the add-on.

  • Delete stripe integrating settings

Select “yes” if you want to delete all Stripe Integration settings once the plugin is deactivated.

  • Delete affiliates stripe accounts connections?

Select “yes” if you want to delete all Stripe account connections once the plugin is deactivated.

  • Delete schedules?

Select “yes” if you want to delete all schedules once the plugin is deactivated.

  • Delete admin emails settings

Select “yes” if you want to delete all admin email settings once the plugin is deactivated.

  • Delete affiliate emails settings

Select “yes” if you want to delete all affiliate email settings once the plugin is deactivated.

Stripe Integration Settings:

Under this tab, you will find all the settings you need to integrate your Stripe API and Stripe Account with the website.

  • API Access Mode

This option lets you select the working environment of your plugin. The Stripe API will work accordingly on your selection from test Data or Live Data

Note: Make sure that all provided keys are related to the selected environment so you can switch between stripe environments inside the stripe dashboard to fetch related keys and screens.

  • Stripe Account ID

This field lets you enter your Stripe Account ID to integrate your Stripe account with our plugin. 

Note: The account ID is found by scrolling down on the Profile page when you log into your Stripe account.

Stripe:

  • API Keys:
  • Publishable Key

Login to your Stripe Account and navigate to Developers > API keys from the left side menu; there will be a Publishable Key under Standard Keys. Paste it here.

  • Secret Key

The secret Key is also located in the Standard Keys section. Copy and paste it in this field.

Here is where the keys will be located on your Stripe Account: On successful integration of the Stripe Account, the widget on the right will show a summary of the connected Admin account.

Integrated Stripe Account Verification: 

If You want to verify the integrated account from the stripe dashboard so navigate to settings scroll down to the business settings section and click on Account details.

Note: If you want to know more about Stripe Keys, read about them on official Stripe Doc.

  • Connect SettingsThese settings are needed to connect the affiliates’ account with the Admin’s account so that the payouts to the affiliates can be swift and hassle-free.
  • Live Client ID

Navigate to Settings > Connect (Settings) from the Stripe’s Account, and after setting up the other options, scroll down to the section of “Integration” and copy the Live Client ID and paste it here in the Live Client’s text field.

  • Redirect URL

Enter the URL you want the user affiliate to be redirected to on the successful connection of stripe account .

  • Affiliates are allowed to connect via

You can select which type of account you want the affiliates to have and connect with your account. You can offer them the choice of connecting between Stripe Express Account, Stripe Standard Account, or you can let the affiliate select an account type of preference on the frontend. Be sure to double-check the OAuth settings by navigating to Settings > Connect (Settings) from the Stripe’s Account.

Stripe:

There will be a section of Redirects just below the OAuth settings; specify, and put the URLs you want to redirect the user on the successful connection of their accounts with the admin account.

Front-end:

Stripe Connect Branding:

The above configuration will enable the connect onboarding on your site, its configuration is required to set up the Branding details on your integrated Stripe account. Navigate to the settings > connect settings and scroll down to the branding section and provide a business name and other details according to the screenshot. And these details will be displayed on the stripe onboarding connection form when an affiliate will connect their account from the affiliate area.Affiliates' connection status:

Navigate to Affiliates > Affiliates, the Stripe's account connection status will be visible with the Affiliate's name.

  • Account WebHook

This stripe webhook is required to be configured with all events or at least the following events which will be used for email notifications.

  • Transfer. created
  • Transfer. failed


Start the configuration process by navigating from stripe dashboard to Developers > Webhooks and add into the Endpoints receiving events from your account.

  1. Click “Add endpoint” in front of the “Endpoints receiving events from your account”.
  2. Scroll down to the section of Account WebHook and copy the WebHook URL.
  3. On the next screen, paste the account webhook URL you copied in Step 2 in the Endpoint URL field.
  4. Scroll down and click “Receive all events” under the section of Events to send.
  5. Click Add endpoint.
  • Signing Secret

After the integration of Account’s WebHook, there will be signing secret key on the configured endpoint on the path  Developers > Webhooks after the successful integration of WebHook. Copy the key and paste it here.

  • Application WebHook:

This stripe webhook is required to be configured with all events or at least the following events which will be used for email notifications.

  1. account.application.authorized
  2. account.updated
  3. account.application.deauthorized
  4. payout paid
  5. payout failed


Note: The configuration process is the same as Account Webhook.

Scheduled Payouts Settings

From this tab, you can schedule automatic payouts to your affiliates by creating a schedule. The included affiliates will receive the stripe transfer and will be notified by email.To add a stripe payout schedule, follow these steps:

  • Navigate to Affiliates > Stripe Payout settings > Scheduled Payouts Settings and click “Add New Schedule.”

  • Fill the rest of the fields accordingly, including the affiliates.
  • Click save settings.
  • The saved schedule will appear on the Scheduled Payouts page.

Note: The Active schedules will only be executed, and you can set the first execution time later if you do not want to be executed at the time of creation.

Schedule Actions:

Hovering over the schedule will present you with standard WP options i.e

  • Edit - Lets you edit the schedule
  • Execute - Let's you execute the flow.
  • Delete - This lets you delete the created schedule.

Manual Payout for Affiliates Individually and in Bulk:

Upon the affiliates’ successful referrals, navigate to the Affiliates > Referrals from the WP dashboard.

Stripe Individual Referral Payout:

There will be an action link of Stripe Payout in front of a successful unpaid referral, which depends upon three conditions:

  1. The affiliate status should be active.
  2. The affiliate’s stripe account should be connected with the admin’s account.
  3. The referral must be unpaid.

Note: The affiliate will receive the stripe transfer and a notification email. After the processing of specified days, stripe will create a payout, and this add-on will notify the affiliate by email.

Stripe Bulk Referrals Payout

If you want to pay multiple referrals manually in the bulk, so you can select the unpaid referrals and then select the “Stripe Bulk Payouts” from the bulk action dropdown. 

Email Settings

This tab contains the available setting options for emails. The plugin provides the ability to send email notifications on the following events:

ADMIN NOTIFICATIONS

  • Affiliate's Stripe Connected
  • Affiliate's Stripe Disconnected
  • Transfer Failed
  • Payout Failed

AFFILIATE NOTIFICATIONS

  • Affiliate's Stripe Connected
  • Affiliate's Stripe Disconnected
  • Transfer Created
  • Transfer Failed
  • Payout Paid
  • Payout Failed

The email notification templates can be designed by the classic editor with shortcodes.

There is a shortcode section for every email template, that has all the required shortcode

Stripe Connect Options on the Affiliate Area:

The affiliate area will display a Stripe Payouts Tab when the admin completes the connect settings. the affiliate will be able to connect the allowed types stripe account by processing the stripe official onboarding connection form.

Stripe Standard Account connection process:

The attached video is explaining the process when an affiliate wants to connect their standard account with the admin stripe account.

Affiliates have personal Stripe Standard accounts

Stripe Express Account connection process:

The attached video explains the process when an affiliate wants to connect the express account with the admin Stripe account and the express account is the platform-dependent account, therefore the affiliate will only be able to login in from the affiliate area “Stripe Payouts” tab login button.

Affiliates want to create and connect an express account