### Initial Setup of Recurring Payment for Internal Management

Source: https://grow-il.readme.io/reference/introduction/reference/premium-recurring-payment

This method is used for the initial setup of a recurring payment when managed internally by your company. It saves a token and returns a `recurringDebitId` for subsequent charges.

```APIDOC
Method: CreateTransactionWithToken
Purpose: Initial setup of a recurring payment managed internally, saving a token.
Parameters:
  isRecurringDebitId: 1 (Required, indicates internal recurring debit setup)
Returns:
  recurringDebitId: string (Code for the recurring payment, received in server update)
```

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

### Generic Payment Page Configuration Example

Source: https://grow-il.readme.io/reference/introduction/reference/payment-page

This snippet provides an example of a `PageCode` for a generic payment page that accepts Credit Cards or Bit. It highlights customization options such as adding customer information fields and notes on usage constraints like `maxPaymentNum`.

```APIDOC
Generic Payment Page:
  PageCode: b73ca07591f8
  Features:
    - Accepts payments with Credit Cards or Bit.
    - Customization options: customer information fields, logo, notification settings.
    - Allows up to 2 additional fields (e.g., Full Name, Phone, Email, ID number).
  Usage Notes:
    - Do not send maxPaymentNum when using this pageCode.
    - All identifiers are for demonstration purposes only.
    - Testing userId: 4ec1d595ae764243
```

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

### Example Success Response for Get Transaction Info API

Source: https://grow-il.readme.io/reference/introduction/reference/response-1

This JSON object illustrates a successful response from the 'Get Transaction Info' API endpoint, providing detailed information about a specific transaction, including status, card details, payment amounts, dates, and payer information.

```JSON
{
    "status": 1,
    "err": "",
    "data": {
        "asmachta": "300000209",
        "cardSuffix": "1234",
        "cardType": "Local",
        "cardTypeCode": "1",
        "cardBrand": "Visa",
        "cardBrandCode": "3",
        "cardExp": "1111",
        "firstPaymentSum": 0,
        "periodicalPaymentSum": 0,
        "status": "שולם",
        "statusCode": 2,
        "transactionTypeId": "1",
        "paymentType": "1",
        "sum": "2",
        "paymentsNum": 0,
        "allPaymentsNum": 1,
        "paymentDate": "21/9/23",
        "description": "test ",
        "fullName": "israeli israel",
        "payerPhone": "0500000000",
        "payerEmail": "",
        "processId": "5000000",
        "processToken": "d088459226b5dbdc8c99c2c2c2c2c",
        "transactionId": "33500000",
        "transactionToken": "ecfd7fe4c8a16a1a1a1a1a1a1a1a1",
        "directDebitId": "19123456",
        "paymentLinkProcessId": "355555",
        "paymentLinkProcessToken": "27bd6f995ca5c10f55d1a1a1a1a1a",
        "recurringDebitId": "20011",
        "customField": []
    }
}
```

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

### CreatePaymentLink API Success Response Example

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy-3

Example of a successful JSON response from the `createFarPaymentProcess` call for creating a payment link. The `status` field is `1` for success. The `err` field is empty. The `data` object contains `paymentLinkProcessId`, `paymentLinkProcessToken`, and the `url` of the created payment link.

```JSON
{
    "status": 1,
    "err": "",
    "data": {
        "paymentLinkProcessId": 6652,
        "paymentLinkProcessToken": "ac3f4d3b656d3245454512c5ff33d7030",
        "url": "https://sandbox.meshulam.co.il/payment_link?l=a994875846565656199971473385ac5b3"
    }
}
```

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

### Successful API Response JSON Example

Source: https://grow-il.readme.io/reference/introduction/reference/response-get-transaction-info-copy

Example of a successful API response, detailing transaction and process information including process ID, token, and an array of transaction details.

```JSON
{
    "status": 1,
    "err": "",
    "data": {
        "processId": "1234122",
        "processToken": "dc4de4d5ae45cc22dbb7s2s5s1s2s5s4s1",
        "customField": [],
        "transactions": [
            {
                "asmachta": "30012345",
                "cardSuffix": "1234",
                "cardType": "Local",
                "cardTypeCode": "1",
                "cardBrand": "Visa",
                "cardBrandCode": "3",
                "cardExp": "1120",
                "firstPaymentSum": "0",
                "periodicalPaymentSum": "0",
                "status": "שולם",
                "statusCode": "2",
                "transactionTypeId": "1",
                "paymentType": "2",
                "sum": "3",
                "paymentsNum": "0",
                "allPaymentsNum": "1",
                "paymentDate": "24/9/23",
                "description": "תיאור",
                "fullName": "לקוח לקוח",
                "payerPhone": "0500000000",
                "payerEmail": "[email protected]",
                "cardToken": "e18ec3fa5dd331d0f030ss5d5d4ds5s5d41d",
                "transactionId": "33123456",
                "transactionToken": "9ac26ed383f9c1e7e8absds54ds54s8d"
            }
        ]
    }
}
```

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

### Growin SDK Integration Guide

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

Overview of the Growin SDK, designed for modular online payment processing without redirects or iframes, enhancing user experience and flexibility.

```APIDOC
SDK Purpose:
  Provides an easy solution for online payments, avoiding redirects or iframes.

Integration Flow:
  1. Server-side: Call `createPaymentProcess` method with `pageCode` set to SDK wallet mode.
     Note: The payment is valid for 10 minutes from the `createPaymentProcess` call.
  2. Client-side: Use the returned `authCode` to open the wallet with `renderPaymentOptions` method.

Features:
  - No 3DS (3D Secure) required.
```

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

