Payment Hooks

Action Hooks 39 Hooks

These hooks fire during payment processing — rendering, status changes, refunds, subscriptions, and webhooks.

fluentform/rendering_payment_form

Description

This action runs when rendering payment form.

Parameters

• $form (object) Payment Form

Usage

add_action('fluentform/rendering_payment_form', function($form) {
   // Do your stuff when rendering payment form
}, 10, 1);

Reference

do_action('fluentform/rendering_payment_form', $form);

This action is located in fluentform/app/Modules/Component/Component.php

---

fluentform/before_insert_payment_form

Description

If the form has payment then this action will be fired before submission. You can use this to do your payment related custom tasks.

Parameters

• $insertData Form response data
• $formData Form Raw Data
• $form Form Object

Usage:

add_action('fluentform/before_insert_payment_form', function ($insertData, $formRawData, $form){
   // Do your stuff here
}, 10, 3);

Reference

$this->app->doAction('fluentform/submission_inserted_' . $form->type . '_form', $insertId, $formData, $form);

This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php

---

fluentform/render_payment_entries

Description

This action runs before rendering the payment entries.

Usage:

add_action('fluentform/render_payment_entries', function (){
   // Do your stuff here
}, 10, 0);

Reference

do_action('fluentform/render_payment_entries');

This action is located in fluentform/app/Modules/Registerer/Menu.php

---

fluentform/rendering_payment_method_{$methodName}

Description

This action runs when rendering the payment active methods.

Parameters

• $paymentMethod - (string) Current Payment Method
• $data - (array) Current Payment Element
• $form - (object) Form

Usage:

add_action('fluentform/rendering_payment_method_{$methodName}', function ($paymentMethod, $data, $form){
   // Do your stuff here
}, 10, 3);

Note: {$methodName} is dynamic method name. Replace {$methodName} with Fluent Forms payment methods name.

Reference

do_action('fluentform/rendering_payment_method_' . $methodName, $activatedMethod, $data, $form);

This action is located in fluentformpro/src/Payments/Components/PaymentMethods.php, fluentform/app/Services/FluentConversational/Classes/Converter/Converter.php

---

fluentform/payment_frameless_{$paymentMethod}

Description

This action runs before rendering the payment redirect handler page.

Parameters

• $data - (array) Payment Data

Usage:

add_action('fluentform/payment_frameless_{$paymentMethod}', function ($data){
   // Do your stuff here
}, 10, 1);

Note: {$paymentMethod} is dynamic method name. Replace {$paymentMethod} with Fluent Forms payment methods name.

Reference

do_action('fluentform/payment_frameless_' . $paymentMethod, $data);

This action is located in fluentformpro/src/Payments/PaymentHandler.php

---

fluentform/payment_method_render_{$paymentMethod}

Description

This action runs if the form has single payment method, then the payment method is rendered using this method.

Parameters

• $methodElement (array) Payment Method Data
• $form (object) Form Object

Usage:

add_action('fluentform/payment_method_render_{$paymentMethod}', function ($methodElement, $data){
   // Do your stuff here
}, 10, 2);

Note: {$paymentMethod} is dynamic method name. Replace {$paymentMethod} with Fluent Forms payment methods name.

Reference

do_action('fluentform/payment_method_render_' . $paymentMethod, $methodElement, $data);

This action is located in fluentformpro/src/Payments/Components/PaymentMethods.php

---

fluentform/payment_refunded

Description

This action runs after a successful refund on every payment method. You can hook into this and get the refund data.

Parameters

• $refund (array) Refund Data
• $form_id (int) Form ID

Usage:

add_action('fluentform/payment_refunded', function($refund, $form_id) {
   // Do your stuff here
}, 10, 2);

Note: {$paymentMethod} is dynamic method name. Replace {$paymentMethod} with Fluent Forms payment methods name.

Reference

do_action('fluentform/payment_refunded', $refund, $refund->form_id);

This action is located in fluentformpro/src/Payments/PaymentMethods/BaseProcessor.php

---

fluentform/ipn_mollie_action_{$status}

Description

This action runs when Mollie ipn verification response.

Parameters

• $submission (object) Submission Object
• $vendorData - (array) Transaction vendor data
• $data (array) Encoded vendor data

Usage:

add_action('fluentform/ipn_mollie_action_{$status}', function($submission, $vendorData, $data) {
   // Do your stuff here
}, 10, 3);

