Grow

https://grow-il.readme.io/reference/
Admin
Grow is a payment solution designed to provide seamless and efficient payment integration for...
Tokens:23,607
Snippets:109
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### API Documentation for Payment Process Creation and Token Management

Source: https://grow-il.readme.io/reference/overview-4

Comprehensive guide to the `create Payment Process` endpoint, covering both token-only storage and combined transaction with token saving functionalities. This endpoint allows initiating payments and managing customer card tokens for future transactions.

```APIDOC
Endpoint: POST /api-light-server/1.0/createpaymentprocess

Purpose: Initiates a payment process or saves a credit card token.

Use Case 1: Token Storage Only
  Description: Saves a credit card token without processing a full payment.
  Parameters:
    sum: 1 (Required, indicates token storage intent)
    chargeType: 3 (Required, specific type for tokenization)
    saveCardToken: 1 (Required, flag to enable token saving)
  Flow:
    1. Execute a call to create Payment Process with sum=1.
    2. Set parameters: chargeType=3 and saveCardToken=1.
    3. After the customer fills in credit card details, their token is saved.
    4. Receive the token update from Grow Systems for future transactions.

Use Case 2: Regular Transaction with Token Save
  Description: Performs a standard payment transaction while simultaneously saving the customer's card token.
  Parameters:
    saveCardToken: 1 (Required, flag to enable token saving)
    (Other standard transaction parameters for payment processing apply)
  Flow:
    1. Use create Payment Process for a standard transaction.
    2. Simultaneously save the token by adding the parameter saveCardToken=1.
    3. After the payment, the card token is saved, and you receive an update from Grow Systems.
```

--------------------------------

### Sample Server Response for Payment Process

Source: https://grow-il.readme.io/reference/implement-code-on-client-side

This JSON snippet provides an example of a successful response object returned by the server-side 'createPaymentProcess' API. It illustrates the structure of the data, including the 'processId', 'processToken', and the crucial 'authCode' which is then used by the client-side SDK.

```JSON
{
  "status": 1,
  "err": "",
  "data": {
    "processId": 413133,
    "processToken": "92ab69240c00aa073eb818dc646e2c32",
    "authCode": "beb1064aa495042a69c9c5e2dc384180%NDEzMTM0"
  }
}
```

--------------------------------

### Client-Side Grow Payment SDK Methods

Source: https://grow-il.readme.io/reference/implement-code-on-client-side

This APIDOC entry details the primary methods available in the client-side 'growPayment' SDK for integrating the payment wallet. It covers how to render the payment options, the expected parameters, and important considerations regarding wallet state and validity, including the 'onWalletChange' event.

```APIDOC
Method: growPayment.renderPaymentOptions(authCode: string)

Description: Renders the payment wallet UI, allowing the user to select and complete payment. This method makes an internal API call to the Grow backend before the wallet is visually rendered.

Parameters:
  - authCode: (string, required) The authentication code received from the server-side 'createPaymentProcess' API.

Returns: (void) The method initiates the wallet rendering process.

Events:
  - onWalletChange: (callback) Recommended to use this event to track the wallet's loading state (e.g., to show/hide a loader) as there's a delay before the wallet is visually rendered.

Usage Example:
  if (response.status && growPayment) {
    growPayment.renderPaymentOptions(response.authCode);
  }

Important Notes:
  - The wallet has a limited validity time, which starts when the backend 'createPaymentProcess' API is called.
  - The wallet will become invalid after approximately 4 minutes from its creation.
  - All SDK scripts must be implemented in the frontend.
```

--------------------------------

### API Endpoints for Regular Payments

Source: https://grow-il.readme.io/reference/overview-2

This section outlines API endpoints for initiating and approving standard, one-time payment processes. It includes references to response structures and server-to-server callbacks.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-2
  Description: Initiates a regular payment process.

POST /api-light-server-1-0/approvetransaction
  Description: Approves a previously initiated transaction.
