🎉 Celebrate with 10% OFF on All Products! Use Code: GFEX10 Or Buy Any 2+ Items for 30% OFF with Code: GFEX30!

Gravity Forms iATS Payments Gateway Premium Add-on Setup Guide

Updated 10 min read Gravity Forms Payments & Pricing
On this page
  1. Video walkthrough
  2. Installation
  3. Find Your iATS Account Details
  4. Connect the Add-on
  5. Payment options
  6. Add the Payment Field to a Form
  7. Create the Feed
  8. One-time Gifts
  9. Recurring Gifts
  10. Payments on their due dates
  11. Bank Account (ACH) Payments
  12. Refunds and Voids
  13. Webhooks
  14. Notification Events and Merge Tags
  15. Troubleshooting
  16. The secure payment form does not appear.
  17. Saving the settings says iATS did not accept the merchant key.
  18. The form says the payment form changed while it was filled in.
  19. The form says online payments are not available in my currency.
  20. Bank account is not offered on the form.
  21. What happens without an active licence?
  22. Take iATS Donations in Gravity Forms

Video walkthrough

Gravity Forms iATS Payments Gateway: Setup, Merchant Key, ACH and Webhook
Watch: set up iATS Payments donations for Gravity Forms on the WordPress side. Watch on YouTube

A Gravity Forms entry for a Harvest Gala dinner ticket of 120 dollars paid by card: the notes say the payment was approved through the secure payment form with a Visa card ending in 4021, and on the right the iATS Payments box shows status Paid, one-time payment, the card, the amount, the reference and the order id, a refund amount with a Refund button and a Void payment button
The entry screen: payment notes and the iATS Payments box with Refund and Void.

Requirements

  • WordPress 6.5 or newer, PHP 7.4 or newer, a site address with HTTPS.
  • Gravity Forms 2.9 or newer (any licence).
  • An iATS Payments account on the 1stPay gateway, with a sandbox account for testing.
  • Your merchant key, processor ID and Transaction Center ID. For bank payments: ACH enabled on the account and an ACH category.

The Gravity Forms iATS Payments Gateway Premium Add-on takes donations and payments on any Gravity Forms form through iATS Payments, the processor many nonprofits use. The donor types the card or the bank account into the secure iATS payment form, which sits inside your page. iATS turns it into a single-use cryptogram, so card and bank numbers never touch your server. The add-on handles one-time gifts, recurring gifts from the iATS vault, ACH debits from start to finish, refunds and voids. This guide walks you through every setting.

Installation

  1. Download the add-on zip from your GravityExtra account and upload it in Plugins → Add New → Upload Plugin, then activate it.
  2. Go to Forms → Settings → iATS Payments, enter your key in the Gravity Extra License section and click Activate License.
  3. The iATS settings appear below the licence once it is active.

Find Your iATS Account Details

iATS gives each 1stPay account three values. Ask iATS support for them if you do not have them yet, and ask for a sandbox account too, so you can test without real cards.

Value What it does Where it is used
Merchant key Authorises payments, refunds, vault records and status checks. On your server only. Stored encrypted, never shown again.
Processor ID The card processing account (MID/TID) that receives the money. On your server, and in the secure form.
Transaction Center ID Loads the secure iATS payment form for your account. In the browser. It is public by design.
ACH processor ID (optional) Only when bank payments use their own processor ID. For ACH payments and ACH checks.

Keep the merchant key private

The Transaction Center ID and the processor ID are visible in the page source of your form, as iATS intends. The merchant key never is: the add-on keeps it in a password field, stores it encrypted and only uses it on the server.

Connect the Add-on

The iATS Payments settings page: mode Test or Live, the test environment with sandbox account or validation environment, the test merchant key saved encrypted, the processor ID, Transaction Center ID and ACH processor ID, empty live fields, a green line saying the merchant key and processor ID were accepted by iATS, the account currency, the bank account option, the ACH category, the payment form language and the webhook address
Forms → Settings → iATS Payments: account per mode, check, ACH and webhooks.
  1. Leave the mode on Test. Choose Sandbox account when iATS gave you a sandbox processor ID, or Validation environment when they gave you validation credentials.
  2. Paste the test merchant key, the processor ID and the Transaction Center ID.
  3. Click Save Settings. The add-on checks the details with iATS (a read-only query, no charge) and shows Merchant key and processor ID accepted by iATS in green. A wrong key shows the answer from iATS in red.
  4. When your tests pass, fill in the live fields, switch the mode to Live and save again.