Note: {$status} is valid Mollie payment status (opens new window). Replace {$status} with INP transaction type.

Reference

do_action('fluentform/ipn_mollie_action_' . $status, $submission, $vendorTransaction, $data);

This action is located in fluentformpro/src/Payments/PaymentMethods/Mollie/API/IPN.php

---

fluentform/ipn_mollie_action_refunded

Description

This action runs when Mollie ipn verification response with refund.

Parameters

• $amount (int) Refund Amount
• $submission (object) Submission Object
• $vendorData - (array) Transaction vendor data
• $data (array) Encoded vendor data

Usage:

add_action('fluentform/ipn_mollie_action_refunded', function($amount, $submission, $vendorData, $data) {
   // Do your stuff here
}, 10, 4);

Reference

do_action('fluentform/ipn_mollie_action_refunded', $refundAmount, $submission, $vendorTransaction, $data);

This action is located in fluentformpro/src/Payments/PaymentMethods/Mollie/API/IPN.php

---

fluentform/ipn_razorpay_action_{$status}

Description

This action runs when Razorpay ipn verification response.

Parameters

• $submission (object) Submission Object
• $vendorData - (array) Transaction vendor data
• $data (array) Encoded vendor data

Usage:

add_action('fluentform/ipn_razorpay_action_{$status}', function($submission, $vendorData, $data) {
   // Do your stuff here
}, 10, 3);

Note: {$status} is valid Razorpay payment status.

Reference

do_action('fluentform/ipn_razorpay_action_' . $status, $submission, $vendorTransaction, $data);

This action is located in fluentformpro/src/Payments/PaymentMethods/RazorPay/API.php

---

fluentform/ipn_razorpay_action_refunded

Description

This action runs when Razorpay ipn verification response with refund.

Parameters

• $amount (int) Refund Amount
• $submission (object) Submission Object
• $vendorData - (array) Transaction vendor data
• $data (array) Encoded vendor data

Usage:

add_action('fluentform/ipn_razorpay_action_refunded', function($amount, $submission, $vendorData, $data) {
   // Do your stuff here
}, 10, 4);

Reference

do_action('fluentform/ipn_razorpay_action_refunded', $refundAmount, $submission, $vendorTransaction, $data);

This action is located in fluentformpro/src/Payments/PaymentMethods/RazorPay/API.php

---

fluentform/stripe_customer_created

Description

This action runs after created Stripe customer.

Parameters

• $data (array) Customer API response
• $customerArgs (array) Customer Args

Usage:

add_action('fluentform/stripe_customer_created', function($data, $customerArgs) {
   // Do your stuff here
}, 10, 2);

Reference

do_action('fluentform/stripe_customer_created', $response, $customerArgs);

This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/API/Customer.php

---

fluentform/payment_stripe_failed

Description

This action runs when handle payment charge error.

Parameters

• $submission (object) Submission
• $transaction (object) Transaction
• $formId (int) Form Id
• $charge (bool) Charged or not
• $type (string) Type
  • customer
  • subscription
  • invoice
  • payment_intent
  • payment_error

Usage:

add_action('fluentform/payment_stripe_failed', function($submission, $transaction, $formId, $charge, $type) {
   // Do your stuff here
}, 10, 5);

Reference

do_action('fluentform/payment_stripe_failed', $submission, $transaction, $this->form->id, $charge, $type);

This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/StripeProcessor.php -> handlePaymentChargeError()

---

fluentform/payment_failed

Description

This action runs when handle payment charge error.

Parameters

• $submission (object) Submission
• $transaction (object) Transaction
• $formId (int) Form Id
• $charge (bool) Charged or not
• $type (string) Type
  • customer
  • subscription
  • invoice
  • payment_intent
  • payment_error

Usage:

add_action('fluentform/payment_failed', function($submission, $transaction, $formId, $charge, $type) {
   // Do your stuff here
}, 10, 5);

Reference

do_action('fluentform/payment_failed', $submission, $transaction, $this->form->id, $charge, $type);

This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/StripeProcessor.php -> handlePaymentChargeError()

---

fluentform/transactions_before_table

Description

This action runs before creating transactions receipt table.

Parameters

• $transaction (array) Transactions

Usage:

add_action('fluentform/transactions_before_table', function($transactions) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/transactions_before_table', $transactions);

This action is located in fluentformpro/src/views/receipt/transactions_table.php

---

fluentform/transaction_table_thead_row

Description

This action runs after creating transactions receipt table head (th).

Parameters

• $transactions (array) Transactions

Usage:

add_action('fluentform/transaction_table_thead_row', function($transactions) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/transaction_table_thead_row', $transactions);

This action is located in fluentformpro/src/views/receipt/transactions_table.php

---

fluentform/transactions_actions

Description

This action runs when render transaction receipt table body actions.

Parameters

• $transaction (object) Transaction

Usage:

add_action('fluentform/transactions_actions', function($transaction) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/transactions_actions', $transaction);

This action is located in fluentformpro/src/views/receipt/transactions_table.php

---

fluentform/transaction_table_tbody_row

Description

This action runs after render transaction receipt table body td.

Parameters

• $transaction (object) Transaction
• $transactions (array) Transactions

Usage:

add_action('fluentform/transaction_table_tbody_row', function($transaction, $transactions) {
   // Do your stuff here
}, 10, 2);

Reference

do_action('fluentform/transaction_table_tbody_row', $transaction, $transactions);

This action is located in fluentformpro/src/views/receipt/transactions_table.php

---

fluentform/transactions_before_table_close

Description

This action runs before closing transactions receipt table.

Parameters

• $transactions (array) Transactions

Usage:

add_action('fluentform/transactions_before_table_close', function($transactions) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/transactions_before_table_close', $transactions);

This action is located in fluentformpro/src/views/receipt/transactions_table.php

---

fluentform/transactions_after_table

Description

This action runs after created transaction receipt table.

Parameters

• $transactions (array) Transactions

Usage:

add_action('fluentform/transactions_after_table', function($transactions) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/transactions_after_table', $transactions);

This action is located in fluentformpro/src/views/receipt/transactions_table.php

---

fluentform/after_transaction_status_change

Description

This action runs when change transaction status.

Parameters

• $status (string) Valid Payment Status
• $submission (object) Submission
• $transtionId (int) Transaction ID

Usage:

add_action('fluentform/after_transaction_status_change', function($status, $submission, $transtionId) {
   // Do your stuff here
}, 10, 3);

Reference

do_action( 'fluentform/after_transaction_status_change', $newStatus, $this->getSubmission(), $transactionId );

This action is located in fluentformpro/src/Payments/PaymentMethods/BaseProcessor.php

---

fluentform/ipn_paypal_action_{$txn_type}

Description

This action runs when PayPal ipn verification response. You can use to specify transaction type processing you want to perform.

Parameters

• $encoded_data_array (array) Encoded Data
• $submissionId (int) Submission ID
• $submission (object) Submission Object
• $ipnVerified (boolean) Ipn Verification

Usage:

add_action('fluentform/ipn_paypal_action_{$txn_type}', function($encoded_data_array, $submissionId, $submission, $ipnVerified) {
   // Do your stuff here
}, 10, 4);

Note: {$txn_type} is dynamic IPN transaction types (opens new window). Replace {$txn_type} with INP transaction type.

Reference

do_action('fluentform/ipn_paypal_action_' . $encoded_data_array['txn_type'], $encoded_data_array, $submissionId, $submission, $ipnVerified);

This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php

---

fluentform/ipn_paypal_action_web_accept

Description

This action runs during the web accept PayPal ipn.

Parameters

• $encoded_data_array (array) Encoded Data
• $submissionId (int) Submission ID
• $submission (object) Submission Object
• $ipnVerified (boolean) Ipn Verification

Usage:

add_action('fluentform/ipn_paypal_action_web_accept', function($encoded_data_array, $submissionId, $submission, $ipnVerified) {
   // Do your stuff here
}, 10, 4);

Reference

do_action('fluentform/ipn_paypal_action_web_accept', $encoded_data_array, $submissionId, $submission, $ipnVerified);

This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php

---

fluentform/process_payment

Description

This action runs when process payment

Parameters

• $submissionId (int) Form ID
• $submissionData (array) Submission Data
• $form (object) Form
• $methodSettings (array) Selected Method Settings
• $subscriptionItems (boolean) Is Subscription
• $totalPayable (int) Payable amount
• $submissionServiceHandler (object) Service Handler Instance

Usage:

add_action('fluentform/process_payment', function($submissionId, $submissionData, $form, $methodSettings, $subscriptionItems, $totalPayable, $submissionServiceHandler) {
   // Do your stuff here
}, 10, 7);

Reference

do_action('fluentform/process_payment', $this->submissionId, $this->submissionData, $this->form, $this->methodSettings, !!$subscriptionItems, $totalPayable, $this->submissionServiceHandler);

This action is located in fluentformpro/src/Payments/Classes/PaymentAction.php

---

fluentform/process_payment_{$method_name}

Description

This action runs when process payment.

Parameters

• $submissionId (int) Form ID
• $submissionData (array) Submission Data
• $form (object) Form
• $methodSettings (array) Selected Method Settings
• $subscriptionItems (boolean) Is Subscription
• $totalPayable (int) Payable amount

Usage:

add_action('fluentform/process_payment_{$method_name}', function($submissionId, $submissionData, $form, $methodSettings, $subscriptionItems, $totalPayable) {
   // Do your stuff here when process payment
}, 10, 6);

Note: {$method_name} is dynamic value. Replace {$method_name} with valid fluent form payment method name.

Reference

do_action('fluentform/process_payment_' . $this->selectedPaymentMethod, $this->submissionId, $this->submissionData, $this->form, $this->methodSettings, !!$subscriptionItems, $totalPayable);

This action is located in fluentformpro/src/Payments/Classes/PaymentAction.php

---

fluentform/form_payment_success

Description

This action runs after PayPal subscription complete

Parameters

• $submission (object) Submission Object
• $transaction (array) Transaction Data
• $formId (int) Form ID
• $ipnVerified (boolean) Ipn Verification

Usage:

add_action('fluentform/form_payment_success', function($submission, $transaction, $formId, $ipnVerified) {
   // Do your stuff here
}, 10, 4);

Reference

do_action('fluentform/form_payment_success', $submission, $transaction, $formId, false);

This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php

---

fluentform/before_entry_payment_deleted

Description

This action runs before payment entries delete

Parameters

• $entries (array) Deleted entries id
• $transactions (array) Transaction entries to delete

Usage:

add_action('fluentform/before_entry_payment_deleted', function($entries, $transactions) {
   // Do your stuff here
}, 10, 2);

Reference

do_action('fluentform/before_entry_payment_deleted', $entries, $transactionData);

This action is located in fluentformpro/src/Payments/Classes/PaymentEntries.php

---

fluentform/after_entry_payment_deleted

Description

This action runs after payment entries deleted

Parameters

• $entries (array) Deleted entries id
• $transactions (array) Transaction entries to delete

Usage:

add_action('fluentform/after_entry_payment_deleted', function($entries, $transactions) {
   // Do your stuff here
}, 10, 2);

Reference

do_action('fluentform/after_entry_payment_deleted', $entries, $transactionData);

This action is located in fluentformpro/src/Payments/Classes/PaymentEntries.php

---

fluentform/form_submission_activity_start

Description

This action runs when PayPal INP process subscription payment or Stripe handle cancelled subscription.

Parameters

• $formId (ing) Form Id

Usage:

add_action('fluentform/form_submission_activity_start', function($formId) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/form_submission_activity_start', $submission->form_id);

This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php -> processSubscriptionPayment() This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/API/StripeListener.php -> handleSubscriptionCancelled()

---

fluentform/payment_subscription_status_to_cancelled

Description

This action runs when subscription payment status change to cancelled

Parameters

• $subscription (object) Subscription data
• $submission (object) Submission data
• $oldStatus (string) Subscription old status

Usage:

add_action('fluentform/payment_subscription_status_to_cancelled', function($subscription, $submission, $oldStatus) {
   // Do your stuff here
}, 10, 3);

Reference

do_action('fluentform/payment_subscription_status_to_cancelled', $subscription, $submission, $oldStatus);

This action is located in fluentformpro/src/Payments/Classes/PaymentManagement.php

---

fluentform/payment_subscription_status_{$payment_method}_to_{$newStatus}

Description

This action runs when subscription payment status change to cancelled

Parameters

• $subscription (object) Subscription data
• $submission (object) Submission data
• $oldStatus (string) Subscription old status

Usage:

add_action('fluentform/payment_subscription_status_{$payment_method}_to_{$newStatus}', function($subscription, $submission, $oldStatus) {
   // Do your stuff here
}, 10, 3);

Note: {$payment_method} and {$newSatus} is dynamic value. Replace {$payment_method} with fluentform valid payment method and {$newSatus} with valid subscription payment status for responsible payment method.

Reference

do_action('fluentform/payment_subscription_status_' . $submission->payment_method . '_to_' . $newStatus, $subscription, $submission, $oldStatus);

This action is located in fluentformpro/src/Payments/Classes/PaymentManagement.php

---

fluentform/payment_receipt_before_content

Description

This action runs before rendering payment receipt

Parameters

• $submission (object) Submission data

Usage:

add_action('fluentform/payment_receipt_before_content', function($submission) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/payment_receipt_before_content', $this->entry);

This action is located in fluentformpro/src/Payments/Classes/PaymentReceipt.php

---

fluentform/payment_receipt_after_content

Description

This action runs after rendered payment receipt

Parameters

• $submission (object) Submission data

Usage:

add_action('fluentform/payment_receipt_after_content', function($submission) {
   // Do your stuff here
}, 10, 1);

Reference

do_action('fluentform/payment_receipt_after_content', $this->entry);

This action is located in fluentformpro/src/Payments/Classes/PaymentReceipt.php

---

fluentform/payment_view_{$route}

Description

This action runs before rendering the payment handler view.

Parameters

• $data - (array) Payment Data

Usage:

add_action('fluentform/payment_view_{$route}', function($data) {
   // Do your stuff here
}, 10, 1);

Note: {$route} is dynamic value. Replace {$route} with valid payment view route.

Reference

do_action('fluentform/payment_view_' . $route, $data);

This action is located in fluentformpro/src/Payments/PaymentHandler.php

---

fluentform/ipn_endpoint_{$paymentMethod}

Description

This action runs when payment handler api notify.

Usage:

add_action('fluentform/ipn_endpoint_{$paymentMethod}', function() {
   // Do your stuff here
}, 10, 0);

Note: {$paymentMethod} is dynamic value. Replace {$paymentMethod} with valid payment method.

Reference

do_action('fluentform/ipn_endpoint_' . $paymentMethod);

This action is located in fluentformpro/src/Payments/PaymentHandler.php

---

fluentform/subscription_payment_received

Description

This action runs when PayPal new subscription received.

Parameters

• $submission - (object) Submission data
• $updatedSubscription - (array) Subscription updated data
• $formId - (int) Form Id
• $subscription - (object) Subscription data

Usage:

add_action('fluentform/subscription_payment_received', function($subscription, $submission, $vendorData) {
   // Do your stuff here
}, 10, 4);

Reference

do_action('fluentform/subscription_payment_received', $subscription, $submission, $vendorData);

This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php

---

fluentform/subscription_payment_received_paypal

Description

This action runs when PayPal new subscription received.

Parameters

• $submission - (object) Submission data
• $updatedSubscription - (array) Subscription updated data
• $formId - (int) Form Id
• $subscription - (object) Subscription data

Usage:

add_action('fluentform/subscription_payment_received_paypal', function($subscription, $submission, $vendorData) {
   // Do your stuff here
}, 10, 4);

Reference

do_action('fluentform/subscription_payment_received_paypal', $subscription, $submission, $vendorData);

This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php

---

fluentform/subscription_payment_canceled

Description

This action runs when recorded subscription cancelled.

Parameters

• $subscription - (object) Subscription data
• $submission - (object) Submission data
• $vendorData - (array) Subscription vendor data

Usage:

add_action('fluentform/subscription_payment_canceled', function($subscription, $submission, $vendorData) {
   // Do your stuff here
}, 10, 3);

Reference

do_action('fluentform/subscription_payment_canceled', $subscription, $submission, $vendorData);

This action is located in fluentformpro/src/Payments/PaymentHelper.php

---

fluentform/subscription_payment_canceled_{$payment_method}

Description

This action runs when recorded subscription cancelled.

Parameters

• $subscription - (object) Subscription data
• $submission - (object) Submission data
• $vendorData - (array) Subscription vendor data

Usage:

add_action('fluentform/subscription_payment_canceled_{$payment_method}', function($subscription, $submission, $vendorData) {
   // Do your stuff here
}, 10, 3);

Note: {$payment_method} is dynamic value. Replace {$payment_method} with valid fluentform payment method name.

Reference

do_action('fluentform/subscription_payment_canceled_' . $submission->payment_method, $subscription, $submission, $vendorData);

This action is located in fluentformpro/src/Payments/PaymentHelper.php