Grow Payments Plugin Documentation

Prerequisites

Before integrating Grow Payments into your application, you need to create an account with Grow Payments. Visit Grow Payments to register. Once your account is set up, you will receive the following credentials:

API Host

Specify the API host to use for requests. Choose between:
– Development: sandbox.meshulam.co.il
– Production: api.meshulam.co.il
This setting determines the environment for processing payments.

Page Code SDK

A unique page code required for initializing the Grow SDK. This value is provided by Grow Meshulam as part of your integration setup.

User ID

A unique identifier assigned to your business by Grow Meshulam. This is required for identifying your account during API calls.

API Key

An API key provided by Grow Meshulam. This key is mandatory for businesses managing multiple accounts or working with specific configurations.

Initial Setup

Follow the steps below to integrate Grow Payments into your application:

Step 1: Add GrowSDK Element

Insert the GrowSDK element on the page where you want to process payments.

Step 2: Create a Backend API Workflow

Create a new API workflow and name it grow_notify (you can choose a different name, but using consistent naming conventions is recommended).

Configure a backend workflow with the following options:

  • Check Expose as public.
  • Check Without authentication.
  • Check Ignore Privacy.
  • Set Trigger Workflow to POST.
  • Set Parameter to Detect request data.
  • Set Response format to JSON.

Step 3: Add a Payment Button

On the page where the GrowSDK element is inserted, create a button for initiating payments.

Add a workflow to the button with the following steps:

Create Payment Process: Refer to the Grow Payments documentation for detailed instructions or read the documentation on each field on filling out the fields.

Render Payment GrowSDK: Use the Auth Code from the result of Step 1.

Ensure this step executes only when the Result of Step 1 is successful (Success is Yes).

Step 4: Detect Request Data

After setting up the backend workflow, click the Detect Data button.

Copy the provided link but do not close the popup.

Step 5: Configure Notify URL

Go back to the “Create Payment Process” step and insert the link copied from Step 4 into the Notify URL field.

Step 6: Test the Payment

Make a test payment to verify the integration.

Return to the Detect Data popup (Step 4) to view the JSON data. Save this data for future use.

Step 7: Approve Transaction

Open the backend workflow created in Step 2.

In the first step, Approve Transaction, populate the necessary fields with the saved JSON data.

Step 8: Save Transactions

Add a new step to the workflow to create a record called Transaction:

Create a new Data Type in your database (e.g., Transaction).

Add fields that align with the Approve Transaction step.

Additional Notes

You can customize your application workflows using the GrowSDK element actions, such as:

Succeed

Failed

Error

Timeout

Wallet Change

Recurring Option

You have a “Redirect” and “Iframe” options (Iframe Preferred),

This option is almost the same as the “Initial Setup”, the difference is you choose recurring from the dropdown in the “Create Process option” and there is a new element called “PaymentIframe” if you want to make through the iframe option.

All examples are inside the Demo Page.

Note: The answer that you will get from the recurring Update/Cancel transaction is only “Successful”.

Invoice Option

This option can take some time.

Step 1: Create a Backend API Workflow

Create another Backend Workflow and call it grow_invoice with the same setting as Step 2 in the Initial Setup.

Click “Detect data” and copy the link “https://[YOURDOMAIN]/version-test/api/1.1/wf/grow_invoice/initialize”.

Step 2: Send Link

Send the link to Grow representative.

Step 3: Payment Call

Initialize a payment call and wait for the data to arrive then save the data.

Step 4: Send Link Again

Send a different link to Grow representative, This time it will be a bit different as we remove the “/initialize” from the end of the link,

“https://[YOURDOMAIN]/version-test/api/1.1/wf/grow_invoice”.

Step 5: Create a workflow

Now just save the parameters to the corresponded transaction.

Refund Option

Step 1: Create a workflow

Set a workflow on a text or icon inside a “Repeating Group / Table” of transactions.

Step 2: Add Refund Action

Fill all the necessary fields, see documentation if necessary.

Step 3: Create a new transaction

Save all the fields inside a new transaction so after that you can see (create a nice looking field) if this was refunded.

With this setup, you’re ready to integrate Grow Payments into your application! 🎉

If you have any questions or encounter issues, refer to the Grow Payments documentation or reach out to support.