```

--------------------------------

### API for Regular Payments

Source: https://grow-il.readme.io/reference/errors

This section outlines the API endpoints related to initiating and approving regular payment processes.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-2
  Description: Initiates a regular payment process.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/approvetransaction
  Description: Approves a transaction.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### Server-Side createPaymentProcess API

Source: https://grow-il.readme.io/reference/implement-code-on-client-side

This APIDOC entry describes the server-side API endpoint responsible for initiating a new payment process. It highlights the required 'pageCode' setting, the structure of the JSON response including 'authCode', and the critical timing consideration for calling this API due to the 'authCode's limited validity.

```APIDOC
Method: createPaymentProcess (Server-Side)

Description: Initiates a new payment process and generates an authentication code for the client-side SDK.

Parameters:
  - pageCode: (string, required) Must be configured for 'SDK wallet mode'.

Returns (JSON Object):
  {
    "status": (integer) 1 for success, 0 for error.
    "err": (string) Error message if status is 0.
    "data": {
      "processId": (integer) Unique identifier for the payment process.
      "processToken": (string) Token for the payment process.
      "authCode": (string) Authentication code required by the SDK's renderPaymentOptions method.
    }
  }

Usage Context:
  - Call this method from your backend server.
  - The returned 'authCode' is then passed to the client-side 'growPayment.renderPaymentOptions' method.
  - The 'authCode' has a limited validity time (e.g., 4 minutes), so call this API right before rendering the wallet.
```

--------------------------------

### Client-Side Call to renderPaymentOptions

Source: https://grow-il.readme.io/reference/implement-code-on-client-side

This JavaScript snippet demonstrates how to conditionally call the 'growPayment.renderPaymentOptions' method on the client-side. It checks for a successful 'status' in the server 'response' and the availability of the 'growPayment' SDK object before passing the 'authCode' to initiate the payment wallet.

```JavaScript
// response - the response you received from 'createPaymentProcess'
if (response.status && growPayment) {
   growPayment.renderPaymentOptions(response.authCode);
}
```

--------------------------------

### API Endpoints for Premium Recurring Payments via Token

Source: https://grow-il.readme.io/reference/overview-2

This section outlines API endpoints for managing premium recurring payments that utilize tokens, covering both initial and subsequent payments, and general management of such transactions.

```APIDOC
POST /api-light-server-1-0/createtransactionwithtoken-3
  Description: Processes the first payment for a premium recurring token-based transaction.

POST /api-light-server-1-0/createtransactionwithtoken-1
  Description: Processes further payments for a premium recurring token-based transaction.

POST /api-light-server-1-0/createtransactionwithtoken-5
  Description: Manages premium recurring payments via token.
```

--------------------------------

### Grow Systems Token Billing API for Recurring Payments

Source: https://grow-il.readme.io/reference/overview-8

This API documentation outlines the process for managing token-based recurring payments with Grow Systems, covering initial token saving, first recurring payment initiation, and subsequent recurring payments. It also includes an important note on handling non-recurring payments.

```APIDOC
createPaymentProcess
  - Purpose: Saves a token using a standard form submission.
  - Usage: Call this method to save the initial payment token.

createTransactionWithToken
  - Purpose: Initiates and manages recurring debit payments using a saved token.

  Initial Recurring Payment:
    - Method: createTransactionWithToken
    - Parameters:
      - isRecurringDebitPayment: 1 (Required, integer. Set to 1 for the first recurring debit payment.)
    - Returns:
      - recurringDebitId: (String. Unique identifier for the recurring debit. Must be saved for subsequent payments.)
    - Usage: Call this method for the very first transaction of a recurring series.

  Subsequent Recurring Payments:
    - Method: createTransactionWithToken
    - Parameters:
      - recurringDebitId: (String. Required. The ID received from the initial recurring payment.)
    - Usage: Call this method for all subsequent transactions in a recurring series after the initial setup.

  Important Note for Non-Recurring Payments:
    - When making regular, non-recurring payments, DO NOT send the 'recurringDebitId' or 'isRecurringDebitPayment' parameters.
```

--------------------------------

### API Endpoints for Recurring Payments

Source: https://grow-il.readme.io/reference/overview-2

This section covers API endpoints for managing recurring payment processes, including initiation, approval, and updates for direct debit arrangements.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-4
  Description: Initiates a recurring payment process.

POST /api-light-server-1-0/approvetransaction-2
  Description: Approves a recurring transaction.

POST /api-light-server-1-0/updatedirectdebit
  Description: Updates an existing direct debit arrangement for recurring payments.
```

--------------------------------

### API for Premium Recurring Payments via Token

Source: https://grow-il.readme.io/reference/errors

This section describes API endpoints for managing premium recurring payments using tokens, covering initial and subsequent payments.

```APIDOC
POST /api-light-server-1-0/createtransactionwithtoken-3
  Description: Initiates the first payment for premium recurring payments via token.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/createtransactionwithtoken-1
  Description: Processes further payments for premium recurring payments via token.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/createtransactionwithtoken-5
  Description: Manages premium recurring payments via token.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### API Parameters for Multi-Business Operations

Source: https://grow-il.readme.io/reference/authentication

Details on parameters used to manage multiple client businesses within the Grow payment system, including unique company identification and commission handling.

```APIDOC
Parameter: apiKey
  - Description: A distinctive identifier linked to your company, connected to the respective userIds for each business you serve.
  - Usage Example: To process payments for a specific client company, you'll use their designated userId, the appropriate pageCode, and the apiKey associated with your accounting services company.
  - Type: String (implied)
  - Constraints: Unique identifier

Parameter: companyCommission
  - Description: Allows companies to charge commissions for their services.
  - Type: (Implied, likely a number or boolean)
  - Usage: Used to apply a commission fee.
```

--------------------------------

### API Endpoints for Payment Request Links

Source: https://grow-il.readme.io/reference/overview-2

This section details API endpoints for managing payment links, including creation, updates, retrieval of information, and transaction approval related to these links.

```APIDOC
POST /api-light-server-1-0/createpaymentlink
  Description: Creates a new payment link.

POST /api-light-server-1-0/updatepaymentlink-1
  Description: Updates an existing payment link.

POST /api-light-server-1-0/getpaymentlinkinfo-1
  Description: Retrieves information about a specific payment link.

POST /api-light-server-1-0/approvetransaction-1
  Description: Approves a transaction associated with a payment link.
```

--------------------------------

### API Endpoints for Token Management

Source: https://grow-il.readme.io/reference/overview-2

This section details API endpoints for working with payment tokens, including obtaining tokens, creating payments with token saving, creating transactions using tokens, and retrieving token-related transaction information.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-6
  Description: Retrieves a payment token only.

POST /api-light-server-1-0/createpaymentprocess-9
  Description: Creates a payment and saves the token for future use.

POST /api-light-server-1-0/createtransactionwithtoken-4
  Description: Creates a transaction using an existing token.

POST /api-light-server-1-0/gettokentransactionsbyexternalidentifiers-1
  Description: Retrieves token transactions based on external identifiers.
```

--------------------------------

### API Endpoints for Payment and Transaction Information

Source: https://grow-il.readme.io/reference/overview-2

This section covers API endpoints for retrieving detailed information about transactions and payment processes.

```APIDOC
POST /api-light-server-1-0/gettransactioninfo
  Description: Retrieves detailed information about a specific transaction.

POST /api-light-server-1-0/getpaymentprocessinfo
  Description: Retrieves detailed information about a specific payment process.
```

--------------------------------

### API for Payment Requests (Payment Links)

Source: https://grow-il.readme.io/reference/errors

This section details API endpoints for managing payment links, including creation, updates, information retrieval, and transaction approval.

```APIDOC
POST /api-light-server-1-0/createpaymentlink
  Description: Creates a payment link.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/updatepaymentlink-1
  Description: Updates an existing payment link.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/getpaymentlinkinfo-1
  Description: Retrieves information about a payment link.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/approvetransaction-1
  Description: Approves a transaction associated with a payment link.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### API for Recurring Payments

Source: https://grow-il.readme.io/reference/errors

This section covers API endpoints for managing recurring payment processes, including initiation, approval, and updates.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-4
  Description: Initiates a recurring payment process.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/approvetransaction-2
  Description: Approves a recurring transaction.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/updatedirectdebit
  Description: Updates a recurring payment (direct debit).
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### API for Token Management

Source: https://grow-il.readme.io/reference/errors

This section provides API endpoints for working with payment tokens, including token retrieval, payment creation with token saving, and transaction creation using tokens.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-6
  Description: Retrieves a token only.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/createpaymentprocess-9
  Description: Creates a payment and saves the token.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/createtransactionwithtoken-4
  Description: Creates a transaction using a token.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/gettokentransactionsbyexternalidentifiers-1
  Description: Retrieves token transactions by external identifiers.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### API Endpoints for Delayed Payments (J4J5)

Source: https://grow-il.readme.io/reference/overview-2

This section provides API endpoints specific to delayed payment processes under the J4J5 framework, including initiation and settlement of suspended transactions.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-10
  Description: Initiates a delayed payment process (J4J5).

POST /api-light-server-1-0/settlesuspendedtransaction-1
  Description: Settles a previously suspended transaction.
```

--------------------------------

### API for Payment & Transaction Information

Source: https://grow-il.readme.io/reference/errors

This section outlines API endpoints for retrieving detailed information about transactions and payment processes.

```APIDOC
POST /api-light-server-1-0/gettransactioninfo
  Description: Retrieves information about a specific transaction.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/getpaymentprocessinfo
  Description: Retrieves information about a payment process.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### API Endpoints for Refunds

Source: https://grow-il.readme.io/reference/overview-2

This section provides API endpoints for processing refunds and canceling transactions.

```APIDOC
POST /api-light-server-1-0/refundtransaction
  Description: Initiates a refund for a transaction.

POST /api-light-andriod-1-0/cancelbittransaction-1
  Description: Cancels a specific bit transaction (Android-related).
```

--------------------------------

### API Parameter: PaymentType Mapping

Source: https://grow-il.readme.io/reference/parameter-mapping

Specifies the integer codes for different payment types supported by the API.

```APIDOC
PaymentType:
  Direct Debit (הוראת קבע): 1
  Regular: 2
  Payments: 4
```

--------------------------------

### API for Refunds

Source: https://grow-il.readme.io/reference/errors

This section provides API endpoints for processing refunds and canceling transactions.

```APIDOC
POST /api-light-server-1-0/refundtransaction
  Description: Refunds a transaction.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-andriod-1-0/cancelbittransaction-1
  Description: Cancels a bit transaction.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### API for Delayed Payments (J4J5)

Source: https://grow-il.readme.io/reference/errors

This section outlines API endpoints for handling delayed payments, including process creation and settling suspended transactions.

```APIDOC
POST /api-light-server-1-0/createpaymentprocess-10
  Description: Initiates a delayed payment process (J4J5).
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.

POST /api-light-server-1-0/settlesuspendedtransaction-1
  Description: Settles a suspended transaction.
  Note: Detailed parameters, request/response bodies, and error conditions are not provided in the source text.
```

--------------------------------

### Grow Systems Token Billing API

Source: https://grow-il.readme.io/reference/manage-by-you

API methods for managing token-based recurring payments with Grow Systems. This includes saving payment tokens and initiating or processing recurring debits.

