Help Center

To check requests for payment creation via API, two methods are available.

Allpay API Tester

With Allpay API Tester, you can perform requests for new payment, refund, create subscription, and other operations in both live and test modes, emulating requests from your server.

Simply insert the API login/key of any integration created in the <span class="u-richtext-element">Settings</span> -> <span class="u-richtext-element">API Integrations</span> section, and fill out the form fields according to the API documentation.

If test mode is enabled for the integration, requests will be executed in the test environment.

API request contents

The transaction details show its history. By clicking a history record, you can view the API request body and webhook.

This feature allows you to manage the payment amount via URL, pass customer data filled out on your platform to the payment page, and control the customer's path after a successful payment.

First, you need to create a payment link in the Allpay dashboard and set its type to <span class="u-richtext-element">Customer indicates amount</span>.

You can add the parameters <span class="u-richtext-element">amount</span> for the payment amount, <span class="u-richtext-element">client_name</span>, and <span class="u-richtext-element">client_email</span> for customer data to the payment link URL.

For example, https://allpay.to/~pay/dynamic?amount=100&client_name=Jason%20Statham&client_email=jason@go.com

‍
If the values for the parameters <span class="u-richtext-element">client_name</span> and <span class="u-richtext-element">client_email</span> are not specified, we will request them from the customer during payment.

This way, you can use a single payment link for all customers, specifying an individual amount for each of them.

Supported parameters

<span class="u-richtext-element">amount</span> — payment amount.

<span class="u-richtext-element">client_name</span> — customer name.

<span class="u-richtext-element">client_email</span> — customer email.

<span class="u-richtext-element">client_tehudat</span> — the Tehudat Zehut (Social ID number). This is included in the payment receipt. To hide this field from the page, pass nine zeros.

<span class="u-richtext-element">currency</span> — payment currency. For example, ILS, USD, EUR. If the currency is not approved for the account, it will be converted to ILS.

<span class="u-richtext-element">currency_display</span> — display currency. For example, you can show the price in USD and charge in ILS at the current exchange rate. List of supported display currencies.

<span class="u-richtext-element">lang</span> — language of the payment page. It is auto-detected by the customer's browser language, but you can control it by passing values AR (Arabic), EN (English), HE (Hebrew), or RU (Russian).

Product name

The product or service name cannot be passed this way, as it creates a possibility for manipulation. For example, it would allow changing the name of the provided product or service, which is automatically included in the receipt generated after payment.

Parameter add_field

You can also use the parameter <span class="u-richtext-element">add_field</span>, the value of which will be passed unchanged in the redirect URL after a successful payment (see the article Redirect after payment for how to set up the redirect URL).

For example, https://allpay.to/~pay/dynamic?amount=100&add_field=any_text

In the example above, the parameter <span class="u-richtext-element">add_field=any_text</span> will be passed unchanged in the redirect URL after payment. This allows you to track conversions, direct the customer to the desired stage of your chatbot funnel, and perform other necessary actions after payment.

If needed, you can set the value of <span class="u-richtext-element">add_field</span> to a string with multiple parameters and parse them on your server side. For example, <span class="u-richtext-element">add_field=par1-value1,par2-value2</span>.

If Webhook sending is enabled for the link, the <span class="u-richtext-element">add_field</span> parameter will be included in the request body.

Video tutorial

Creating payment forms

Using this approach and basic web development skills, you can create payment forms for placement on your website. These forms do not replace full capacity of our API but provide a simple and convenient solution for accepting payments.

You can allow customers to select product modifications or quantities, calculate the total based on selected options, and redirect the customer to proceed the payment.

Example in action:

You can view the source code for the forms used in the video at the following links:

https://allpay.to/demo/snippet-example-1.html

https://allpay.to/demo/snippet-example-2.html

Using ChatGPT, you can customize the functionality of the forms to suit your specific needs.

We help Amuta (Non-Profit Organization) connect payment system to accept donations.

Amuta is a non-profit organization that aims to promote socially significant goals or ideas in society.

Documents required to enable payments

1. Identity document (תעודת זהות) of the founder or director.
2. Certificate of registration of the amuta (תעודה לרישומה של עמותה).
3. Bank account details confirmation (אישור ניהול חשבון בנק).
4. Minutes specifying the authorized signatories (פרוטוקול מורשי חתימה). Must be notarized by a lawyer. Download a sample.
5. Certificate of proper management (אישור ניהול תקין) or a confirmation of document submission signed by an accountant (אישור הגשת מסמכים).

The Certificate of proper management confirms the legality and continuity of the amuta’s activity over a two-year period. The Confirmation of document submission serves as a temporary equivalent of the Certificate of proper management.

Registration steps

1. Make sure that the amuta site matches requirements.
2. Fill in registration form.
3. Within 24 hours, an Allpay manager will contact you to request missing documents.
4. If everything is in order, you will receive approval within 2-3 days and will be able to start accepting payments.

Technical capabilities

Allpay allows non-profit organizations to conveniently accept donations online. You can:

• create payment links, including links with an amount input field where the donor enters the donation amount;
• automatically create documents such as receipt (קבלה) and donation receipt (קבלה על תרומה) according to rules implemented in 2026;
• accept automatic monthly donations (subscriptions);
• embed a payment form on your website;
• accept donations via Bit and Apple Pay;
• and use other Allpay features.

