Documentation - WP EasyPay Skip to content
This documentation is for beta version 3.0. For more information on how to opt for the beta program, Visit Here.

  1. INTRODUCTION
  2. UPGRADE TO WPEASY PAY PREMIUM
  3. INSTALLATION GUIDE (PRO VERSION)
  4. SQUARE SANDBOX SET UP
  5. WP-EASY-PAY SETTINGS
    1. GLOBAL SETTINGS (TEST MODE)
    2. GLOBAL SETTINGS (LIVE MODE)
    3. INDIVIDUAL FORM SETTINGS(TEST MODE)
    4. INDIVIDUAL FORM SETTINGS (LIVE MODE)
  6. CONFIGURATION
    1. FORM TYPES
    2. FORM SETTINGS
    3. FORM STYLING
  7. FORM BUILDER
  8. EMAIL NOTIFICATIONS
  9. SQUARE TRANSACTION NOTE
  10. FORM SHORTCODE
  11. REPORTS
    1. SUBSCRIPTION REPORTS
    2. PAYMENT REPORTS
    3. OLD REPORTS
  12. PLUGIN FEATURES
  13. WP-EASY PAY (FREE VERSION)
  14. OLD DOCUMENTATION TILL VERSION 2.6.8
  15. Development Changelog
    1. Changelog (Free Version)
    2. Changelog (Pro Version)

1.INTRODUCTION #

WP Easy Pay plugin offers several powerful features to fit your needs. If you’re looking for Square Payment Gateway for your WordPress site, get WP Easy Pay and start accepting online credit card payments. It generates dynamic buttons using shortcodes that enable payment form on your WordPress site using Square payment gateway. WP Easy Pay works out perfect for accepting simple payment, donation, subscription, and recurring donation. Fulfill your requirement of one time payments to keep your business going with ease.

In Addition, you can easily manage SQUARE TRANSACTION NOTE, EMAIL NOTIFICATIONS and manage REPORTS from the Admin panel.

View test transactions in Square Dashboard via SQUARE V2 API.

Yes No

2.UPGRADE TO WPEASY PAY PREMIUM #

  • Choose annually or a lifetime.
  • Fill out personal & card details.
  • Click review order.

  • Click Pay & Subscribe.

Check your Email, if you received the Email then click Got it. If you didn’t get the email, click Resend Email.

Go to your email you’ll find your Download link, License Key and Freemius Account login details here.

  • Login into your Freemius account.

  • Go to Downloads.
  • Click Download.

  • Copy your License Key.

 

Yes No

3.INSTALLATION GUIDE (PRO VERSION) #

  • Go to plugins → Add New → Upload Plugin.

  • Choose file → Select WP-Easy-Pay → Upload.
  • Install Now.

  • Activate Plugin.

  • Go to Plugins → Activate License.

  • Enter License Key.
  • Click Agree & Activate License.

  • Click Agree & Activate License.
Yes No

4.SQUARE SANDBOX SET UP #

In order to get started Square account is required.

  • Go to Apps.

 

  • Click My Apps.
  • Click on Go to Developer Dashboard.

 

  • Create New Application.

  • Get your APP ID & Access Token.

  • Go to Locations to get Location ID.

Now login into your WordPress Setup and Go to WP-Easy-Pay Global Settings.

Yes No

5.WP-EASY-PAY SETTINGS #

Configure Global and Individual Form

Yes No

5.1.GLOBAL SETTINGS (TEST MODE) #

  • Go to Global Settings.
  • Enter Notification Email.
  • Enter Application ID, Application Access Token & Location ID.
  • Select Country Currency.
  • Save Settings.

By default, Test Mode is enabled.

Yes No

5.2.GLOBAL SETTINGS (LIVE MODE) #

  • Turn on the Toggle on the top Right to make it Live.
  • Enter Notification Email.
  • Click Connect Square.

You’ll be redirected to Squareup website.

  • Enter Square Credentials to login.

  • Allow Access to requested Permissions.

Authentication Message will appear.

  • Click Redirect Me.

  • Select Location.
  • Save Settings.

Yes No

5.3.INDIVIDUAL FORM SETTINGS(TEST MODE) #

