Tranzila

https://docs.tranzila.com
Admin
Tranzila is a comprehensive payment processing and billing platform offering payment integration,...
Tokens:188,542
Snippets:841
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Create Payment Request JSON Example

Source: https://docs.tranzila.com/docs/payments-and-billing/payment-request/get-v1-pr-create

Example request body for creating a payment request. Includes terminal_name, action_type, response_language, request_currency, request_vat, payments_number, created_by_user, created_via, payment_plans, payment_methods, client details, items, and send_email. Note: payment_plans options are 1 for regular and 8 for installments; payment_methods options include 1 (Credit Card), 2 (Bank Masav), 14 (Bit), 15 (Apple Pay). Each payment method is a paid module and only enabled methods should be used.

```JSON
{
  "terminal_name": "ternimalname",
  "action_type": 1,
  "response_language": "hebrew",
  "request_currency": "ILS",
  "request_vat": 17,
  "payments_number": 1,
  "created_by_user": "tester",
  "created_via": "TRAPI",
  "payment_plans": [1],
  "payment_methods": [1],
  "client": {
    "name": "cats ltm",
    "id": "123123123",
    "contact_person": "test contact",
    "email": "test@interspace.net",
    "phone_country_code": "972",
    "phone_area_code": "054",
    "phone_number": "444444"
  },
  "items": [
    {
      "id": 22,
      "code": "5555",
      "name": "חולצה",
      "unit_price": 10,
      "type": "I",
      "units_number": 1,
      "unit_type": 1,
      "price_type": "G",
      "currency_code": "ILS"
    }
  ],
  "send_email": {
    "sender_name": "טסט טסט 123 בע''מ",
    "sender_email": "donotreply@tranzila.com"
  }
}
```

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

### Create Document JSON Example

Source: https://docs.tranzila.com/docs/invoices/invoices-api/create-document

Example JSON payload for creating a document with terminal_name, client details, items, and payments. The example includes two items and one payment with a credit card.

```json
{
  "terminal_name": "terminalname",
  "document_date": "2021-01-01",
  "document_type": "IR",
  "action": 1,
  "document_language": "heb",
  "document_currency_code": "ILS",
  "vat_percent": 17,
  "client_company": "Test Ltd",
  "client_id":"123456789",
  "client_name": "Test",
  "client_email": "test@test.com",
  "client_address_line_1": "test line 1",
  "client_address_line_2": "test line 2",
  "client_zip": "4545451",
  "client_city":"City",
  "client_country_code": "IL",
  "items": [
    {
      "type": "I",
      "code": "321",
      "name": "A",
      "price_type": "G",
      "unit_price": 70.25,
      "units_number": 1,
      "unit_type": 1,
      "currency_code": "ILS",
      "to_doc_currency_exchange_rate": 1
    },
    {
      "type": "I",
      "code": "111",
      "name": "B",
      "price_type": "G",
      "unit_price": 30,
      "units_number": 1,
      "unit_type": 2,
      "currency_code": "ILS",
      "to_doc_currency_exchange_rate": 1
    }
  ],
  "payments": [
    {
      "payment_method": 1,
      "payment_date": "2024-07-06",
      "cc_last_4_digits": 1533,
      "cc_credit_term": 1,
      "cc_brand": 1,
      "amount": 100.25,
      "currency_code": "ILS"
    }
  ]
}
```

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

### Installments Payment Example (HTML form with npay, fpay, spay parameters)

Source: https://docs.tranzila.com/docs/payments-and-billing/iframe-integration-directng

Use this HTML form to enable installment payments in the Tranzila DirectNG iframe. It posts to https://directng.tranzila.com/terminal_name/iframenew.php and includes hidden fields 'npay', 'fpay', 'spay', and 'cred_type' (value 8). The example uses npay=4, fpay=20, spay=10. Note: do not pass 'maxpay' together with 'npay', 'fpay', and 'spay'.

```HTML
<main class="min-h750">
    <div class="container">
        <section id="main-content">
            <div class="row text-center mt-5">
                <div class="col">
                    <h1 class="display-3 text-primary">Pay Amount</h1>
                </div>
            </div>
            <div class="row mt-5">
                <div class="col-md-6">
                    <p class="text-center">Installments Example:</p>
                    <form action="https://directng.tranzila.com/terminal_name/iframenew.php" target="tranzila" method="POST" novalidate="novalidate" autocomplete="off">
                        <input type="hidden" name="sum" value="60" />
                        <input type="hidden" name="cred_type" value="8" />
                        <input type="hidden" name="spay" value="10" />
                        <input type="hidden" name="fpay" value="20" />
                        <input type="hidden" name="npay" value="4" />
                        <input type="hidden" name="currency" value="1" />
                        <button type="submit" name="submit" class="btn btn-primary mt-3" value="pay">Pay Now</button>
                    </form>
                </div>
            </div>
            <div class="row mt-5">
                <div class="col-md-6">
                    <div class="" style="width: 800px; height: 800px;">
                        <iframe id="tranzila-frame" name="tranzila" src="" style="width: 100%; height: 100%;"></iframe>
                    </div>
                </div>
            </div>
        </section>
    </div>
</main>
```

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

### Response Body Example (response.json)

Source: https://docs.tranzila.com/docs/payments-and-billing/payment-request/get-v1-pr-create

Example response body for a successful payment request creation. Contains error_code, message, and pr_id fields.

```json
{
  "error_code": 0,
  "message": "The payment request created successfully.",
  "pr_id": "102446"
}
```

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

### Request body example

Source: https://docs.tranzila.com/docs/payments-and-billing/tranzila-api/updatesto

Example request body for updating a standing order. Includes terminal_name, sto_id, sto_status, response_language, and updated_by_user fields.

```json
{
  "terminal_name": "myterminal",
  "sto_id": 4192,
  "sto_status": "inactive",
  "response_language": "english",
  "updated_by_user": "שון כבשון"
}
```

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

### Complete Example Request Body (JSON)

Source: https://docs.tranzila.com/docs/payments-and-billing/bit-api/bit-init

A complete example of the request body for the Bit init API, including client, items, and user-defined fields.

```json
{
  "terminal_name": "elenatest96",
  "txn_currency_code": "ILS",
  "txn_type": "debit",
  "success_url": "https://pay.tranzila.com/process/success",
  "failure_url": "https://pay.tranzila.com/process/fail",
  "client": {
    "company": "Naor consulting",
    "name": "Naor",
    "id": "0732224444",
    "email": "info@interspace.net",
    "address_line_1": "Yad Harutsim 19",
    "address_line_2": "pob 1234",
    "city": "Netanya",
    "zip": "1234567"
  },
  "items": [
    {
      "code": "",
      "name": "Product",
      "type": "I",
      "units_number": 1,
      "unit_type": 1,
      "unit_price": 570,
      "price_type": "G",
      "currency_code": "ILS",
      "to_txn_currency_exchange_rate": 1,
      "discount_type": "fixed",
      "discount": 20,
      "vat_percent": 0,
      "attributes": [
        {
          "languge": "hebrew",
          "name": "color",
          "value": "blue"
        },
        {
          "languge": "english",
          "name": "size",
          "value": "S"
        }
      ]
    }
  ],
  "response_language": "english",
  "created_by_user": "naor",
  "created_by_system": "pay.tranzila.com",
  "user_defined_fields": [
    {
      "name": "value 1",
      "value": "value 2"
    },
    {
      "name": "value 2",
      "value": "value 3"
    }
  ]
}
```

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

### Installments Example (HTML)

Source: https://docs.tranzila.com/docs/vibe-coding/working-with-tranzila-integration-for-base44-regular-payments

HTML form for installment payments. Sets cred_type=8 and maxpay=3 to allow up to 3 installments. Includes required fields and a submit button.

