Skip to content

README.md

Latest commit

 

History

History
236 lines (163 loc) · 12.8 KB

README.md

File metadata and controls

236 lines (163 loc) · 12.8 KB
Raw

ifthenpay | Payments for GiveWP

Adds ifthenpay as a donation payment gateway for GiveWP: Multibanco, MB WAY, Payshop, Credit Card and more via Pay-By-Link.

Table of Contents

Description

This plugin integrates the ifthenpay payment gateway with GiveWP so donors can pay with Portugal's most popular local payment methods, directly from your donation forms.

Donations are processed through ifthenpay's secure Pay-By-Link system — no card or banking data is ever stored on your website.

After starting a donation, the donor is redirected to a secure ifthenpay-hosted payment page to complete the transaction. ifthenpay then notifies your site via a server-to-server callback so the donation status updates automatically, including for offline/async methods like Multibanco and Payshop.

In plain terms you get:

  • One-time donations through GiveWP's donation forms
  • A "Connect Backoffice" flow to link your ifthenpay account in a few clicks
  • Automatic payment-method sync (with light/dark logos) from your ifthenpay Backoffice
  • Two donation-form field designs: a full card, or a compact inline row
  • Secure, automatic payment confirmation via server-to-server callback
  • Support for Multibanco, MB WAY, Payshop, Credit Card, and more
  • No card numbers stored on your website

All settings are made in GiveWP and in your ifthenpay Backoffice. The plugin is built so site owners can manage donations without needing deep technical knowledge.