These are the individual form settings, all Square details you enter will only work with the individual form you are building. These settings allow you to connect each form with a different square account.

  • Go to Build Payment Forms → Square Account Settings.
  • Enter App ID, Access Token & Location ID.
  • Select Country Currency.

By default, Test Mode is enabled.

Note: – Although You can activate the Global Settings. If Use Global Settings option is checked then it will override the individual form settings.

Yes No

5.4.INDIVIDUAL FORM SETTINGS (LIVE MODE) #

  • Turn on Toggle to make it Live.
  • Click Connect Square.

The Square account you’ll connect will only work for the specific form.

  • Enter Login Credentials to login.
  • Allow Access to requested Permissions.
  • Click Redirect Me.
  • Select Location.

Or you can use Global Settings. Make sure Live mode toggle is turned on in Global settings.

Yes No

6.CONFIGURATION #

6.1.FORM TYPES #

 

1. Simple Payment

  •  Go to Forms settings.
  • Select Simple Payment from Payment Types.
  • Enter the amount and payment success URL.

2. Donation payment

  • Go to Forms settings.
  • Select Donation Payment from Payment Types.
  • Enter Organization Name.
  • Enter set or a custom amount.
  • Place Payment success URL.

3. Recurring Donation payment

  • Go to Forms settings.
  • Select Recurring Donation from Payment Types.
  • Enter Organization Name.
  • Define Subscription cycle
  • Enter set or custom amount.
  • Place Payment success URL.

4. Subscription payment

  •  Go to Forms settings.
  • Select Subscription payment from Payment Types.
  • Define Subscription cycle
  • Enter set or a custom amount.
  • Place Payment success URL.

Subscription cycle options:

  • Subscription Time Period: (every 1-6).
  • Subscription-based on: (Day/Week/Month/Year).
  • Subscription length: (every 1-24).

Yes No

6.2.FORM SETTINGS #

  • Go to → Build a Payment Form → Form Settings.

  • Fill out the form details.
  • Select Payment option (Simple, Donation, Recurring Donation & Subscription).

  • Select amount type layout (Radio Listing, Dropdown & custom layout).
  • Enter Set amount or a custom amount.
  • Define the Min & Max amount range for a custom amount.
  • Enter the Payment success URL.

Yes No

6.3.FORM STYLING #

  • Enable to Display form in Popup / Wizard.

Front-End:

  • Set theme color.
  • Show form shadow.
  • Custom button labels.
  • Custom payment success message.

Yes No

7.FORM BUILDER #

Custom form builder just drag & drop to add various custom fields. Data entered in these fields are stored and can be viewed along with your payment or subscription plan.

  • Go to → Build Payment Form → Extra Fields.
  • Drag and Drop fields to add in form.

Note: – First Name, Last Name, and Email are by default required fields so it cannot be deleted or edited.

  • Edit / Delete / Duplicate custom fields.

Front-end

Yes No

8.EMAIL NOTIFICATIONS #

  • Go to → Build Payment Forms → Notifications.
  • Design separate Admin and User custom email templates.
  • Click to copy Tags.

  • Add Default and extra mail tags into the Message Body.

Admin Email Front:

User Email Front:

Yes No

9.SQUARE TRANSACTION NOTE #

  • Go to → Build Payment Form → Transaction Notes.
  • Click to copy default and fields extra tags.
  • Place it into the Transaction Notes box.

Note: There is a limit of 60 characters for transaction notes in Square API, so if you exceed this limit it will automatically ignore.

View Transaction in Square Dashboard (Test Mode):

  • Go to → squareup.com → Login.
  • Go to Apps → My Apps → Go to Developer Dashboard.
  • Launch the Sandbox Test Account.

  • Go to → Transactions.

  • View recorded transactions along with all transaction notes.

View Transaction in Square Dashboard (Live Mode):

  • Go to → squareup.com → Login.
  • Click on Transaction.
  • View Recorded Transactions.

Yes No

10.FORM SHORTCODE #

  • Publish form.
  • Copy shortcode from Form Builder.
  • Click to copy.