```html
<form action="https://direct.tranzila.com/[terminalname]/iframenew.php"
      target="tranzila"
      method="POST">

    <input name="sum" type="number" value="300" readonly />
    <input type="hidden" name="cred_type" value="8" />
    <input type="hidden" name="maxpay" value="3" />
    <input type="hidden" name="currency" value="1" />
    <input type="hidden" name="new_process" value="1" />
    <input type="hidden" name="thtk" value="[from_handshake]" />

    <button type="submit">Pay in Installments</button>
</form>
```

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

### Get Transactions Response

Source: https://docs.tranzila.com/docs/reports/tranzila-transaction-reports-api/gettransactions

Example of a successful response from the Get Transactions API, showing a transaction with a product line item.

```APIDOC
## GET /gettransactions

### Description
Retrieves a list of transactions with detailed information including product line items.

### Method
GET

### Endpoint
/gettransactions

### Response
#### Success Response (200)
- **transactions** (array) - List of transaction objects.
- **total** (string) - Total number of transactions.
- **rows** (number) - Number of rows returned.

#### Response Example
```json
{
  "transactions": [
    {
      "index": 41711,
      "transaction_date": "2025-10-29",
      "transaction_time": "12:02:24",
      "amount": 500,
      "credit_card_token": "ab7969f6582d29a5409",
      "expiration_month": "06",
      "expiration_year": "29",
      "credit_card_owner_id": "",
      "card_issuer": 2,
      "card_description": "ויזה רגיל",
      "card_brand": 2,
      "clearing_processor": 2,
      "is_foreign": 0,
      "authorization_number": 147934,
      "bank": null,
      "bank_branch": null,
      "bank_account": null,
      "payment_plan": 1,
      "currency": "1",
      "number_of_payments": 0,
      "first_payment_amount": 0,
      "other_payment_amount": 0,
      "host_ip": "80.244.170.32",
      "processor_response_code": "000",
      "tranmode": "F",
      "refnr": "56510713",
      "tempref": "46001008",
      "xid": "",
      "cavv": "",
      "eci": "",
      "child_terminal": "yourTerminalName",
      "uid": "25102911404490383603746",
      "transtatus": 1,
      "telauthability": 1,
      "txnfdid": 6486,
      "cancelfdid": null,
      "txnfdnumber": 1000093,
      "cancelfdnumber": null,
      "txn_payment_method": "CC",
      "txn_type": "FORCE",
      "pan_entry_mode": "50",
      "processor": "SHVA",
      "broker": "",
      "broker_product": "",
      "user_defined_1": "",
      "user_defined_2": "",
      "user_defined_3": "",
      "user_defined_4": "",
      "user_defined_5": "",
      "user_defined_6": "",
      "user_defined_7": "",
      "user_defined_8": "",
      "user_defined_9": "",
      "user_defined_10": "",
      "user_defined_11": "",
      "user_defined_12": "",
      "user_defined_13": "",
      "user_defined_14": "",
      "user_defined_15": "",
      "user_defined_16": "",
      "user_defined_17": "",
      "user_defined_18": "",
      "user_defined_19": "",
      "user_defined_20": "",
      "user_defined_21": "",
      "user_defined_22": "",
      "user_defined_23": "",
      "user_defined_24": "",
      "user_defined_25": "",
      "items": [
        {
          "item_id": 67099484,
          "item_name": "Capture",
          "quantity": "1.00",
          "price": 500,
          "item_type": "I"
        }
      ]
    }
  ],
  "total": "54",
  "rows": 1
}
```

```

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

### Basic Example With Card

Source: https://docs.tranzila.com/docs/payments-and-billing/sto-api-v2/createstov2

JSON request body for creating a standing order with a card. Includes terminal_name, sto_payments_number, charge_frequency, first_charge_date, charge_dom, vat_percent, created_by_user, response_language, items, client, and card details.