### Standard API Response Examples

Source: https://grow-il.readme.io/reference/introduction/reference/responae

Demonstrates the JSON structure for both successful and failed API responses, detailing the 'status', 'err', and 'data' fields.

```JSON
{
    "status": 1,
    "err": "",
    "data": ""
}
```

```JSON
{
    "status": 0,
    "err": {
        "id": 801,
        "message": "קוד זיהוי עסק אינו תקין"
    },
    "data": ""
}
```

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

### Recurring Payment API Endpoints

Source: https://grow-il.readme.io/reference/introduction/reference/sdk-apple

API endpoints for managing recurring payment processes, including initial setup and updates.

```APIDOC
Recurring Payment: POST /api-light-server-1-0-createpaymentprocess-4
```

```APIDOC
Approve Transaction: POST /api-light-server-1-0-approvetransaction-2
```

```APIDOC
Update Recurring Payment: POST /api-light-server-1-0-updatedirectdebit
```

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

### API Response Example: Successful Payment Process

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy

Illustrates a successful API response for a payment process, including the process ID, process token, and a URL for redirection.

```JSON
  {
    "status": 1,
    "err": "",
    "data": {
      	"processId":"734754",
      	"processToken":"2153287cd9af46457ae842337250b78d",
      	"url":"https://sandbox.meshulam.co.il/far?l=89a71a421b8e0686024fbb762dab61e1"
    	}
    }
```

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

### API Endpoints for Recurring Payments

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

Outlines the API endpoints for managing recurring payments, including initial setup, responses, callbacks, transaction approval, and updates to direct debits.

```APIDOC
Recurring Payment:
  - Overview: /reference/overview-1
  - API Endpoint: POST /api-light-server-1-0/createpaymentprocess-4 (Recurring Payment)
  - Response Documentation: /reference/response-copy-copy
  - Server-to-Server Callback Documentation: /reference/server-response-copy-copy
  - API Endpoint: POST /api-light-server-1-0/approvetransaction-2 (Approve Transaction)
  - API Endpoint: POST /api-light-server-1-0/updatedirectdebit (Update Recurring Payment)
  - Response Documentation: /reference/responae
```

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

### Grow-il API Documentation Structure

Source: https://grow-il.readme.io/reference/introduction/reference/recurring-vs-token

This snippet outlines the hierarchical structure of the Grow-il API documentation, categorizing topics into Reference, Environments, Core Resources, and SDK App sections. It serves as a navigational guide to the various API-related subjects available.

```APIDOC
Reference:
  - Introduction
  - Authentication
  - Supported Payment Method
  - Payments Type:
    - Billing vs Token
  - Billing:
    - Premium Recurring Payment
  - Token
  - Parameter Mapping
  - Errors
  - IP Addresses
  - Platforms & Multi-Merchant Systems
Environments:
  - Testing Environment
  - Production Environment
Core resources:
  - Payment Process
  - Payment Page
  - Iframe vs Redirect
  - Success URL
  - Bit Redirect
  - Post Massage
  - Server Response
  - Apple Domain Verification
  - SDK Growin
  - NFC
  - 3DS
Sdk App:
  - SDK bit IOS
  - SDK bit Android
```

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

### Grow-il API Reference Documentation Structure

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy-copy

This section outlines the hierarchical structure of the Grow-il API documentation, providing links to detailed information on various API functionalities, environments, and SDKs. It serves as a navigation guide for the API reference.

```APIDOC
API Reference:
  Introduction: /reference/introduction
  Authentication: /reference/authentication
  Supported Payment Method: /reference/payments
  Payments Type:
    Billing vs Token: /reference/recurring-vs-token
  Billing:
    Premium Recurring Payment: /reference/premium-recurring-payment
  Token: /reference/token
  Parameter Mapping: /reference/parameter-mapping
  Errors: /reference/errors
  IP Addresses: /reference/ip-adress
  Platforms & Multi-Merchant Systems: /reference/api-guidelines-for-platforms-system-integrators

Environments:
  Testing Environment: /reference/testing-environment
  Production Environment: /reference/live-environment

Core resources:
  Payment Process: /reference/the-process
  Payment Page: /reference/payment-page
  Iframe vs Redirect: /reference/iframe-vs-redirect
  Success URL: /reference/success-url
  Bit Redirect: /reference/bit-redirect
  Post Massage: /reference/postmassage
  Server Response: /reference/server-response-1
  Apple Domain Verification: /reference/sdk-apple
  SDK Growin: /reference/implement-code-on-client-side
  NFC: /reference/nfc-1
  3DS: /reference/3ds-1

Sdk App:
  SDK bit IOS: /reference/sdk-bit-ios
  SDK bit Android: /reference/sdk-bit-android-copy
```

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

### Payment Methods API Endpoints Overview

Source: https://grow-il.readme.io/reference/introduction/reference/response-1

This section provides a structured overview of the available API endpoints for different payment operations, categorized by payment method type and their associated functionalities.

```APIDOC
Payment Methods:
  - Postman Collection: /reference/postman-collection
  - Regular Payments:
    - Overview: /reference/overview-6
    - Create Payment Process: POST /api-light-server-1-0-createpaymentprocess-2
    - Response: /reference/reponse
    - Server-to-Server Callback: /reference/server-response
    - Approve Transaction: POST /api-light-server-1-0-approvetransaction
  - Payment Request:
    - Overview: /reference/payment-link
    - Create Payment Link: POST /api-light-server-1-0-createpaymentlink-1
    - Response: /reference/response-copy-3
    - Server-to-Server Callback: /reference/server-respons-copy
    - Update Payment Link: POST /api-light-server-1-0-updatepaymentlink
    - Get Payment Link Info: POST /api-light-server-1-0-getpaymentlinkinfo
    - Approve Transaction: POST /api-light-server-1-0-approvetransaction-1
  - Recurring payment:
    - Overview: /reference/overview-1
    - Create Recurring Payment Process: POST /api-light-server-1-0-createpaymentprocess-4
    - Response: /reference/response-copy-copy
    - Server-to-Server Callback: /reference/server-response-copy-copy
    - Approve Transaction: POST /api-light-server-1-0-approvetransaction-2
    - Update Recurring Payment: POST /api-light-server-1-0-updatedirectdebit
    - Response: /reference/responae
  - Delayed Payment J4J5:
    - Overview: /reference/overview-2
    - Create Delayed Payment J4J5 Process: POST /api-light-server-1-0-createpaymentprocess-10
    - Response: /reference/response-copy
    - Server-to-Server Callback: /reference/server-response-copy
    - Settle Suspended Transaction: POST /api-light-server-1-0-settlesuspendedtransaction-1
    - Response: /reference/response-copy-1
  - Work with Token:
    - Overview: /reference/overview-4
    - Get Token Only: POST /api-light-server-1-0-createpaymentprocess-6
    - Server response: /reference/server-response-copy-1
    - Create Payment & Save Token: POST /api-light-server-1-0-createpaymentprocess-9
    - Create Transaction With Token: POST /api-light-server-1-0-createtransactionwithtoken-4
    - Response: /reference/response-copy-2
    - Get Token Transactions By External Identifiers: POST /api-light-server-1-0-gettokentransactionsbyexternalidentifiers-1
  - Premium recurring payment via token:
    - Manage by you:
      - Overview: /reference/overview-8
      - First Payment - Premium Recurring By Token: POST /api-light-server-1-0-createtransactionwithtoken-3
      - Further Payment - Premium Recurring By Token: POST /api-light-server-1-0-createtransactionwithtoken-1
    - Manage by Grow:
      - Overview: /reference/overview-9
      - Manage Premium Recurring Payment Via Token: POST /api-light-server-1-0-createtransactionwithtoken-5
  - Refund:
    - Overview: /reference/overview-3
    - Refund Transaction: POST /api-light-server-1-0-refundtransaction
    - Cancel Bit Transaction: POST /api-light-andriod-1-0-cancelbittransaction-1
    - Response: /reference/response
  - Payment & Transaction Info:
    - Overview: /reference/overview-5
    - Get Transaction Info: POST /api-light-server-1-0-gettransactioninfo
    - Get Payment Process Info: POST /api-light-server-1-0-getpaymentprocessinfo
    - Response get transaction info: /reference/response-1
    - Response get payment process info: /reference/response-get-transaction-info-copy
```

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

### Grow-il API Reference Documentation Structure

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy-3

This section outlines the hierarchical structure and available topics within the Grow-il API documentation, providing a navigation guide for developers to find relevant information.

```APIDOC
Reference:
  - Introduction
  - Authentication
  - Supported Payment Method
  - Payments Type:
    - Billing vs Token
  - Billing:
    - Premium Recurring Payment
  - Token
  - Parameter Mapping
  - Errors
  - IP Addresses
  - Platforms & Multi-Merchant Systems

Environments:
  - Testing Environment
  - Production Environment

Core resources:
  - Payment Process
  - Payment Page
  - Iframe vs Redirect
  - Success URL
  - Bit Redirect
  - Post Massage
  - Server Response
  - Apple Domain Verification
  - SDK Growin
  - NFC
  - 3DS

Sdk App:
  - SDK bit IOS
  - SDK bit Android
```

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

### Example Success Response for Payment Transaction

Source: https://grow-il.readme.io/reference/introduction/reference/response

Illustrates a successful JSON response for a payment-related API call, detailing transaction status, card information, payment details, and payer information.

```JSON
{
    "status": 1,
    "err": "",
    "data": {
        "refundedTransactionId": 33333333,
        "asmachta": "301234567",
        "cardSuffix": "3213",
        "cardType": "Local",
        "cardTypeCode": "1",
        "cardBrand": "Visa",
        "cardBrandCode": "3",
        "cardExp": "1110",
        "status": "תשלום שזוכה",
        "statusCode": 3,
        "transactionTypeId": "1",
        "paymentType": "2",
        "sum": "3",
        "paymentDate": "26/9/23",
        "description": "תיאור",
        "fullName": "לקוח לקוח",
        "payerPhone": "0500000000",
        "payerEmail": "[email\u00a0protected]",
        "transactionId": "33123456"
    }
}
```

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

### Recurring Payment API Endpoints

Source: https://grow-il.readme.io/reference/introduction/reference/3ds-1

API endpoints for managing recurring payments, covering initial setup, updates, and transaction approvals.

```APIDOC
Recurring Payment:
  - Overview: /reference/overview-1
  - Create Recurring Payment: POST /api-light-server-1-0/createpaymentprocess
  - Approve Transaction: POST /api-light-server-1-0/approvetransaction
  - Update Recurring Payment: POST /api-light-server-1-0/updatedirectdebit
  - Response Handling: /reference/response-copy-copy, /reference/responae
  - Server-to-Server Callback: /reference/server-response-copy-copy
```

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