Key Features

  1. Full integration with GiveWP's donation form payment gateway flow
  2. Secure transactions via ifthenpay Pay-By-Link (off-site redirect to a hosted checkout)
  3. Automatic, server-to-server payment confirmation — works for asynchronous/offline methods like Multibanco and Payshop, since the donation status never depends on the donor's browser returning
  4. Support for multiple payment methods (Multibanco, MB WAY, Payshop, Credit Card, and more — whatever's enabled on your Gateway Key)
  5. "Connect Backoffice Key" flow with automatic gateway-key and payment-method sync (light and dark logos)
  6. Two donation-form field designs — full card or compact inline row — with a light/dark/auto theme
  7. "Request Activation" flow to ask ifthenpay support to enable a catalog payment method not yet on your Gateway Key
  8. Real-time donation status in GiveWP (Completed, Failed, or Cancelled)
  9. Multi-language support (EN, ES, FR, PT)
  10. Security first — no card data stored; every callback is verified against an anti-phishing key and the expected donation amount

Requirements

  • An active ifthenpay merchant account — subscribe here to obtain your credentials.
  • A GiveWP Gateway Key (request this from ifthenpay support/helpdesk).
  • The payment methods you want enabled on that Gateway Key (our helpdesk team will guide you).
  • WordPress 6.5+ and PHP 8.2+, and GiveWP installed and activated.
  • HTTPS (SSL) enabled on your site.
  • WP-Cron running — either the default WordPress cron (triggered by site visits) or a real server-level cron job hitting wp-cron.php. Required so the donation status updates after ifthenpay's callback; see the FAQ below if you've disabled WP-Cron.

Installation

  1. Install: Upload the plugin zip via Plugins → Add New → Upload, or install from WordPress.org, then Activate. Make sure GiveWP is installed and active first.
  2. Credentials: Ensure your ifthenpay account has an active GiveWP Gateway Key with the desired payment methods enabled.
  3. Connect: Go to GiveWP → Settings → Payment Gateways → ifthenpay and click "Connect with ifthenpay" to link your Backoffice Key.
  4. Configure: Under "Gateway & Payment Methods", choose your Gateway Key, enable the payment methods you want, pick a default method, and set a payment description and link expiry (in days). Under "Field Design", choose between the full-card or inline layout and a color theme.
  5. Enable: Turn on the ifthenpay gateway on your donation forms so donors can select it at checkout.

Frequently Asked Questions

Does this plugin require GiveWP?

Yes. GiveWP (Give – Donation Plugin) must be installed and active to use this plugin.

Where do I get an ifthenpay Backoffice key?

Sign up at ifthenpay.com to get your Backoffice key and a GiveWP Gateway Key.

Does it support recurring donations?

Not in this version. Only one-time donations via Pay-By-Link are supported.

Are payment details stored?

No. The plugin does not store card numbers or full bank details.

Only the minimal references required for payment matching — the donation ID and the ifthenpay request ID — are stored.

Which payment methods are supported?

Any ifthenpay method attached to your Gateway Key, including:

  • Multibanco
  • MB WAY
  • Payshop
  • Credit Card
  • Cofidis
  • Google Pay
  • Apple Pay
  • Pix
How does the payment process work?

After starting a donation, the donor is redirected off-site to a secure ifthenpay-hosted payment page. The donor's return to your site only shows a success/error/cancel confirmation page — the actual donation status is set by a server-to-server callback from ifthenpay, so it works even for offline/async methods like Multibanco or Payshop where the donor never comes back to the browser at all.

What happens if a donation fails or is cancelled?

The donation is marked Failed or Cancelled once ifthenpay's callback reports the outcome. Donors can start a new donation to retry.

Why didn't my donation status update right away after paying?

The server-to-server callback from ifthenpay is received instantly, but GiveWP finalizes the donation status through WordPress's Action Scheduler, which normally runs via WP-Cron. On low-traffic sites, or sites with WP-Cron disabled (DISABLE_WP_CRON) without a real server cron job in its place, this can introduce a short delay before the status visibly updates. If this happens consistently, set up a server-level cron job to call wp-cron.php every few minutes.

What if a payment method I want isn't showing an account yet?

Click "Request Activation" next to that method in the Gateway & Payment Methods table. This emails ifthenpay support with your Gateway Key and the method you want enabled — no need to contact support directly.

Can I customize the payment experience?

Yes. You can choose the full-card or inline field design, the color theme (auto, light, or dark), the gateway title, the default payment description, and the payment-link expiry days.

Is there a sandbox?

ifthenpay may provide test entities for development and testing purposes. If unavailable, we recommend using a low-value live donation.

How secure is the integration?

All requests are encrypted over HTTPS. Every callback is verified against an anti-phishing key tied to your Gateway Key and the expected donation amount before any donation status changes — no sensitive payment data is ever stored on your website.

Why are payment links failing or setup timing out?

Your server firewall or VPN may be blocking outbound requests. The plugin must connect to ifthenpay APIs to function. Ensure your network administrator allows outbound HTTPS traffic to ifthenpay domains.

External Services

This plugin integrates with the ifthenpay payment platform to process payments for GiveWP donation forms. ifthenpay is a third-party service that provides secure payment processing for Multibanco, MB WAY, Payshop, Credit Card, and other local Portuguese payment methods.

  • GiveWP

    • What it is and what it is used for: A donation management plugin. This plugin registers ifthenpay as one of its payment gateways so donors can choose it at checkout.

  • ifthenpay Backoffice & Integrations

    • What it is and what it is used for: The ifthenpay Backoffice is the merchant dashboard used to manage integrations and payment configurations. The plugin uses the ifthenpay API to look up your gateway keys and payment methods, generate Pay-By-Link payment links, and register the server-to-server callback URL.
    • What data is sent and when:
      • During setup: the Backoffice Key (to list your available GiveWP Gateway Keys) and the Gateway Key (to register the callback URL).
      • During payment processing: the donation ID, amount, description, language, link expiry date, the enabled payment-method accounts, success/error/cancel return URLs, and the pre-selected payment method (if any).
      • During callbacks (sent from ifthenpay to this site): the donation ID, an anti-phishing key, the paid amount, the ifthenpay request ID, and — on a failed or cancelled payment — a status code.
      • When requesting activation of a new payment method: the Backoffice Key, Gateway Key, the payment method, your WordPress admin email, and your site's URL, name, WordPress version, GiveWP version, and plugin version are sent by email to ifthenpay support (suporte@ifthenpay.com) — this is a separate channel from the API above.
    • Network & VPN Requirements: Outbound HTTPS requests are made to ifthenpay APIs for setup, link generation, and status validation. Servers behind strict firewalls or restrictive outbound VPNs must allowlist the following domains to prevent connection timeouts:
    • End-User License Agreement (EULA): EULA
    • Privacy Policy: Privacy Policy

All network requests are performed server-side over HTTPS. Sensitive credentials are stored securely and are not publicly exposed. No raw card or bank details are stored.

Screenshots

Below are screenshots demonstrating key features and interfaces of the plugin:

  1. (Admin Only) GiveWP Setup (GiveWP → Setup) GiveWP Setup
  2. (Admin Only) Connect Backoffice Key (GiveWP → Settings → Payment Gateways → ifthenpay) Connect Backoffice Key
  3. (Admin Only) Connect Backoffice Key Popup (Connect with ifthenpay) Backoffice Key Popup
  4. (Admin Only) Disconnect Backoffice Key Popup (Disconnect with ifthenpay) Backoffice Key Popup
  5. (Admin Only) Gateway & Payment Methods tab — Gateway Key selector and payment-methods grid Gateway & Payment Methods
  6. (Admin Only) Field Design tab — full-card vs. inline layout picker with live preview Field Design
  7. (Customers Experience) Donation form — ifthenpay payment option Donation Form
  8. (Customers Experience) Payment Window Payment Window
  9. (Admin Only) Donation Processing Receipt Donation Processing Receipt
  10. (Admin Only) Donation Processing Receipt Preview Processing Receipt Preview
  11. (Admin Only) Entering a Donation Entry Donation Entries
  12. (Admin Only) Donation Single Entry Single Entry

Support

For assistance use the WordPress.org support forum:

Pre-checks:

  • Payment method enabled on the Gateway Key AND mapped to your GiveWP integration
  • Running current recommended versions of WordPress, PHP, & GiveWP
  • WP-Cron is running (or a server cron job hits wp-cron.php regularly) — a stuck "Pending" donation after a successful payment is usually a cron issue, not a plugin issue

Commercial helpdesk available (no direct email required): helpdesk.ifthenpay.com