```JSON
{
  "terminal_name": "myterminal",
  "sto_payments_number": 12,
  "charge_frequency": "monthly",
  "first_charge_date": "2024-08-24",
  "charge_dom": 25,
  "vat_percent": 18,
  "created_by_user": "CRM A user",
  "response_language": "english",
  "items": [
    {
      "name": "HDMI Splitter",
      "unit_price": 10,
      "units_number": 2,
      "price_currency": "ILS",
      "price_type": "G"
    },
    {
      "name": "Desk Lamp",
      "unit_price": 30,
      "units_number": 1,
      "price_currency": "ILS",
      "price_type": "G"
    }
  ],
  "client": {
    "name": "John Smith",
    "id": "012345632",
    "email": "johnsmith@domain.com",
    "address": "15 Tamar Street, Apt. 4, Tel Aviv 678910, Israel",
    "phone_country_code": "972",
    "phone_area_code": "050",
    "phone_number": "5558965"
  },
  "card": {
    "token": "f12cF45cI7898t75548",
    "expire_month": 5,
    "expire_year": 2027,
    "card_holder_id": "012345632",
    "card_holder_name": "John Smith"
  }
}
```

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

### Include Hosted Fields JavaScript

Source: https://docs.tranzila.com/docs/payments-and-billing/hosted-fields

Adds the Tranzila hosted fields script to the merchant payment page. This is the only setup needed to start using the feature.

```html
<script src='https://hf.tranzila.com/assets/js/thostedf.js'></script>
```

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

### PHP Example: Generate Access Token and Send Request

Source: https://docs.tranzila.com/docs/reports/authentication

PHP script that generates a nonce, computes the access token, and sends a POST request with the required headers. Replace placeholders with actual keys and endpoint.

```php
<?php
$json   = trim(isset($_POST['jsontext']) ? $_POST['jsontext'] : '');
$time   = time();
$appKey = '<public app key>';
$secret = '<private app key>';
$nonce  = bin2hex(random_bytes(40)); // produces an 80-character hex string

$accessToken = hash_hmac('sha256', $appKey, $secret . $time . $nonce);

$ch = curl_init('<<service endpoint URL>>');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($json),
    'X-tranzila-api-app-key: '      . $appKey,
    'X-tranzila-api-request-time: ' . $time,
    'X-tranzila-api-nonce: '        . $nonce,
    'X-tranzila-api-access-token: ' . $accessToken,
));

$data = curl_exec($ch);
curl_close($ch);
```

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

### React Router setup for Apple Pay success and failure pages

Source: https://docs.tranzila.com/docs/payments-and-billing/apple-pay-iframe

Complete React application example using React Router to define routes for the checkout, success, and failure pages. Import the PaymentPage, SuccessPage, and FailurePage components.

```JSX
// App.jsx - Complete React Application Example
import React from 'react';
import { BrowserRouter as Router, Routes, Route } from 'react-router-dom';
import PaymentPage from './PaymentPage';
import SuccessPage from './SuccessPage';
import FailurePage from './FailurePage';

function App() {
    return (
        <Router>
            <Routes>
                <Route path="/checkout" element={<PaymentPage />} />
                <Route path="/success" element={<SuccessPage />} />
                <Route path="/failure" element={<FailurePage />} />
            </Routes>
        </Router>
    );
}

export default App;

```

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

### Static Hosting Directory Structure

Source: https://docs.tranzila.com/docs/payments-and-billing/apple-pay-iframe

Place the verification file in the public directory for static hosting.

```text
public/
└── .well-known/
    └── apple-developer-merchantid-domain-association

```

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

### Request body for transaction types (BodyCharge, RegularCharge, InstallmentsCharge, Credit installments, Refund)

Source: https://docs.tranzila.com/docs/emv-pinpad/emv-paybridge-api/paybridgetransaction

Common request body fields for various transaction types. The example shows a charge with pos_id, currency, cred_type, supplier, tranmode, sum, and uniqueid.

```json
{
  "pos_id": "014",
  "currency": "376",
  "cred_type": "1",
  "supplier": "terminal_name",
  "tranmode": "A",
  "sum": "2",
  "uniqueid": "567567567"
}
```

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

### Response Example