Leave the merchant key field empty to keep the saved key. Entries remember the mode they were paid in, so a refund on a test entry always goes to the test account, even after you switch to Live.

Payment options

Setting What it does
Account currency USD or CAD, the currency of your iATS processing account. A form in another currency is refused, so a gift is never charged in the wrong currency.
Bank account (ACH) Lets donors choose to pay from a bank account. ACH must be enabled on your iATS account.
ACH category The name of an ACH category from the iATS Transaction Center, sent with every bank payment. ACH is offered only when it is set.
Payment form language English, French, Spanish or the browser language of the donor.

Add the Payment Field to a Form

Open the form in the editor and add the iATS Payment field from the Pricing Fields group. Use it on forms with Product fields and a Total field. For donations, a Product field with the User Defined Price type makes a good Gift amount field. Map a Name and an Address field too: iATS needs the name and the billing address for online payments.

A donation form for a community food share: how often to give with One time and Monthly, a gift amount of 25 dollars, name, email, phone and billing address, the total, and the payment details with a Pay by choice of Card or Bank account and the secure iATS payment form with card number, month and year, a line saying the card ending 4021 is ready and a note that payment details never reach or stay on the site
The iATS Payment field: the secure iATS form for a card or a bank account.

On the live form the field shows a Pay by choice (when ACH is on) and the secure iATS form. As soon as the details are complete and valid, iATS sends the page a cryptogram and the field says, for example, Card ending 4021 is ready. The form cannot be sent without it. The cryptogram works once, for 15 minutes, and is never saved. Use one iATS Payment field per page.

Create the Feed

Open the form’s Settings → iATS Payments and click Add New.

Setting What to choose
Transaction type Products and Services for one-time gifts, Subscription for recurring gifts.
Payment amount The form total or a single product.
Billing information Map first and last name, email, phone and the address. Name, street, city, state and ZIP are required.
Conditional logic Run the feed only when a condition is met.

One-time and monthly on the same form

Add a choice such as How often would you like to give? with One time and Monthly, then create two feeds: a one-time feed with the condition One time, and a recurring feed with the condition Monthly. Gravity Forms runs the matching feed. On a form with a recurring feed the card or account goes through the iATS vault; for a one-time card gift the add-on deletes the vault record right after the payment.

One-time Gifts

The amount is always worked out on the server from the pricing fields, never taken from the browser. While Gravity Forms validates the form, the add-on sends the payment to the iATS REST API with the cryptogram and a unique order id. The answer decides what happens next:

Answer What the donor sees Entry
Approved (card) Your confirmation message or page. Saved as Paid with the reference number, card type and last four digits read back from iATS.
Pending (bank account) Your confirmation message or page. Saved as Pending until iATS posts the debit.
Declined A message on the payment field, for example The card payment was declined. Not saved. The donor can try another card.
Error or no answer A friendly message saying nothing was charged. Not saved.

If iATS approves only part of the amount, or the amount read back from iATS is different, the add-on voids the payment and asks for another card. You never get an entry that is only partly paid.

Recurring Gifts

Choose Subscription as the transaction type and set the recurring amount, the billing cycle and the number of payments. When the form is sent:

  1. The card or bank account is stored in a new iATS vault for this donor.
  2. The first gift is charged from the vault: the recurring amount plus the setup fee, or the trial amount when a trial is on. A free trial charges nothing now.
  3. The entry is saved as Active, with the next payment date one billing cycle later.
Feed setting What happens
Billing cycle Every 1 to 365 days, 1 to 52 weeks, 1 to 12 months, or 1 to 3 years.
Recurring times The number of payments in total. The first gift counts as one; with a trial it does not. Leave it on infinite to charge until cancelled.
Setup fee Added to the first gift only.
Trial The trial amount replaces the first gift. A free trial only stores the card or account.

Payments on their due dates

Twice a day the add-on charges every recurring gift that is due, from its vault, with an order id such as GF12-AB12CD34EF-9f3c1a-R3 for the third renewal. iATS refuses an order id it has already seen, so a payment can never be taken twice. If the connection drops after iATS took the payment, the next run finds it by its order id and records it without charging again. Due dates are counted from the first gift, so a gift on the 31st moves to the last day of shorter months and comes back.

