Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Introduction

The Payment Processor Tool is used to integrate different payment gateway methods. Currently, this tool supports Stripe and Paypal. Users can modify the product details to generate a customised payment link. The payment link can be conveniently sent to customers via email or any configurable ways, allowing them to perform payment.


This plugin is created with the aid of Stripe API Documentation and Paypal API Documentation.



Payment Processor Tool Properties

Configure Payment Processor Tool

NameDescription
FormCurrent form using the tool
Payment Method

The types of payment method supported

  • All
  • Paypal

  • Stripe

Paypal CredentialsHeader. Contents under this category is only visible when Payment Method is Paypal or All.
Environment

The types of Paypal environment

  • Sandbox

  • Live

Client IDClient ID used to connect to Paypal account. Retrieved from Paypal created app. More information
Client SecretClient Secret used to connect to Paypal account. Retrieved from Paypal created app. More information
Stripe CredentialsHeader. Contents under this category is only visible when Payment Method is Stripe or All.
API KeySecret API Key used to perform Stripe API calls. Can be Test Mode or Live Mode API Keys. Retrieved from Stripe account page. More information
Input Fields to Generate Payment LinkHeader
CurrencyThree-letter ISO currency code, in lowercase. Must be a supported currency. (Eg: USD, MYR). *Please check whether the currency is supported with your Paypal account.
Total AmountThe total amount to be charged.
Redirect DetailsHeader
Userview MenuUserview Menu for redirection to occur after payment is completed.
Userview Menu Form IDUserview Menu form ID set in Userview Menu for redirection to occur after payment is completed.



Plugin Compulsory Configurations

Compulsory configurations:

  • This field is compulsory at *redirected Redirected form to ensure that user does not click on the same link twice (duplicate payment)

Figure 2: *Redirected form is set at Redirect Details


Figure 3: Payment Status field with ID "payment_status"


  • These hidden fields are compulsory to ensure Stripe payment methods works smoothly.

Figure 4: Stripe compulsory hidden fields


  • These hidden fields are compulsory to ensure Paypal payment methods works smoothly.

Figure 5: Paypal compulsory hidden fields



Payment Flow 

1. Attach the tool at Post Form Submission Processing. Fill in the Payment Processor Tool Properties.

Figure 6: Post Form Submission Processing at Form Builder


Set API key / client details to connect to the payment method.

Set the product details necessary to ensure sufficient details to generate the payment link.


2. User fills in the payment link form and submits. A temporary payment link will be generated.


3. We can use any desired ways to share the link for the customer.

(Eg: utilising the Email Tool, using a simple datalist to show the payment link, set the payment link as hyperlink or button in form,...)

Figure 7: Set starting form, then Email Tool at Process Builder


4. User clicks on the payment link, redirects the user to the payment gateway respectively.

Paypal Payment Gateway

   

Figure 8 & 9: Paypal Payment Gateway


Stripe Payment Gateway

Figure 10: Stripe Payment Gateway


5. User keys in payment details and perform payment.

If payment is success, redirects the user back to the redirect page configured by the user. The page will show the payment information.

Figure 11: After payment success redirect back to Userview Form set in configuration


If payment has already been done and user clicks the link again, the user will directly be redirected back to the redirect URL.

Figure 12: If payment is duplicated redirect back to Userview Form set in configuration