### Meshulam SDK API Parameters

Source: https://grow-il.readme.io/reference/introduction/reference/sdk-bit-ios

Defines the required and optional parameters necessary for interacting with the Meshulam SDK API, typically received after account setup.

```APIDOC
Parameters:
- UserId (required): Refers to every business that is connected to Grow.
- ApiKey (required): Refers to companies that are working with multiple businesses. In this case, you will need to send both the apiKey and the userId for every transaction that you would like to clear.
- PageCode (required): Is for your API settings at Grow. There might be more than one pageCode, for instance, a pageCode for credit card template only and a pageCode for Bit.
- Sum (required): The amount you want to charge the client with.
- FullName (required): The full name of the user.
- Phone (required): The phone num of the user.
- Delegate (required): Protocol.
- Email (optional): The email of the user.
- Description (optional): Description of the user.
```

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

### Recurring Payments API Endpoints

Source: https://grow-il.readme.io/reference/introduction/reference/token

API endpoints for managing recurring payment processes, including initial setup, approvals, and updates.

```APIDOC
POST /api/light/server/1.0/createpaymentprocess
```

```APIDOC
POST /api/light/server/1.0/approvetransaction
```

```APIDOC
POST /api/light/server/1.0/updatedirectdebit
```

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

### CreatePaymentLink API Failure Response Example

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy-3

Example of a JSON response indicating a failure from the `createFarPaymentProcess` call for creating a payment link. The `status` field is `0` for failure. The `err` object contains an `id` (error code) and `message` (error description). The `data` field is empty.

```JSON
{
    "err": {
        "id": 54,
        "message": "חסרים נתונים:pageCode"
    },
    "status": "0",
    "data": ""
}
```

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

### API Response Field Descriptions

Source: https://grow-il.readme.io/reference/introduction/reference/response-get-transaction-info-copy

Detailed explanation of the common fields found in API responses, including their purpose and possible values.

```APIDOC
status: integer
  Description: Indicates success or failure of the operation.
  Values: 1 (success), 0 (failure)
err: object | string
  Description: Contains error details if the status is 0.
  Properties:
    id: integer (Error code)
    message: string (Error message)
  Values: An object with 'id' and 'message' on error, or an empty string on success.
data: object | string
  Description: Contains all relevant details for a successful operation.
  Values: An object with process and transaction details on success, or an empty string on error.
```

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

### Recurring Payment API Endpoints

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

This section outlines API endpoints for managing recurring payments, including initial setup, subsequent payments, and updates to recurring payment profiles.

```APIDOC
Overview: General information on recurring payment processing.
```

```APIDOC
API Endpoint: POST /api-light-server/1.0/createpaymentprocess
Description: Initiates a new recurring payment process.
```

```APIDOC
Response: Details on the expected response format for recurring payment processes.
```

```APIDOC
Server-to-Server Callback: Information on server-side notifications for recurring payment status.
```

```APIDOC
API Endpoint: POST /api-light-server/1.0/approvetransaction
Description: Approves a pending recurring transaction.
```

```APIDOC
API Endpoint: POST /api-light-server/1.0/updatedirectdebit
Description: Updates a direct debit recurring payment.
```

```APIDOC
Response: Details on the expected response format for updating recurring payments.
```

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

### API Endpoints for Recurring Payments

Source: https://grow-il.readme.io/reference/introduction/reference/bit-redirect

Provides API endpoints for managing recurring payment processes, including initial setup and subsequent updates.

```APIDOC
POST /api/light-server/1.0/createpaymentprocess
  Description: Initiates a recurring payment process.
  Parameters: (Refer to specific API documentation)
  Response: (Refer to specific API documentation)
```

```APIDOC
POST /api/light-server/1.0/approvetransaction
  Description: Approves a pending recurring transaction.
  Parameters: (Refer to specific API documentation)
  Response: (Refer to specific API documentation)
```

```APIDOC
POST /api/light-server/1.0/updatedirectdebit
  Description: Updates an existing recurring payment (direct debit).
  Parameters: (Refer to specific API documentation)
  Response: (Refer to specific API documentation)
```

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

### Successful Payment API JSON Response

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy-copy

Example JSON structure for a successful API response, detailing the status, empty error, and data containing process identifiers and a redirect URL.

```JSON
{
  "status": 1,
  "err": "",
  "data": {
    "processId":"123456",
    "processToken":"2153287cd9af46457ae842337250b78d",
    "url":"https://sandbox.meshulam.co.il/far?l=89a71a421b8e0686024fbb762dab61e1"
  }
}
```

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

### Recurring Payments API Endpoints

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

API endpoints for managing recurring payment processes, including initial setup, approvals, and updates to direct debits.

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

```APIDOC
POST /reference/post_api-light-server-1-0-approvetransaction-2
Description: Approves a recurring payment transaction.
```

```APIDOC
POST /reference/post_api-light-server-1-0-updatedirectdebit
Description: Updates a recurring payment or direct debit.
```

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

### Recurring Payment API Endpoints

Source: https://grow-il.readme.io/reference/introduction/reference/server-response-copy-copy

This section covers API endpoints for managing recurring payments, including initial setup, subsequent approvals, and updates to recurring payment profiles.

```APIDOC
Recurring Payment API:
  Endpoints:
    - Recurring Payment: POST /api-light-server-1-0-createpaymentprocess-4
      Description: Initiates a recurring payment process.
    - Approve Transaction: POST /api-light-server-1-0-approvetransaction-2
      Description: Approves a recurring payment transaction.
    - Update Recurring Payment: POST /api-light-server-1-0-updatedirectdebit
      Description: Updates details for a recurring direct debit payment.
```

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

