| Table of Contents |
|---|
Introduction
The Payment Processor Tool is used to integrate different payment gateway methods. Currently, this tool supports Stripe and Paypal payment methods. 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
Name | Description |
|---|---|
Payment Method | The types of payment method supported
|
Below fields are visible when "Payment Method" is Stripe.
| Name | Description |
|---|---|
| API Key | API Key used to connect to Stripe account. Can be Test Mode or Live Mode API Keys. Retrieved from Stripe account page. More information |
| FormDefId | Current form using the tool. |
| Stripe Fields | Header. |
| Product Name | Product name that will be used in payment page for user payment. Used to create Stripe Product object. |
| Currency | Three-letter ISO currency code, in lowercase. Must be a supported currency. (Eg: USD, MYR). Used to create Stripe Price object. |
| Unit Amount | The unit amount in sen to be charged, represented as a whole integer if possible. (Eg: 100 equals to 1.00). Used to create Stripe Price object. |
| Quantity | Total quantity that is bought for the product. Used to create Stripe Payment Link object. |
| Redirect Details | Header. |
| Userview Menu | Userview Menu for redirection to occur after payment is completed. |
| Userview Menu Form ID | Userview Menu form ID set in Userview Menu for redirection to occur after payment is completed. |
Below fields are visible when "Payment Method" is Paypal.
| Name | Description |
|---|---|
| Environment | The types of Paypal environment
|
| Client ID | Client ID used to connect to Paypal account. Retrieved from Paypal created app. More information |
| Client Secret | Client Secret used to connect to Paypal account. Retrieved from Paypal created app. More information |
| Form | Current form using the tool. |
| Acknowledge Link | Redirect URL after payment is completed. |
| Currency | Three-letter ISO currency code, in lowercase. Must be a supported currency. (Eg: USD, MYR). Used to generate payment link. |
| Amount | Total amount charged to the user. Used to generate payment link. |
| InvoiceNo | Invoice number of the order. |
| Description | Description of the order. |
Payment Flow
1. Attach the tool at Post Form Submission Processing. Fill in the Payment Processor Tool Properties.
Figure 1: 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, ...)
Figure 2: 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 3 & 4: Paypal Payment Gateway
Stripe Payment Gateway
Figure 5: 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 6: 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 7: If payment is duplicated redirect back to Userview Form set in configuration