When a payment is created through an external website, API, or integration, Allpay by default considers that the transferred price of the product or service already includes VAT.

For example, if the website sends the following line item:

Product name: 116.82 ₪

Allpay displays this amount on the payment page as the final price of the line item:

Product name      116.82 ₪
Subtotal          99.00 ₪
VAT 18%           17.82 ₪
Total             116.82 ₪

This means that the line item price is displayed including VAT, while the breakdown below separately shows the amount before VAT, the VAT amount, and the total amount.

Why Allpay displays the line item price including VAT

There are two reasons for this: technical and legal.

Technical reason

When a payment is created through an external website or integration, Allpay receives already prepared data and assumes that the price submitted by the external website is the final price for the payer.

Allpay does not change the line item price and does not replace it with the price before VAT. We show the buyer the amount submitted by the website or integration.

This is especially important because the external website may have already calculated the price, discount, VAT, currency, subscription, or other conditions. Therefore, Allpay should not change the price of an individual line item at its own discretion.

Legal reason

The payment page is the screen the buyer sees before making the payment. Therefore, it is important to show a clear final price.

Israeli consumer protection law requires the full price of a product or service to be displayed to the consumer. The full price includes all mandatory charges, including VAT, if applicable.

The official explanation by the Consumer Protection and Fair Trade Authority also states that the full price of the product or service must be displayed.

Court practice usually interprets this requirement strictly: if the consumer is shown the price of a product or service without VAT, and VAT is added separately later, this may be considered a less transparent way of displaying the price.

Even if the total amount is shown below, a product line with a price before VAT may create the impression that the product is cheaper. It may also make it harder for the buyer to compare prices between different sellers.

For this reason, the safer and clearer approach for the payment page is to show each line item price including VAT, while displaying the breakdown separately below.

Accounting systems

Accounting systems may display the same payment differently.

For example, Morning may show the line item price before VAT, while EasyCount may show it including VAT.

Below is a screenshot with an example where the same payment is displayed differently in Morning and EasyCount:

Both options may be correct for an accounting document, as long as the final amounts match: the amount before VAT, the VAT amount, and the total amount.

However, the Allpay payment page is not an accounting document. It is the screen shown to the buyer before payment. Therefore, Allpay displays the line item price as the final price for the buyer, including VAT.

When creating a payment link, switch the selector from «I indicate the amount» to «Customer indicates amount» and provide the name of the product or service.

You can also add buttons with predefined amounts, allowing the payer to choose one or enter their own amount in the input field. To make one of the buttons preselected on the payment page, mark it with a star.

The payer will select the desired amount button or enter their own amount and proceed with the payment. The transaction will appear on the main payment screen like any other.

“Donate” button

In the payment link settings, the “Pay” button label can be changed to “Donate”, which is better suited for charitable projects.

Passing the amount through a URL link

If you add <span class="u-richtext-element">?amount=AMOUNT</span> to the end of the URL link, the buttons and input fields will disappear, and the amount will be fixed.

For example, https://allpay.to/~pay/dynamic?amount=300

This helps avoid creating multiple payment links for a single service with a frequently changing price. You only need to create one link and insert the required amount into its URL when sending it to the customer.

In the article "Passing parameters through the payment link URL" you can learn about other options of this feature.

Israeli citizens are required to enter their Teudat Zehut (Social ID) number, which is included in the payment receipt.

Since payments may come not only from Israel but also from other countries, as well as from tourists or Israeli residents who do not have a Teudat Zehut, the payment page includes a checkbox “I am not an Israeli citizen” that hides the Teudat Zehut input field.

If the customer opens the payment page from outside Israel, this checkbox is selected by default.

Managing the field for payments via payment links

The Teudat Zehut input field, including the “I am not an Israeli citizen” checkbox, can be completely hidden from the payment page. This is useful for those who accept payments mainly from abroad.

In the payment link settings, you can enable the <span class="u-richtext-element">Hide Teudat Zehut field</span> option and choose one of two settings:

• For customers outside Israel
• For all customers

Geolocation is determined based on the IP address.

Consult your accountant before enabling this setting.

Managing the field for API payments

‍To pass the Teudat Zehut number or hide this field from the payment page, use the <span class="u-richtext-element">client_tehudat</span> parameter as described in the API documentation.‍

In Allpay, there are two types of expenses:

1. commission on payments
2. subscription fee

Commission

The commission is deducted from each withdrawal. On the 11th of each month, a link to the commission receipt for all payments from the previous month appears in the <span class="u-richtext-element">Withdrawals</span> tab.

Subscription fee

The subscription fee is charged once a month from the linked card. After each charge, a receipt is available in <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Plan</span> ➙ <span class="u-richtext-element">Billing</span>.

‍

Timer lets you set the exact date and time when a link will automatically turn off and stop accepting payments.

For example, this can be useful when selling event tickets or courses that have a registration deadline.

You can set the timer in the payment link settings <span class="u-richtext-element">More</span> → <span class="u-richtext-element">Timer</span>.

Time is always set according to Israel time

If you enable checkbox <span class="u-richtext-element">Show timer on the payment page</span>, the customer will see how much time is left to complete the payment.

After the link is disabled, it will receive the label <span class="u-richtext-element" style="background-color: rgba(221, 94, 94, 0.4)">Disabled</span>

You can also disable the link when the product is out of stock. See the article about quantity management.