### Grow-il API Reference Documentation Structure

Source: https://grow-il.readme.io/reference/introduction/reference/post_api-light-server-1-0-createtransactionwithtoken-3

This snippet outlines the hierarchical structure and main topics covered within the Grow-il API documentation, providing a navigational map to various sections including general reference, environments, core resources, and SDK applications.

```APIDOC
Reference:
  - Introduction
  - Authentication
  - Supported Payment Method
  - Payments Type
    - Billing vs Token
  - Billing
    - Premium Recurring Payment
  - Token
  - Parameter Mapping
  - Errors
  - IP Addresses
  - Platforms & Multi-Merchant Systems
Environments:
  - Testing Environment
  - Production Environment
Core resources:
  - Payment Process
  - Payment Page
  - Iframe vs Redirect
  - Success URL
  - Bit Redirect
  - Post Massage
  - Server Response
  - Apple Domain Verification
  - SDK Growin
  - NFC
  - 3DS
Sdk App:
  - SDK bit IOS
  - SDK bit Android
```

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

### Update Recurring Payment API Endpoint

Source: https://grow-il.readme.io/reference/introduction/reference/post_api-light-server-1-0-updatedirectdebit

This method is for updating an existing direct debit payment. Each business has its own unique identifiers - the identifiers on this documentation are for example only. To develop the API you need to contact Grow's service to get permission and your own unique identifiers.

```APIDOC
Endpoint: post https://sandbox.meshulam.co.il/api/light/server/1.0/updateDirectDebit
Important Note: All requests must be sent exclusively from your server’s back end. Client-side (browser-based) requests are not supported and will be blocked.
```

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

### Testing Environment Guidelines and Credentials

Source: https://grow-il.readme.io/reference/introduction/reference/testing-environment

Provides essential guidelines for integrating and testing payment functionalities, including mock credit card numbers for development environment transactions and details on different environments (Sandbox, Live) with their respective URLs. Important note regarding real transactions for Bit, GooglePay, and ApplePay is also included.

```APIDOC
Testing Environment Guidelines for Seamless Integration:
  Credit Card Numbers for Mock Transactions (Development Environment Only):
    - 4580458045804580 (Valid for regular single payment transactions, suitable for testing failed transactions in multiple payments)
    - 4580000000000000
    - 4580111111111121
  Important Note:
    - The Bit application, GooglePay, and ApplePay do not have a dedicated testing environment. All transactions made with these methods will be real transactions.
  Environments:
    1. Sandbox: The test environment.
    2. Live: The production environment.
  URLs:
    - Sandbox URL: https://sandbox.meshulam.co.il/api/light/server/1.0/
    - Live URL: (You will receive the live URL after completing your development and passing our testing)
```

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

### Payment API Success Response Example

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy-1

Illustrates a successful JSON response structure for a payment transaction, including details like transaction ID, card information, payment status, and payer details.

```JSON
{
    "status": 1,
    "err": "",
    "data": {
        "asmachta": "111111111",
        "cardSuffix": "1234",
        "cardType": "Local",
        "cardTypeCode": "1",
        "cardBrand": "Visa",
        "cardBrandCode": "3",
        "cardExp": "1123",
        "firstPaymentSum": "0",
        "periodicalPaymentSum": "0",
        "status": "שולם",
        "statusCode": "2",
        "transactionTypeId": "1",
        "paymentType": "2",
        "sum": "3",
        "paymentsNum": "0",
        "allPaymentsNum": "1",
        "paymentDate": "22/8/23",
        "description": "תיאור",
        "fullName": "לקוח לקוח",
        "payerPhone": "0500000000",
        "payerEmail": "[email\u00a0protected]",
        "transactionId": "12345678",
        "transactionToken": "e500ce83e0000e82f72fded24efc000"
    }
}
```

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

### Error API Response JSON Example

Source: https://grow-il.readme.io/reference/introduction/reference/response-get-transaction-info-copy

Example of an API error response, indicating a failure with an error code and a localized error message.

```JSON
{
    "status": 0,
    "err": {
        "id": 716,
        "message": "פרמטר קוד עסקה או תוקן אינו תקין"
    },
    "data": ""
}
```

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

### Grow-il API Reference Structure

Source: https://grow-il.readme.io/reference/introduction/reference/post_api-light-server-1-0-approvetransaction

This section details the hierarchical structure of the Grow-il API documentation, listing all major categories and their sub-sections. It provides a roadmap for navigating the API reference, covering topics from general introduction to specific SDKs.

```APIDOC
Reference:
  - Introduction
  - Authentication
  - Supported Payment Method
  - Payments Type
    - Billing vs Token
  - Billing
    - Premium Recurring Payment
  - Token
  - Parameter Mapping
  - Errors
  - IP Addresses
  - Platforms & Multi-Merchant Systems
Environments:
  - Testing Environment
  - Production Environment
Core resources:
  - Payment Process
  - Payment Page
  - Iframe vs Redirect
  - Success URL
  - Bit Redirect
  - Post Massage
  - Server Response
  - Apple Domain Verification
  - SDK Growin
  - NFC
  - 3DS
Sdk App:
  - SDK bit IOS
  - SDK bit Android
```

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

### Grow-il API Reference Table of Contents

Source: https://grow-il.readme.io/reference/introduction/reference/token