A declined payment is noted on the entry, fires the Recurring Payment Failed event and is tried again the next day. After three tries the gift stops and the entry tells you to ask the donor for a new card or account. When the last payment is made, the entry becomes Expired and the vault is deleted. Cancelling in Gravity Forms stops the payments and deletes the vault at iATS.

Bank Account (ACH) Payments

ACH debits are not instant. iATS accepts them as Pending, sends them to the bank in the daily run, and the bank can return them days later, for example for insufficient funds. The add-on follows every debit for you:

  • Twice a day, and when you click Check status at iATS, it asks iATS for the debit. When it is posted, a one-time entry becomes Paid and fires Payment Completed; a recurring payment is added to the entry.
  • When the bank returns it, a one-time entry becomes Failed with the return reason and fires Payment Failed. If the first debit of a recurring gift comes back, the gift is stopped and the bank account is removed from the vault.
  • Posted debits are still watched for returns for ten days; later returns arrive through the webhook.
  • While a one-time debit is pending, Cancel ACH debit on the entry voids it.

Refunds and Voids

The iATS Payments box on the entry screen shows the status, payment method, amounts, the reference number and the order id. For one-time card payments it offers:

  • Void payment: cancels a payment that has not settled yet, usually the same day. The entry becomes Voided.
  • Refund: returns all or part of a settled payment. Refund in parts until nothing is left. Before the batch settles, iATS voids the whole sale instead of a refund, and the entry becomes Voided.

Each button asks for confirmation, checks that you may edit entries and sends a one-time request id, so a double click never refunds twice. If iATS refuses, the box shows its answer. Posted ACH debits are refunded in the iATS portal.

Webhooks

ACH returns and chargebacks are found by the twice-daily check anyway. For faster updates, log in to the iATS WebHooks Control Center, add an endpoint with the webhook address shown in the add-on settings, choose JSON and the events ach.reject, ach.chargeback and cc.chargeback. The address carries a secret token. Every notification is only a signal: the add-on reads the event back from iATS with your merchant key before it changes anything. A chargeback adds a note to the entry so you can answer it in the iATS portal.

Notification Events and Merge Tags

Payment feeds add these events to Settings → Notifications: Payment Completed, Payment Failed, Payment Refunded, Payment Voided, Recurring Gift Created, Recurring Payment Added, Recurring Payment Failed, Recurring Gift Canceled and Recurring Gift Finished. In notifications and confirmations, the entry merge tags {entry:payment_status}, {entry:transaction_id}, {entry:payment_amount} and {entry:payment_method} show the payment details.

Troubleshooting

The secure payment form does not appear.

Check that the Transaction Center ID and the processor ID of the active mode are saved and belong to the same account as the merchant key. Ad blockers can block the iATS form; ask the donor to try again without them.

Saving the settings says iATS did not accept the merchant key.

Paste the merchant key again and check the processor ID. A sandbox processor ID works with the Sandbox account choice; validation credentials need the Validation environment.

The form says the payment form changed while it was filled in.

A feed was added or removed while the page was open. The donor reloads the page and enters the details again.

The form says online payments are not available in my currency.

Set the account currency to the currency of your iATS account and use the same currency in Forms → Settings.

Bank account is not offered on the form.

Tick Bank account (ACH) and enter the ACH category exactly as it is named in the Transaction Center.

What happens without an active licence?

The settings show only the licence box, the payment field shows a short note and no payment is taken. Existing entries keep their data.

Take iATS Donations in Gravity Forms

Secure iATS payment form, card and ACH, one-time and recurring gifts, refunds and ACH status, all inside Gravity Forms.

Still need help?

Our support team answers tickets every day, usually within a few hours.

0
0
Your Cart
Your cart is emptyReturn to Shop
🔥 FREQUENTLY BOUGHT TOGETHER
Complete Combo & Save 40%!
ITEM IN YOUR CART
Gravity Forms Klaviyo Add-on
$39.00/yr
+
🎁 RECOMMENDED ADD-ON SAVE 40% OFF
Original Price: $39.00/yr
Bundle Special Price: $23.40/yr