Source: https://docs.tranzila.com/docs/invoices/invoices-api/post-api-documents-db-get-documents

Example response body showing a successful response with status_code 0, status_msg 'Success', an enquiry_key, and a documents array containing document details.

```json
{
  "status_code": 0,
  "status_msg": "Success",
  "enquiry_key": "79b8ba07",
  "documents": [
    {
      "id": "6252",
      "number": "1001956",
      "assignment_number": null,
      "type": "IR",
      "action": "1",
      "total_charge_amount": 10,
      "currency": "ILS",
      "created_at": "2025-07-27 14:14:31",
      "retrieval_key": "ZDA2ODJkNDZjNjY0NDkwZTEyMTJmODA5NWRkMDkxODAxNDgwOWY2MTdlY2IxMTY5MzcxMmRiMjYzYWExOGRkZjQyY2I5ZWRlODMxNjljNDlkNzk5NjdkMzAzOTMwODdmOTA4NjBhMjk3OGQyYmFkOThmYWU1ODNlNGI1YzNkMjE1STZMLzZYZ1Bwd2VNRXEvY2pTVm95THpsU3pZQ3d0UUpWUUhuSWNjU3FWbUgyKzlPYTh3b0JFc283YVBxakFXN0w2eXBJT1ppYUYwZEtwMHZjV3Qrdz09"
    }
  ]
}
```

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

### Request Sample (Shell)

Source: https://docs.tranzila.com/docs/payments-and-billing/bit-api/bit-init

cURL command to call the Bit init API endpoint with required headers and a JSON body.

```shell
curl --request POST \
  --url https://api.tranzila.com/v1/transaction/bit/init \
  --header 'Content-Type: application/json' \
  --header 'X-tranzila-api-access-token: 775adb3ad32ef10bcb23b63427511463b0a784abf79287342142656f4e3c5de0' \
  --header 'X-tranzila-api-nonce: SuIu6YDtFZ4kZn7tKGy3HIDSPwuYkeWi2FTwkgKiVCm6KnoXxPEwxzlsUx6CTZwOE1ecKo0ARCUEz1y6' \
  --header 'X-tranzila-api-app-key: vnNtAoXX735jmQviLuMgXEk1fGNCasL92UKW4GLBh8Kk442gK7TqddLNuPnNReixTJI9z8b1g0A' \
  --header 'X-tranzila-api-request-time: 1682840810' \
  --data '{  "terminal_name": "elenatest96",  "txn_currency_code": "ILS",  "txn_type": "debit",  "success_url": "https://pay.tranzila.com/process/success",  "failure_url": "https://pay.tranzila.com/process/fail",  "client": {    "company": "Naor consulting",    "name": "Naor",    "id": "0732224444",    "email": "info@interspace.net",    "address_line_1": "Yad Harutsim 19",    "address_line_2": "pob 1234",    "city": "Netanya",    "zip": "1234567"  },  "items": [    {      "code": "",      "name": "Product",      "type": "I",      "units_number": 1,      "unit_type": 1,      "unit_price": 570,      "price_type": "G",      "currency_code": "ILS",      "to_txn_currency_exchange_rate": 1,      "discount_type": "fixed",      "discount": 20,      "vat_percent": 0,      "attributes": [        {          "languge": "hebrew",          "name": "color",          "value": "blue"        },        {          "languge": "english",          "name": "size",          "value": "S"        }      ]    }  ],  "response_language": "english",  "created_by_user": "naor",  "created_by_system": "pay.tranzila.com",  "user_defined_fields": [    {      "name": "value 1",      "value": "value 2"    },    {      "name": "value 2",      "value": "value 3"    }  ]}'
```

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

### Installments - Credit Installments (cred_type=6)

Source: https://docs.tranzila.com/docs/payments-and-billing/iframe-integration-directng

Parameters for credit installment payments. Requires customer authorization from their credit card company.