OR Copy Shortcode from All Forms

  • Go to All forms.
  • Click to copy the shortcode.

  • Go to Pages → Add New.
  • Insert Shortcode.
  • Publish or update the page.

FORM FRONT END VIEW

Yes No

11.REPORTS #

11.1.SUBSCRIPTION REPORTS #

  • Go to WP Easy Pay → Subscriptions.

Whether it is a normal Subscription or Recurring Donation, you’ll find all your subscriptions here.

  • Click on ID to access details.

Find all customer details with related transactions. You can also pause subscriptions if required.

Yes No

11.2.PAYMENT REPORTS #

  • Go to WP Easy Pay → Reports.

Find all forms of transaction reports here.

  • Click the report ID to access details.

You can also check from which form the reported is generated by clicking on WPEP Form Click here link.

Yes No

11.3.OLD REPORTS #

  • Go to WP Easy Pay → Old Reports.

This section is for existing WP Easy Pay users only. For new users, this section will be blank.

Existing users who switch from the old version to New 3.0 can view their old subscriptions and all forms transaction reports here.

Yes No

12.PLUGIN FEATURES #

  • Improved UI/UX.
  • Easy to setup.
  • Multiple payment options (Simple, Donation, Subscription, Recurring Donation.
  • Authentication functionality to connect Square.
  • Create Multiple Buttons with multiple Square accounts.
  • Shortcode Supported.
  • Global settings and individual settings option for Square.
  • Custom form builder.
  • Drag & drop custom field functionality.
  • Allow fixed or a custom amount.
  • Multiple display styles for amount type.
  • Predefined mail tags.
  • Sandbox Supported for a test run.
  • Separate notification email for Admin and User.
  • Edit/Delete/Duplicate custom form fields.
  • Multiple display styles for forms (Single Form/ Form in Popup/ Form Wizard/ Form Wizard in a popup).
  • Predefined Transaction notes tags.
  • View subscriptions and transaction reports.
  • Customize form with the theme color and display form shadows.
  • Flexible Pricing Plans.
  • Secure payment transactions.
  • View transaction in Square.
Yes No

13.WP-EASY PAY (FREE VERSION) #

Installation Guide

  • Go to Plugins → Add new.
  • Search WP Easy Pay – Square for WordPress.
  • Install Plugin.

  • Click Activate.

Square Sandbox Setup.

In order to get started Square account is required.

  • Go to Apps.

  • Click My Apps.
  • Click on Go to Developer Dashboard.

  • Create New Application.

  • Get your APP ID & Access Token.

  • Go to Locations to get a Location ID.

WP-Easy-Pay Settings

  • Go to WP-Easy-Pay → Global Settings.
  • Enter Notification Email.
  • Enter Application ID, Access Token and Location ID (get from your Square Account explained above).
  • Select Country Currency.
  • Save Settings.

By default, Test Mode is enabled.

Form Settings

  • Go to Payment Form.
  • Enter Notification Email.
  • Select Payment Type either Single or Donation.
  • Set Amount.
  • Place the Payment Success URL.

Organization Name field and User set donation checkbox will be visible if Payment type is Donation selected.

Form Short Code

  • Copy Shortcode.

  • Go to Pages → Add New.
  • Place Shortcode.
  • Click Publish.

Front-End

 

Square Transaction

View Transaction in Square Dashboard (Test Mode):

  • Go to → squareup.com → Login.
  • Go to Apps.

  • My Apps → Go to Developer Dashboard.

  • Launch the Sandbox Test Account.

  • Go to → Transactions.

  • View recorded transactions along with all transaction notes.

Square Live Mode Settings

  • Go to WP-Easy-Pay → Global Settings.
  • Turn On Toggle to make it Live.
  • Enter Notification Email.
  • Click Connect Square.

You’ll be redirected to the Squareup website.

  • Enter Square Credentials to login.

  • Allow Access to requested Permissions.

Authentication Message will appear.

  • Click Redirect Me.

  • Select Location.
  • Save Settings.

 

 

 

 

 

 

Yes No

14.Old Documentation #

15.Development Changelog #

15.1.Changelog (Free Version) #

2.5.5 – 25/09/2019
Added – Square Sandbox Support
Added – SCA (Strong Customer Authentication)
Updated – Square V2 API and SDK version updated from transactionAPI to PaymentAPI

2.5.4 – 13/06/2019 =
*Fix – Guest User Subscription Issue fixed
*Fix – Popup header and background color fixes.
*Fix – Dashboard warning issues resolved
*Improvement – Design and layout changes
* Improvement- Field Labels are now conditional
* Improvement- Sent transaction amount using [wpep_amount] Tag in notification Email Setting
* Improvement – Default field added first name, last name, and email

2.5.3 – 16/04/2019 =
* Added – Square notice conditions changed.
* Added – Subscription not logged condition.

2.5.2 – 10/04/2019 =
* Added – Square Auth notice.

2.5.1 – 09/04/2019 =
* Updated – Freemius SDK
* Added – Square Auth Connection simple way to connect with square.
* Added – Square Sandbox Auth Connection Payment process.
* Added – Square Auth Connection button css.

2.3.0 – 27/02/2019 =
* Updated – Freemius SDK

2.2 – 18/12/2018 =
* Enhancement – Added compatibility for WordPress 5.0.1
* Enhancement – Added compatibility for WooCommerce 3.5.2
* Added – Action hook for wp_easy_payment_success and wp_easy_payment_failed.
* Added – Redirect page after payment success.
* Added – code quality.

2.0 2018-10-26 =
* Added – Multiple payment buttons support on same page.
* Fixed – Form fields issue.
* Added – Subscription activation by default.
* Update – Email body template labelling.
* Update – Decimal amount support according to square API.
* Added – Amount field added inside all field tag.
* Added – Card fields mandatory on subscription button form.

1.8 2018-10-16 =
* Add – Dynamic form fields for pro feature.
* Add – Dynamic transaction note for pro feature.
* Add – Admin as well notification email templates for pro feature.
* Update – Popup issues for pro feature.
* Add – Multi Currency support in free version tested upto Version 4.9.8.

1.6 2018-08-16 =
* Updated – Freemius SDK
1.5 2018-05-28 =
* Added – Custom Pricing for simple and subscription payment
* Added – First name, Last name and email field in all forms i.e donation, simple and subscription form

1.3 2018-04-20 =
* Add – Square Transaction Note fields dynamic for Pro plans.

1.2 2018-04-18 =
* Add – Support for premium plans

1.0 2018-03-01 =
* Initial release

Yes No

15.2.Changelog (Pro Version) #

Version 3.1.3 – 22/5/2020
* Fixed – Recurring Payment Cycle
* Fixed – Amount showing undefined after decimal
* Fixed – Required Filed on Front-end
* Fixed – General different theme inheritance styling

Version 3.1.2 – 11/5/2020
* Fixed – Email Notifications
* Fixed – Refresh Token Issue
* Fixed – Min – Max field issue
* Fixed – Multistep Form Issue Resolved
* Fixed – Decimal Issue Resolved

3.1.1 – 15/04/2020
* Fixed – Free to pro error fixed

Version 3.1.0 – 03/04/2020
* Update – Video demonstration added
* Fixed – Free to Pro fatal error fixed

Version 3.0.9 – 01/04/2020
* Fixed – Other field by default on form when no amount entered in custom amount layout.
* Fixed – Subscription info fields visible after update.

Version 3.0.8 – 30/03/2020
* Fixed – Decimal error fixed in custom amount fields.
* Fixed – Decimal error fixed in user amount field in the user form.
* Fixed – Fatal error on upgrading from free to pro.

Version 2.6.7 – 25/11/2019 =
* Update – Update – CC and BCC fields support fixed.

Version 2.6.6 – 22/11/2019 =
* Update – NDS PMD Information removed from reports.
* Added – Currency identifiers added in emails
* Added – Form validation on extra fields is added
* Update – First Name, Last name and Email is being displayed in transaction notes

Version 2.6.5 – 14/11/2019
* Update – Pop-up form validation issues fixed

Version 2.6.4 – 13/11/2019
* Update – Apple Pay and Master Pass digital wallets are disabled due to technical problems in Square API.

Version 2.6.3 – 01/11/2019
* Update – Apple Pay new verification file added
* Fixed – Simple, donation and subscription form validation has been improvised
* Added – Payment processing loader with notification added

Version 2.6.2 – 18/10/2019
* Update – Freemius SDK
* Fixed – Subscription button error fixed

Version 2.6.1 – 15/10/2019
* Added – Multiple Form Support with Digital Wallets
* Fixed – Every page load is not creating a new session anymore.

Version 2.6.0 – 01/10/2019
* Fixed – If user unchecked all digital wallet from back end in this case credit card icon not showing on the front end
* Fixed – Form Validation
* Fixed – Embed Video Link placed in front of Test Mode Section
* Fixed – Apple Pay Latest Verification File Updated

Version 2.5.9 – 25/09/2019
* Fixed – Apple Pay verification is happening on plugin activation.
* Fixed – Charge amount now accepts decimal values
* Fixed – Amount field automatically converts the value to an integer

Version 2.5.8 – 19/09/2019
* Added – Digital Wallets Support (Google Pay, Apple Pay, MasterPass)
* Added – 2 Steps pop-up form support
* Added – Square Sandbox Support added
* Added – Strong Customer Authentication added.
* Updated – Square API and SDK version updated from transactionAPI to PaymentAPI

Version 2.5.7 – 29/07/2019
* Added – UI Fixes
* Fixed – Input Field Alignment Issue
* Fixed – Form Fields Label Issue

Version 2.5.6 – 03/07/2019 =
* Updated – Freemius SDK Version 2.3.0

Version 2.5.5 – 14/06/2019 =
* Fixed – Errors appear in the dashboard.

Version 2.5.4 – 13/06/2019
* Added – Subscription not logged condition complete code added.
* Added – credit card form field label conditional view.
* Added – Print transaction amount using in the email using predefined Mail tag.
* Added – Show first name, last name & email fields in the form editor for new forms.
* Updated – Popup header background & color fixes.
* Updated – Fixed Wrong spelling issues.
* Updated – Fixed warning issues on backend settings.
* Updated – Design and layout changes in modal popup and default form.

Version 2.5.3 – 16/04/2019
* Added – Square notice conditions changed.
* Added – Subscription not logged condition.

Version 2.5.2 – 10/04/2019 =
* Added – Square Auth notice.

Version 2.5.1 – 09/04/2019 =
* Updated – Freemius SDK
* Added – Square Auth Connection simple way to connect with the square.
* Added – Square Sandbox Auth Connection Payment process.
* Added – Square Auth Connection button CSS.

Version 2.3.0 – 27/02/2019 =
* Updated – Freemius SDK

Version 2.2 – 18/12/2018 =
* Enhancement – Added compatibility for WordPress 5.0.1
* Enhancement – Added compatibility for WooCommerce 3.5.2
* Added – Action hook for wp_easy_payment_success and wp_easy_payment_failed.
* Added – Redirect page after payment success.
* Added – code quality.

Version 2.0 2018-10-26 =
* Added – Multiple payment buttons support on the same page.
* Fixed – Form fields issue.
* Added – Subscription activation by default.
* Update – Email body template labeling.
* Update – Decimal amount support according to square API.
* Added – Amount field added inside all field tags.
* Added – Card fields mandatory on subscription button form.

Version 1.8 2018-10-16 =
* Add – Dynamic form fields for a pro feature.
* Add – Dynamic transaction note for the pro feature.
* Add – Admin as well notification email templates for a pro feature.
* Update – Popup issues for pro feature.
* Add – Multi-Currency support in free version tested up to Version 4.9.8.

Version 1.6 2018-08-16 =
* Updated – Freemius SDK
Version 1.5 2018-05-28 =
* Added – Custom Pricing for simple and subscription payment
* Added – First name, Last name and email field in all forms i.e donation, simple and subscription form

Version 1.3 2018-04-20 =
* Add – Square Transaction Note fields dynamic for Pro plans.

Version 1.2 2018-04-18 =
* Add – Support for premium plans

Version 1.0 2018-03-01 =
* Initial release

Yes No

Start Receiving
Payments

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.

Learn more

Start Receiving Payments

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.

Learn more