This snippet outlines the hierarchical structure of the Grow-il API documentation, detailing the main sections and their sub-topics. It covers core API references, environment details, payment processes, and SDK integrations, providing a clear map of the available documentation.

```APIDOC
API Reference:
  - Introduction
  - Authentication
  - Supported Payment Method
  - Payments Type:
    - Billing vs Token
  - Billing:
    - Premium Recurring Payment
  - Token
  - Parameter Mapping
  - Errors
  - IP Addresses
  - Platforms & Multi-Merchant Systems

Environments:
  - Testing Environment
  - Production Environment

Core resources:
  - Payment Process
  - Payment Page
  - Iframe vs Redirect
  - Success URL
  - Bit Redirect
  - Post Massage
  - Server Response
  - Apple Domain Verification
  - SDK Growin
  - NFC
  - 3DS

Sdk App:
  - SDK bit IOS
  - SDK bit Android
```

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

### Grow-il API Reference Sections Overview

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

This section outlines the main categories and sub-sections of the Grow-il API documentation, providing a structured view of the available API reference topics.

```APIDOC
API Reference Sections:
  Reference:
    - Introduction
    - Authentication
    - Supported Payment Method
    - Payments Type:
      - Billing vs Token
    - Billing:
      - Premium Recurring Payment
    - Token
    - Parameter Mapping
    - Errors
    - IP Addresses
    - Platforms & Multi-Merchant Systems
  Environments:
    - Testing Environment
    - Production Environment
  Core resources:
    - Payment Process
    - Payment Page
    - Iframe vs Redirect
    - Success URL
    - Bit Redirect
    - Post Massage
    - Server Response
    - Apple Domain Verification
    - SDK Growin
    - NFC
    - 3DS
  Sdk App:
    - SDK bit IOS
    - SDK bit Android
```

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

### Get Payment Link Info API Endpoint

Source: https://grow-il.readme.io/reference/introduction/reference/post_api-light-server-1-0-getpaymentlinkinfo

Details the HTTP POST endpoint for retrieving information about a payment link. This API requires unique identifiers obtained from Grow's service for development and integration.

```APIDOC
API Endpoint:
  Method: POST
  URL: https://sandbox.meshulam.co.il/api/light/server/1.0/getPaymentLinkInfo

Authentication:
  Type: http

Notes:
  - Each business has its own unique identifiers. The identifiers on this documentation are for example only.
  - To develop the API, you need to contact Grow's service to get permission and your own unique identifiers.

Response:
  Click `Try It!` to start a request and see the response here!
```

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

### Grow-il API Reference Structure

Source: https://grow-il.readme.io/reference/introduction/reference/response

A hierarchical overview of the sections available within the Grow-il API documentation, including core API topics, environment details, and SDK information.

```APIDOC
Reference:
  - Introduction
  - Authentication
  - Supported Payment Method
  - Payments Type
    - Billing vs Token
  - Billing
    - Premium Recurring Payment
  - Token
  - Parameter Mapping
  - Errors
  - IP Addresses
  - Platforms & Multi-Merchant Systems
Environments:
  - Testing Environment
  - Production Environment
Core resources:
  - Payment Process
  - Payment Page
  - Iframe vs Redirect
  - Success URL
  - Bit Redirect
  - Post Massage
  - Server Response
  - Apple Domain Verification
  - SDK Growin
  - NFC
  - 3DS
Sdk App:
  - SDK bit IOS
  - SDK bit Android
```

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

### Configure Maven Repository for Meshulam SDK

Source: https://grow-il.readme.io/reference/introduction/reference/sdk-bit-android-copy

Configures the Maven repository in the project's `build.gradle` file, allowing Gradle to fetch the Meshulam SDK. It uses the previously defined authentication token for access.

```Groovy
maven {
url "https://jitpack.io"
credentials { username authToken}
}
```

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

### API Endpoint: Get Token Only

Source: https://grow-il.readme.io/reference/introduction/reference/post_api-light-server-1-0-createpaymentprocess-6

This API endpoint allows businesses to initiate a payment process specifically to obtain a token without completing a full transaction. All requests must be sent exclusively from your server’s back end; client-side (browser-based) requests are not supported and will be blocked. To develop the API, you need to contact Grow's service to get permission and your own unique identifiers.

```APIDOC
POST https://sandbox.meshulam.co.il/api/light/server/1.0/createPaymentProcess
```

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

### API Endpoints Overview for Payment Methods

Source: https://grow-il.readme.io/reference/introduction/reference/response

This structured overview outlines the various API endpoints available for managing different payment methods and related operations, categorized by functionality.