```APIDOC
## Credit Installments (cred_type=6)

### Description
Credit installments require the customer to have authorization from their credit card company to perform credit transactions. Must be used with cred_type=6.

### Parameters
- **npay** (Integer, minimum 3) - Required - Number of credit installments. Minimum is 3 installments.
```

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

### Installments - Regular Installments (cred_type=8)

Source: https://docs.tranzila.com/docs/payments-and-billing/iframe-integration-directng

Parameters for regular installment payments. The sum is calculated as sum = fpay + spay*npay.

```APIDOC
## Regular Installments (cred_type=8)

### Description
Regular installment payments require cred_type=8. The formula for calculating payments is: sum = fpay + spay*npay, where sum is the total, fpay is the first payment, spay is the second payment, and npay is the number of installments after the first.

### Parameters
- **npay** (Positive integer) - Required - Number of installments after the first installment. npay = number of total installments - 1
- **fpay** (Positive integer/decimal, max 2 decimal places) - Required - Amount to pay on the first transaction
- **spay** (Positive integer/decimal, max 2 decimal places) - Required - Amount to pay for every transaction after the first transaction
- **maxpay** (Positive integer) - Optional - Maximum number of installments. When using maxpay, Tranzila automatically calculates the division of payments without requiring fpay, npay, or spay parameters. This parameter replaces the need for manual calculation. **Do not send fpay, npay, or spay when using maxpay.**
```

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

### POST /init

Source: https://docs.tranzila.com/docs/payments-and-billing/bit-api/bit-init

Initiates a Bit payment transaction. Requires authentication headers and a JSON body with terminal name, success and failure URLs, and client and items details.

```APIDOC
## POST /init

### Description
Initiates a Bit payment transaction. Requires authentication headers and a JSON body with terminal name, success and failure URLs, and client and items details.

### Method
POST

### Endpoint
/init

### Headers
- **X-tranzila-api-access-token** (string) - Required - HMAC SHA256 hash of application key with secret + request-time + nonce. Example: `775adb3ad32ef10bcb23b63427511463b0a784abf79287342142656f4e3c5de0`
- **X-tranzila-api-nonce** (string) - Required - A 40-byte NONCE – unique random string. Example: `SuIu6YDtFZ4kZn7tKGy3HIDSPwuYkeWi2FTwkgKiVCm6KnoXxPEwxzlsUx6CTZwOE1ecKo0ARCUEz1y6`
- **X-tranzila-api-app-key** (string) - Required - Application public key supplied by Tranzila. Example: `vnNtAoXX735jmQviLuMgXEk1fGNCasL92UKW4GLBh8Kk442gK7TqddLNuPnNReixTJI9z8b1g0A`
- **X-tranzila-api-request-time** (string) - Required - Request time in Unix format (seconds since Jan 1, 1970). Example: `1682840810`

### Request Body
Content-Type: `application/json`

- **terminal_name** (string) - Required - Terminal name.
- **txn_currency_code** (string) - Optional - Transaction currency code.
- **txn_type** (string) - Optional - Transaction type.
- **success_url** (string) - Required - URL to redirect on success.
- **failure_url** (string) - Required - URL to redirect on failure.
- **notify_url** (string) - Optional - URL for notifications.
- **client** (object) - Required - Client details.
- **items** (array[object]) - Required - List of items.
- **response_language** (string) - Optional - Response language.
- **created_by_user** (string) - Optional - User who created the request.
- **created_by_system** (string) - Optional - System that created the request.
- **user_defined_fields** (array[object]) - Optional - User-defined fields.

### Request Example
```json
{
  "terminal_name": "string",
  "txn_currency_code": "string",
  "txn_type": "string",
  "success_url": "string",
  "failure_url": "string",
  "notify_url": "string",
  "client": {},
  "items": [{}],
  "response_language": "string",
  "created_by_user": "string",
  "created_by_system": "string",
  "user_defined_fields": [{}]
}
```

### Response
No response schema provided in the source.

```

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

### Request Sample (Shell)

Source: https://docs.tranzila.com/docs/payments-and-billing/sto-api-v2/createstov2

