> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lancer-erp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Hyp

> Connect your Hyp account to take card and Bit payments through Hyp.

Connect your Hyp account to take card and Bit payments through Hyp. Lancer creates a hosted payment page for each payment request, with card and Bit, can save a card for retainers and recurring charges, and records refunds. Receipts still come from your documents provider, not from the processor.

> [!NOTE]
>
> **Category:** Payments ("סליקה ותשלומים")\
> **Connection:** one for the whole organization, admins only

## What it does in Lancer

* Hosted Hyp payment pages for payment requests, including Bit.
* Saved card (token) for retainers and recurring charges.
* Refunds from the payment's card in Lancer.

## Connect

**1. Open the integration**

Open Settings → **Integrations** ("הגדרות" → "אינטגרציות"), at [app.lancer-erp.com/app/settings/integrations](https://app.lancer-erp.com/app/settings/integrations). Under **Payments** ("סליקה ותשלומים"), find **Hyp** and click **Connect** ("חיבור").

**2. Get your credentials**

In Hyp: Settings → Payment page and API → Authentication ("הגדרות ← דף תשלום ו-API ← אימות"). Also turn on **signature verification on payment pages** ("אימות על ידי חתימה בעמודי התשלום"). Recurring charges need token permission on the terminal.

**3. Fill in the card and save**

Enter the details below and click **Save** ("שמירה"). Secrets are stored encrypted and never shown again; leave a secret field empty later to keep the stored value.

> [!NOTE]
>
> Only admins can view and change this connection.

## What you need

**Terminal number (Masof)** `string`

Your Hyp terminal. In the app: "מספר מסוף (Masof)".

**API key (KEY)** `string`

Required. Stored encrypted. In the app: "מפתח API (KEY)".

**API password (PassP)** `string`

Required. The terminal's API password, not your login password. In the app: "סיסמת API (PassP)".

## Webhook and notify URLs

### Success return URL

```text theme={null}
https://api.lancer-erp.com/pay/return/hyp
```

Hyp doesn't accept it per page, so set it once in Hyp: Settings → Payment page and API → Redirect after transaction → **Successful transaction** → custom link. For failed transactions keep "show the error on the payment page".

## Good to know

* With more than one processor connected, an admin picks the default under Payments ("הגדרה כברירת מחדל"). Each payment request can still pick another processor.

## Vendor documentation

> [card] [Hyp documentation](https://developers.hyp.co.il/)
>
> The official docs, at developers.hyp.co.il.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.