Payment Received workflow trigger

The Payment Received trigger starts a workflow immediately when a matching payment is received. It is the centralized trigger for incoming payments across the platform and can respond to one-time purchases, subscription charges, invoices, successful transactions, failed transactions, particular products, and particular payment sources.

Add the Payment Received trigger

Add the trigger from the workflow builder, then use filters to choose which payments start the workflow.

Open Automations > Workflows and open the workflow.
Click Add New Trigger at the top of the workflow and search the trigger picker for Payment Received. It is listed under Payment triggers in the Workflow triggers catalog. For how triggers and actions fit together, see Workflows Overview.
To limit which payments start the workflow, click add filter and choose a filter, then click add filter again to add sub-filters.

For example, to respond only to payments from a two-step order form:

Select Payment Source, operator is, value Funnel.
Click add filter, then select Sub-Source, operator is, value Two-step order form.

Filters

Filters narrow the payments the trigger responds to, and some filters have sub-filters of their own.

Filter	Options	Sub-filter	Operators
Payment Source	Invoice; One-time invoice; Recurring template; Funnel/Website	Sub-Source: Text2Pay link; One-step order form; Two-step order form; Upsell	is; is not
Transaction type	Customer present/first transaction; Customer not present/subscription transaction	—	—
Calendar	Calendar names	—	—
Global Product	Global product names	Price: price names for the selected Global Product	—
Payment status	Success; Failed	—	—

Sources such as funnels, websites, and invoices can have sub-sources. A funnel payment may come from a one-step order form, a two-step order form, or an upsell, and a sub-source filter identifies which one the payment came from.

Branch with If/Else

After you add filters to the trigger, payment conditions become available for If/Else branches in the workflow.

Option	Operators	Values
Payment > Product	is; is not	Global product names
Payment > Funnel/Website	—	Funnel/Website names
Payment > Calendar	—	Calendar names
Payment > Source	—	Invoice; Funnel; Website; Calendar
Payment > Payment status	—	success; failed
Payment > Amount	Equal to; is not equal to; Greater than; Greater than or equal to; Less than; Less than or equal to; is not empty; is empty	Amount paid

Payment custom values

The payment's values are available as custom values in later workflow actions, such as emails and contact updates.

Group	Custom values
Customer	`{{payment.customer.id}}`; `{{payment.customer.first_name}}`; `{{payment.customer.last_name}}`; `{{payment.customer.name}}`; `{{payment.customer.email}}`; `{{payment.customer.phone}}`; `{{payment.customer.address}}`; `{{payment.customer.city}}`; `{{payment.customer.state}}`; `{{payment.customer.country}}`; `{{payment.customer.postal_code}}`
Invoice	`{{payment.invoice.name}}`; `{{payment.invoice.number}}`; `{{payment.invoice.issue_date}}`; `{{payment.invoice.due_date}}`; `{{payment.invoice.url}}`; `{{payment.invoice.recorded_by}}`
Payment	`{{payment.source}}`; `{{payment.currency_symbol}}`; `{{payment.currency_code}}`; `{{payment.sub_total_amount}}`; `{{payment.discount_amount}}`; `{{payment.coupon_code}}`; `{{payment.tax_amount}}`; `{{payment.created_on}}`; `{{payment.total_amount}}`; `{{payment.transaction_id}}`; `{{payment.payment_status}}`; `{{payment.gateway}}`; `{{payment.card.last4}}`; `{{payment.card.brand}}`; `{{payment.method}}`

Transaction types

The trigger distinguishes between on-session payments and background subscription charges.

Customer present/first transaction: on-session transactions where the customer is making the payment, including one-time purchases and the first order placement for a subscription product.
Customer not present/subscription transaction: background subscription charges after the subscription has been created.

For a recurring product with a 14-day trial, the initial $0 transaction is a Customer present/first transaction; after 14 days, the $100 charge is a Customer not present/subscription transaction.

The trigger includes initial and later subscription payments: it fires when the customer submits an order form and when a subscription is charged in the background.

To run a workflow for successful subsequent subscription charges, set Source type to Funnel/Website, Transaction type to Customer not present/subscription transaction, and Payment status to Success — or to Failed when the workflow is for failed payments.

Without filters, the trigger runs for both successful and failed payment attempts. To target one outcome, add the payment status filter and choose Success or Failed.

When you select a specific product, the trigger fires when that product is sold through funnels, websites, or invoices. The payment status filter determines whether successful, failed, or both attempts are included.

The trigger fires for both initial and later subscription payments, so a workflow built for one-time purchases also runs on background subscription charges. Filter with Transaction type or Payment status when a workflow should run for only one kind of payment.

Was this helpful?