```APIDOC
Payment Methods:
  - Postman Collection
  - Regular Payments:
    - Overview
    - POST /api-light-server-1-0/createpaymentprocess (Regular Payment)
    - Response
    - Server-to-Server Callback
    - POST /api-light-server-1-0/approvetransaction (Regular Payment)
  - Payment Request:
    - Overview
    - POST /api-light-server-1-0/createpaymentlink
    - Response
    - Server-to-Server Callback
    - POST /api-light-server-1-0/updatepaymentlink
    - POST /api-light-server-1-0/getpaymentlinkinfo
    - POST /api-light-server-1-0/approvetransaction (Payment Request)
  - Recurring payment:
    - Overview
    - POST /api-light-server-1-0/createpaymentprocess (Recurring Payment)
    - Response
    - Server-to-Server Callback
    - POST /api-light-server-1-0/approvetransaction (Recurring Payment)
    - POST /api-light-server-1-0/updatedirectdebit
    - Response
  - Delayed Payment J4J5:
    - Overview
    - POST /api-light-server-1-0/createpaymentprocess (Delayed Payment J4J5)
    - Response
    - Server-to-Server Callback
    - POST /api-light-server-1-0/settlesuspendedtransaction
    - Response
  - Work with Token:
    - Overview
    - POST /api-light-server-1-0/createpaymentprocess (Get Token Only)
    - Server response
    - POST /api-light-server-1-0/createpaymentprocess (Create Payment & Save Token)
    - POST /api-light-server-1-0/createtransactionwithtoken (Create Transaction With Token)
    - Response
    - POST /api-light-server-1-0/gettokentransactionsbyexternalidentifiers
  - Premium recurring payment via token:
    - Manage by you:
      - Overview
      - POST /api-light-server-1-0/createtransactionwithtoken (First Payment - Premium Recurring By Token)
      - POST /api-light-server-1-0/createtransactionwithtoken (Further Payment - Premium Recurring By Token)
    - Manage by Grow:
      - Overview
      - POST /api-light-server-1-0/createtransactionwithtoken (Manages Premium Recurring Payment Via Token)
  - Refund:
    - Overview
    - POST /api-light-server-1-0/refundtransaction
    - POST /api-light-andriod-1-0/cancelbittransaction
    - Response
  - Payment & Transaction Info:
    - Overview
    - POST /api-light-server-1-0/gettransactioninfo
    - POST /api-light-server-1-0/getpaymentprocessinfo
    - Response get transaction info
    - Response get payment process info
```

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

### Get Transaction Information API

Source: https://grow-il.readme.io/reference/introduction/reference/payments

API endpoint to retrieve detailed information about a specific transaction.

```APIDOC
Method: POST
Path: /api-light-server-1-0/gettransactioninfo
```

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

### Get Payment Link Information API

Source: https://grow-il.readme.io/reference/introduction/reference/payments

API endpoint to retrieve details about a specific payment link.

```APIDOC
Method: POST
Path: /api-light-server-1-0/getpaymentlinkinfo
```

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

### API Guidelines for Platforms (System Integrators)

Source: https://grow-il.readme.io/reference/introduction/reference/api-guidelines-for-platforms-system-integrators

This section provides essential API guidelines for platforms enabling multiple businesses to process payments. It covers mandatory API key requirements for authentication and the ability to define company commission per transaction, detailing how these parameters impact platform operations.

```APIDOC
API Guidelines for Platforms (System Integrators):
  - Description: 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:
    - Description: 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.
    - Details: You will receive your apiKey along with all other integration-specific identifiers required for your development.
  - Company Commission:
    - Description: 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.
```

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

### Get Payment Process Information API

Source: https://grow-il.readme.io/reference/introduction/reference/payments

API endpoint to retrieve detailed information about a specific payment process.

```APIDOC
Method: POST
Path: /api-light-server-1-0/getpaymentprocessinfo
```

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

### Configure Gradle 7.0+ for Meshulam SDK

Source: https://grow-il.readme.io/reference/introduction/reference/sdk-bit-android-copy

Inserts necessary configuration into `settings.gradle` for projects using Gradle version 7.0 or above to ensure proper resolution of the Meshulam SDK, including the Jitpack repository.

```Groovy
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io' credentials { username authToken } }
}
}
```

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

### Payment Methods API Overview

Source: https://grow-il.readme.io/reference/introduction/reference/server-response-copy

This section provides an overview of the various payment methods supported by the API, including links to detailed documentation for each category.

```APIDOC
Payment Methods:
  Postman Collection: /reference/postman-collection
  Regular Payments: /reference/overview-6
  Payment Request: /reference/payment-link
  Recurring payment: /reference/overview-1
  Delayed Payment J4J5: /reference/overview-2
  Work with Token: /reference/overview-4
  Premium recurring payment via token: /reference/manage-by-you
  Refund: /reference/overview-3
  Payment & Transaction Info: /reference/overview-5
```

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

### Get Token Only Payment Process API

Source: https://grow-il.readme.io/reference/introduction/reference/payments

API endpoint to initiate a payment process solely for token retrieval.

```APIDOC
Method: POST
Path: /api-light-server-1-0/createpaymentprocess
```

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

### Get Token Transactions by External Identifiers API

Source: https://grow-il.readme.io/reference/introduction/reference/payments

API endpoint to retrieve token-based transactions using external identifiers.

```APIDOC
Method: POST
Path: /api-light-server-1-0/gettokentransactionsbyexternalidentifiers
```

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

### API Endpoints for Payment Methods Overview

Source: https://grow-il.readme.io/reference/introduction/reference/the-process

This section lists general resources related to payment methods, including a Postman Collection for API testing.

```APIDOC
Payment Methods:
  - Postman Collection: /reference/postman-collection
```

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

### Payment Request API Endpoints

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

API endpoints for creating, updating, getting information about, and approving payment links.

```APIDOC
Payment Request:
  Overview
  CreatePaymentLink: POST /api-light-server-1-0-createpaymentlink-1
  Response
  Server-to-Server Callback
  Update Payment Link: POST /api-light-server-1-0-updatepaymentlink
  Get Payment Link Info: POST /api-light-server-1-0-getpaymentlinkinfo
  Approve Transaction: POST /api-light-server-1-0-approvetransaction-1
```

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

### API Response Example: Failed Payment Process

Source: https://grow-il.readme.io/reference/introduction/reference/response-copy

Illustrates an API response indicating a failure, providing an error ID and a descriptive error message.

