# Prerequisites & Initial Setup

To begin using the Hyp Pay API, you need to set up accounts with both Hyp and the credit card providers you plan to support in your payment solution.

## 1. Register

To get started, register [here](https://lp.hyp.co.il/api/). After registration, a Hyp sales representative will contact you to understand your requirements and assist you with signing acquiring agreements with the relevant credit card providers.

## 2. Sign a service agreement with Hyp

Once your requirements are defined, you will need to sign a **service agreement** with Hyp. This allows you to set up a payment terminal linked to your acquiring account.

## 3. Sign credit card acquiring agreements

Before you, as an Israeli merchant, can begin accepting online credit card payments using Hyp Pay, you must **sign an acquiring agreement** with one or more credit card companies. This agreement enables your business to process card payments and assigns you a **vendor number** (`מספר ספק אינטרנטי`).

This step is mandatory before Hyp can configure a terminal for you. If you sign agreements with more than one credit card company (for example, to optimize commissions or ensure redundancy), you will receive multiple vendor numbers. In this case, Hyp can either set up a separate terminal for each vendor number or a single terminal that covers all vendor numbers.

{% hint style="info" %}
Validate with your credit card provider that the assigned number is an "Internet" vendor number, not a standard vendor number.
{% endhint %}

## 4. Get terminal numbers and accounts from the Hyp team

Once you have your vendor number(s), contact the Hyp operations team at <ipos@hyp.co.il>. A Hyp representative will:

1. Register one or more terminal numbers for you.
2. Create one or more accounts for you on the [Hyp Portal](https://pay.hyp.co.il/).

By default, you receive one terminal and one Hyp Portal account per environment. For example, if you have both test and production environments, you will receive two terminals and two accounts.

You will receive an email containing your terminal numbers and Hyp Portal credentials.

## 5. Access your Hyp Portal account

[Log in to your Hyp Portal account](https://pay.hyp.co.il/p/?action=login) using the terminal number, username, and password provided by Hyp.

### Find your API key and password

To perform any [request](/pay/getting-started/creating-a-payment-page.md) to the Hyp Pay API, you need:

* a terminal number
* an API key
* an API password (also referred to as "PassP")

Your API password is different from the password you use to log in to the Hyp Portal.

To retrieve your API key and password from your Hyp Portal account, click **API-דף תשלום ו** (**Payment Page and API**) under **הגדרות** (**Settings**).

Copy your API key and password (PassP) from the **אימות** (**Verification**) section:

![Your API key and password](/files/LFOgcbV8kPbRk8Py8BJ2)

### Configure success and error pages

In the same view in your Hyp Pay account, specify the URL of the success page on your website that will be displayed to the user after a transaction completes. In addition to displaying a status message, this page is required to handle the parameters that Hyp Pay sends when redirecting the user back to your site.

In the **הפנייה לאחר עסקה** (**Post-transaction address**) section, select **לינק מותאם אישית** (**Custom link**) under **עסקה שהצליחה** (**Successful transaction**) and enter your success page URL:

![Configuring success and error pages](/files/eSc6rHCwjldG7AlqS0Mw)

There's also another field, **עסקה שנכשלה** (**Failed transaction**), where you can enter the URL of the error page to display if the transaction fails. However, we recommend **configuring only the success URL** and keeping the default option to display errors on the Hyp Pay payment page: **הצגת השגיאה בדף התשלום** (**Display the error on the payment page**).

After updating the settings, click **שמירת הגדרות** (**Save changes**) at the bottom of the page.

{% hint style="info" %}
If you provide an error URL, you gain more control over how payment errors are handled. However, Hyp Pay will redirect the customer to your site for any transaction that is not a standard immediate charge.

This is important if you use [postponed transactions](/pay/common-use-cases/postponing-transactions.md) or [two-phase commits](/pay/advanced-features/two-phase-commits.md). In these cases, successful authorizations return status codes `800` and `700`, respectively. If an error URL is configured, Hyp Pay treats these non-zero codes as failures and redirects the user to your error page, even though they represent successful steps in your payment flow.

If you still prefer to use a custom error page, keep these points in mind:

* **Handle status codes 700 and 800 as success**. Your error page logic must check for these codes and display a success message to the customer.
* **Avoid naming the page "error.html"**. Using a more generic name like `payment-status.html` helps prevent customer confusion when they are redirected there after a successful authorization.
  {% endhint %}

### Enable features you need

By default, Hyp Pay allows customers to pay using credit cards. You can enable additional payment options in your Hyp Portal account.

Under **הגדרות** (**Settings**) in the Hyp Pay navigation menu, you can enable 3D Secure (3DS) for card payments, as well as the following payment methods:

* Bit
* Google Pay
* Apple Pay

![Menu options to enable features](/files/5kpgyXAv8YzLiXV9BiKY)

You can configure these options now or at any time later. For details, see:

* [3D-Secure](/pay/advanced-features/3ds.md)
* [Digital Wallets](/pay/common-use-cases/digital-wallets.md)

### Repeat for each environment

If you were assigned multiple environments and received separate terminal numbers and Hyp Portal credentials for each one, repeat [the steps above](#5-access-your-hyp-portal-account) for every environment.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.hyp.co.il/pay/getting-started/prerequisites-and-initial-setup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.