A curl command to create an STO. Requires headers X-tranzila-api-request-time, X-tranzila-api-app-key, X-tranzila-api-nonce, and X-tranzila-api-access-token.

```shell
curl --request POST \
  --url https://api.tranzila.com/v2/sto/create \
  --header 'Content-Type: application/json' \
  --header 'X-tranzila-api-request-time: <X-tranzila-api-request-time>' \
  --header 'X-tranzila-api-app-key: <X-tranzila-api-app-key>' \
  --header 'X-tranzila-api-nonce: <X-tranzila-api-nonce>' \
  --header 'X-tranzila-api-access-token: <X-tranzila-api-access-token>' \
  --data '{  "terminal_name": "myterminal",  "sto_payments_number": 12,  "charge_frequency": "monthly",  "first_charge_date": "2024-08-24",  "charge_dom": 25,  "currency_code": "ILS",  "vat_percent": 18,  "index_linked": "Y",  "index_type": 120010,  "base_month": "2021-12",  "min_price": "Y",  "client": {    "internal_id": 584567,    "name": "John Smith",    "id": "012345632",    "email": "johnsmith@domain.com",    "address": "15 Tamar Street, Apt. 4, Tel Aviv 678910, Israel",    "phone_country_code": "972",    "phone_area_code": "050",    "phone_number": "5558965"  },  "items": [    {      "code": "PROD001",      "name": "Premium Service",      "type": "I",      "unit_price": 50,      "units_number": 3,      "unit_type": 1,      "currency_code": "ILS",      "price_type": "G",      "index_link": "Y",      "base_price": 10    }  ],  "card": {    "token": "f12cF45cI7898t75548",    "expire_month": 5,    "expire_year": 2027,    "card_holder_id": "012345632",    "card_holder_name": "John Smith"  },  "msv": {    "bank_code": 12,    "branch_code": "659",    "account_number": "127963"  },  "response_language": "english",  "created_by_user": "CRM Admin"}'
```

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

### cURL Request Example

Source: https://docs.tranzila.com/docs/invoices/invoices-api/post-api-documents-db-get-documents

Example cURL command to call the endpoint. Uses the request body shown in the request body example.

```shell
curl --request POST \
  --url https://billing5.tranzila.com/api/documents_db/get_documents \
  --header 'Content-Type: application/json' \
  --data '{  "terminal_names": "\"terminalname1\",\"terminalname2\",\"terminalnamen\"",  "client_email": "mymail@mydomain.com",  "start_date": "2019-03-05",  "end_date": "2019-03-30",  "transaction_ids": "[132,567,8910]"}'
```

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

### Example With Price Index Linkage

Source: https://docs.tranzila.com/docs/payments-and-billing/sto-api-v2/createstov2

JSON request body for creating a standing order with price index linkage. Includes index_linked, index_type, base_month, min_price, and items with index_link and base_price fields.

```JSON
{
  "terminal_name": "myterminal",
  "sto_payments_number": 12,
  "charge_frequency": "monthly",
  "first_charge_date": "2025-12-30",
  "charge_dom": 1,
  "currency_code": "ILS",
  "vat_percent": 18,
  "index_linked": "Y",
  "index_type": 120010,
  "base_month": "2021-12",
  "min_price": "Y",
  "card": {
    "token": "Z76f667a58a48581984",
    "expire_month": 2,
    "expire_year": 2025
  },
  "client": {
    "name": "Customer Name",
    "phone_area_code": "050",
    "phone_number": "5551234",
    "email": "customer@example.com"
  },
  "items": [
    {
      "code": "PROD001",
      "name": "Premium Service",
      "type": "I",
      "units_number": 3,
      "unit_type": 1,
      "price_type": "G",
      "index_link": "Y",
      "base_price": 10
    },
    {
      "code": "PROD002",
      "name": "Basic Service",
      "unit_price": 2,
      "type": "I",
      "units_number": 2,
      "unit_type": 1,
      "price_type": "G"
    }
  ]
}
```
Tokens:
Raw