```JSON
  {
    "err": {
        "id": 54,
        "message": "חסרים שדות חובה: pageCode"
    },
    "status": 0,
    "data":""
    }
```

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

### Recurring Payment API Endpoints

Source: https://grow-il.readme.io/reference/introduction/reference/server-response-copy

API endpoints for handling recurring payments, including initial setup, updates, and transaction approval.

```APIDOC
Recurring payment:
  Overview: /reference/overview-1
  Create Recurring Payment Process: POST /api-light-server-1-0-createpaymentprocess-4
  Response: /reference/response-copy-copy
  Server-to-Server Callback: /reference/server-response-copy-copy
  Approve Transaction: POST /api-light-server-1-0-approvetransaction-2
  Update Direct Debit: POST /api-light-server-1-0-updatedirectdebit
  Response: /reference/responae
```

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

### Payment Methods API Endpoints Overview

Source: https://grow-il.readme.io/reference/introduction/reference/api-guidelines-for-platforms-system-integrators

This section outlines the various API endpoints available for different payment methods, including regular payments, payment requests, recurring payments, delayed payments, token management, premium recurring payments via token, refunds, and transaction information retrieval. Each entry specifies the API call and its purpose.

```APIDOC
Payment Methods:
  - Postman Collection
  - Regular Payments:
    - Overview
    - Regular Payment: POST /api-light-server/1.0/createpaymentprocess
    - Response
    - Server-to-Server Callback
    - Approve Transaction: POST /api-light-server/1.0/approvetransaction
  - Payment Request:
    - Overview
    - CreatePaymentLink: POST /api-light-server/1.0/createpaymentlink
    - Response
    - Server-to-Server Callback
    - Update Payment Link: POST /api-light-server/1.0/updatepaymentlink
    - Get Payment Link Info: POST /api-light-server/1.0/getpaymentlinkinfo
    - Approve Transaction: POST /api-light-server/1.0/approvetransaction
  - Recurring payment:
    - Overview
    - Recurring Payment: POST /api-light-server/1.0/createpaymentprocess
    - Response
    - Server-to-Server Callback
    - Approve Transaction: POST /api-light-server/1.0/approvetransaction
    - Update Recurring Payment: POST /api-light-server/1.0/updatedirectdebit
    - Response
  - Delayed Payment J4J5:
    - Overview
    - Delayed Payment J4J5: POST /api-light-server/1.0/createpaymentprocess
    - Response
    - Server-to-Server Callback
    - Settle Suspended Transaction: POST /api-light-server/1.0/settlesuspendedtransaction
    - Response
  - Work with Token:
    - Overview
    - Get Token Only: POST /api-light-server/1.0/createpaymentprocess
    - Server response
    - Create payment &save token: POST /api-light-server/1.0/createpaymentprocess
    - Create Transaction With Token: POST /api-light-server/1.0/createtransactionwithtoken
    - Response
    - getTokenTransactionsByExternalIdentifiers: POST /api-light-server/1.0/gettokentransactionsbyexternalidentifiers
  - Premium recurring payment via token:
    - Manage by you:
      - Overview
      - First Payment -Premium Recurring By Token: POST /api-light-server/1.0/createtransactionwithtoken
      - Further Payment -Premium Recurring By Token: POST /api-light-server/1.0/createtransactionwithtoken
    - Manage by Grow:
      - Overview
      - Manages Premium Recurring Payment Via Token: POST /api-light-server/1.0/createtransactionwithtoken
  - Refund:
    - Overview
    - Refund Transaction: POST /api-light-server/1.0/refundtransaction
    - Cancel Bit Transaction: POST /api-light-andriod/1.0/cancelbittransaction
    - Response
  - Payment & Transaction Info:
    - Overview
    - Get Transaction Info: POST /api-light-server/1.0/gettransactioninfo
    - Get Payment Process Info: POST /api-light-server/1.0/getpaymentprocessinfo
    - Response get transaction info
    - Response get payment process info
```

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

### Import Meshulam SDK Class

Source: https://grow-il.readme.io/reference/introduction/reference/sdk-bit-android-copy

Imports the main `MeshulamSdk` class into your Java/Kotlin file, making it accessible for initialization and method calls.

```Java
import il.co.inmanage.meshulam_sdk.sdk.MeshulamSdk;
```

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

### Regular Payments API Endpoints

Source: https://grow-il.readme.io/reference/introduction/reference/sdk-apple

API endpoints for initiating and managing standard, one-time payment processes.

```APIDOC
Regular Payment: POST /api-light-server-1-0-createpaymentprocess-2
```

```APIDOC
Approve Transaction: POST /api-light-server-1-0-approvetransaction
```

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

### Initiate First Recurring Payment with createTransactionWithToken

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

Details how to make the first recurring payment by calling `createTransactionWithToken` with `isRecurringDebitPayment=1` and saving the `recurringDebitId`.

```APIDOC
API Call: createTransactionWithToken
Parameters:
  isRecurringDebitPayment: 1 (required, indicates first recurring debit)
Returns:
  recurringDebitId: string (unique identifier for the recurring debit, must be saved)
```

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

### Recurring Payments API Endpoints

Source: https://grow-il.readme.io/reference/introduction/reference/server-response

API endpoints for managing recurring payment processes, including initial setup, subsequent approvals, and updates to direct debits.

```APIDOC
POST /api-light-server/1.0/createpaymentprocess
POST /api-light-server/1.0/approvetransaction
POST /api-light-server/1.0/updatedirectdebit
```