Payments Guide

Quick Summary

When generating a receipt or Document Type 2 (חשבונית מס קבלה), a payment object is required. Each payment method has specific mandatory fields in addition to the standard requirements for Receipt.New and Document.New .

Payment Method Schemas

Expand the sections below to see the specific fields required for each payment type.

the payment type can be pulled from the Rivhit payment settings .

✍️ Check (צ'ק)

Required Fields

Field	Type	Description	Example
`payment_type`	`int`	`1` - check payment type.	`1`
`bank_code`	`int`	The check bank code.	`4`
`branch_number`	`int`	The check bank branch number.	`881`
`bank_account_number`	`string`	The check bank account number.	`"12345"`
`check_number`	`int`	The check number.	`111111`

JSON Example:

"payments": [
        {
            "payment_type": 1,
            "amount_nis": 10,
            "bank_code": 4,
            "branch_number": 881,
            "bank_account_number": 12345,
            "check_number": "111111",
            "due_date": "02-04-2021",
            "description": "צק1"
        }
    ]

💵 Cash (מזומן)

Required Fields

Field	Type	Description	Example
`payment_type`	`int`	`2` - cash payment type.	`2`

JSON Example:

"payments": [
        {
            "payment_type": 2,
            "amount_nis": 10,
            "description": "תשלום במזומן"
        }
    ]

💳 Credit Cards (אשראי)

Required Fields

Field	Type	Description	Example
`payment_type`	`int`	4 through 8 (rivhit payment settings).	`4`
`bank_account_number`	`int`	Last 4 digits of the card.	`3348`
`check_number`	`int`	Voucher number.	`123456`

JSON Example:

"payments": [
      {
         "payment_type": 4,
         "bank_account_number":3348,
         "check_number":123456,
         "amount_nis": 10,
         "description": "תשלום באשראי",
         "number_of_payments":1  
      }
  ]

🏦 Bank Transfer (העברה בנקאית)

Required Fields

Field	Type	Description	Example
`payment_type`	`int`	`9` - bank transfer payment type.	`9`
`bank_account_number`	`int`	The bank account number.	`12345`
`branch_number`	`int`	The branch number.	`881`
`bank_code`	`int`	The bank code.	`4`
`check_number`	`int`	The bank transfer reference.	`1111`

JSON Example:

"payments": [
      {
         "payment_type": 9,
         "bank_account_number":12345,
         "branch_number": 881,
         "check_number":1111,
         "amount_nis": 10,
         "description": "העברה בנקאית",
         "bank_code": 4
      }
  ]

Custom Payment Types

For custom payment types defined in Rivhit Online, the implementation follows the same logic as Type 2 (Cash). Only the payment_type, amount_nis, and description fields are required.

Multiple Payments Settings

When all payments are for the same amount, you only need to define the payment once. By setting the 'number_of_payments' parameter, the system handles the replication for you—including the generation of consecutive check numbers.

 {
    "api_token": "0279BF82-CD57-49BA-837C-930F0E2EB805",
    "receipt_type": 1,
    "customer_id": 0,
    "last_name": "בדיקה",
    "first_name": "בדיקה",
    "price_include_vat": true,
    "currency_id": 1,
    "digital_signature": true,
    "payments": [
        {
            "payment_type": 1,
            "amount_nis": 30,
            "bank_code": 4,
            "branch_number": 881,
            "bank_account_number": 12345,
            "check_number": 20000030,
            "description": "תשלום צ'ק",
            "number_of_payments": 5
        }
    ]
}

Quick Summary

Payment Method Schemas

Required Fields

JSON Example:

Required Fields

JSON Example:

Required Fields

JSON Example:

Required Fields

JSON Example:

Custom Payment Types

Multiple Payments Settings

The response will look like this: