README

Verify Gravity Forms bank details with Loqate bank verification API.

Goal
Usage
Minimum Requirements
Installation
FAQ
Testing
Feedback
Change Log
Security
Credits
License

Goal

GF Loqate Bank Verification verifies Gravity Forms bank details with Loqate bank verification API.

It validates the bank details (branch sort codes and bank account numbers):

indicates whether the account number and sort code are valid
indicates whether the account can accept direct debits. Certain accounts (e.g. savings) will not accept direct debits

Usage

Get your service key from Loqate

Register an Loqate account
Add Bank Verification
Get the Service key

Plugin Setting

Head to Form » Settings » Bank Verification
Enter your Loqate bank verification service key

A green check ✅ appears if the service key is valid.

Form Fields Setting

Add 2 Single Line Text fields

Sort Code
Account Number

Mark both fields required
Set their Custom CSS Class to:

gflbv-sort-code-is-correct
gflbv-account-number-is-correct

Minimum Requirements

PHP v7.2
WordPress v4.9.10
[Gravity Forms](https://www.Gravity Forms.com/) v2.4.14.4

Installation

Composer (Recommended)

composer require itinerisltd/gf-loqate-bank-verification

wordpress.org (WP CLI)

wp plugin install gf-loqate-bank-verification

wordpress.org

Download from https://wordpress.org/plugins/gf-loqate-bank-verification Then, install gf-loqate-bank-verification.zip as usual.

Build from Source (Not Recommended)

# Make sure you use the same PHP version as remote servers.
# Building inside docker images is recommanded.
php -v

# Checkout source code
git clone https://github.com/ItinerisLtd/gf-loqate-bank-verification.git
cd gf-loqate-bank-verification
git checkout <the-tag-or-the-branch-or-the-commit>

# Build the zip file
composer release:build

Then, install release/gf-loqate-bank-verification.zip as usual.

FAQ

Does it support checking for Direct Debit capability?

Yes. Certain accounts (e.g. savings) will not accept direct debits. To verify bank details are both correct and Direct Debit capable, set the fields' Custom CSS Class to:

gflbv-sort-code-is-correct gflbv-sort-code-direct-debit-capable
gflbv-account-number-is-correct gflbv-account-number-direct-debit-capable

Does it cache Loqate API responses?

Yes. Loqate API responses are cached in WordPress transients for an hour.

To clear caches:

wp transient delete --all

Will you add support for older PHP versions?

Never! This plugin will only work on actively supported PHP versions.

Don't use it on end of life or security fixes only PHP versions.

It looks awesome. Where can I find more goodies like this?

Articles on Itineris' blog
More projects on Itineris' GitHub profile
More plugins on Itineris and TangRufus wp.org profiles
Follow @itineris_ltd and @TangRufus on Twitter
Hire Itineris to build your next awesome site

Where can I give ⭐⭐⭐⭐⭐ reviews?

Thanks! Glad you like it. It's important to let my boss knows somebody is using this project. Please consider:

leave a 5-star review on wordpress.org
tweet something good with mentioning @itineris_ltd and @TangRufus
⭐ star this Github repo
👀 watch this Github repo
write blog posts
submit pull requests
hire Itineris

Testing

composer style:check

Pull requests without tests will not be accepted!

Feedback

Please provide feedback! We want to make this library useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small.

Change Log

Please see CHANGELOG for more information on what has changed recently.

Security

If you discover any security related issues, please email dev@itineris.co.uk instead of using the issue tracker.

Credits

GF Loqate Bank Verification is a Itineris Limited project created by Tang Rufus.

Full list of contributors can be found here.

License

GF Loqate Bank Verification is released under the MIT License.

itinerisltd / gf-loqate-bank-verification

Maintainers

Details