```APIDOC
createPaymentProcess
  Purpose: Saves a token using a standard form for future payment processing.
  Usage: This is the initial step to secure a token before initiating any transactions.

createTransactionWithToken
  Purpose: Initiates or processes recurring payments using a previously saved token.
  Parameters:
    isRecurringDebitPayment: (Optional) Set to '1' for the *initial* recurring debit payment. This parameter signals the start of a recurring series.
    recurringDebitId: (Optional) The unique identifier received from the *initial* createTransactionWithToken call. This parameter is required for *subsequent* recurring payments to link them to the original series.
  Returns:
    recurringDebitId: (For initial call) A unique code identifying the recurring debit series, which must be saved for future use.
  Important Notes:
    - For the *initial* recurring payment, call with 'isRecurringDebitPayment=1'. Save the returned 'recurringDebitId'.
    - For *subsequent* recurring payments, send the saved 'recurringDebitId' in the call.
    - When making regular non-recurring payments, do NOT send 'recurringDebitId' or 'isRecurringDebitPayment'.
```

--------------------------------

### GROW Payment Token Flows API

Source: https://grow-il.readme.io/reference/overview-4

Details for initiating recurring payments and charging existing tokens within the GROW payment system. These flows enable secure and efficient transaction processing.

```APIDOC
Recurring Payment with Token API
  Method: InitiateRecurringPayment
  Description: Sets up a recurring payment managed by GROW using a token.
  Parameters:
    - paymentType: Integer
      Description: Type of payment. Must be '1' for recurring payments.
      Constraints: Value = 1
    - paymentNum: Integer
      Description: Number of recurring payments/installments.
      Constraints: Range = 1-48
  Returns: (Not specified in text)

Charge Token API
  Method: ChargeSavedToken
  Description: Executes a transaction by charging a previously saved token.
  Parameters: (Implicitly requires a token identifier, not explicitly detailed in text)
  Returns: (Not specified in text)
```

--------------------------------

### API Parameter: CardBrandCode Mapping

Source: https://grow-il.readme.io/reference/parameter-mapping

Defines the integer codes corresponding to various credit card brands used in API requests.

```APIDOC
CardBrandCode:
  Mastercard: 2
  Visa: 3
  Isracard: 5
  Diners: 8
  Discover: 7
```

--------------------------------

### Required IP Addresses for Payment Gateway Firewall Configuration

Source: https://grow-il.readme.io/reference/ip-adress

Lists the IP addresses that must be whitelisted in the firewall for successful communication with the payment gateway's testing and live environments. These IPs are crucial for processing API transactions securely.

```text
IP test:
3.123.194.128
3.124.62.248
18.198.97.252
3.75.43.49

IP live:
18.158.107.17
3.121.149.170
3.76.166.104
3.69.160.29
3.78.79.166
3.71.221.153
3.78.131.18
3.67.110.47
18.192.112.151
52.59.95.229
18.158.145.146
3.75.128.58
3.78.28.179
3.122.21.187
3.66.126.119
35.158.249.118
52.29.70.254
52.59.159.234
3.76.183.119
18.157.106.67
18.156.94.176
18.197.238.68
3.66.129.154
3.77.123.153
3.70.40.72
```

--------------------------------

### Grow.il Payment Status Codes (StatusCode)

Source: https://grow-il.readme.io/reference/parameter-mapping

This section defines the various status codes used by Grow's payment platform to indicate the state of a transaction. Understanding these codes is crucial for interpreting transaction information and ensuring accurate communication during integration with Grow's payment system.

```APIDOC
StatusCode:
  0: Not paid
  2: paid
  4: Canceled before transmission
  6: Refund transaction
  9: Transaction denied
```

--------------------------------

### API Parameter: TransactionTypeId Mapping

Source: https://grow-il.readme.io/reference/parameter-mapping

Provides integer codes for various transaction types, including credit card, mobile payments, and bank transfers.

```APIDOC
TransactionTypeId:
  Credit card: 1
  Bit: 6
  Apple Pay: 13
  Google Pay: 14
  Bank Transfer: 15
```
Tokens:
Raw