📘API Guidelines for Platforms (System Integrators)

This section is intended exclusively for platforms that enable multiple businesses to process payments through their own system using Grow payments.

This guide includes important parameters and requirements relevant only to platforms like yours.

API Key Requirement
Each API request must include your unique apiKey, which identifies your system.
This is mandatory for authentication.
Your apiKey is a unique identifier that links all API activity to your platform.

You will receive your apiKey along with all other integration-specific identifiers required for your development.

Company Commission
As a platform, you can define commission amount per transaction (in ILS, excluding VAT) to be automatically deducted from each transaction and allocated to your system.

Implementation – Company Commission

The Company Commission parameter allows you to set a custom commission amount for each transaction when creating a Payment Form via the API.

To enable this, include the following parameter in your API request:

Key: companyCommission

Value: The commission amount to be allocated.

Details:
Type: optional
Description: A different commission amount than the standard Meshulam commission.
Example: 2.5
Important: The company commission is specified in shekels (ILS), excluding VAT, and not in percentages.