Help Center

Found 100 out of 200

API currency management and supported currencies

Allpay lets you display the price in one currency that is convenient for the customer, while charging in another currency.

For example, for customers in Canada you can display the price in CAD, while charging in ILS, so the funds are paid out to the merchant bank account without additional conversion.

In this scenario, the customer will see the amount in two currencies on the payment page, for example: 100 CAD (226 ILS). The actual charge will be made in Israeli shekels (ILS).

This format helps to:

  • show the customer the price in a currency they understand;
  • clearly explain which currency will be charged;
  • reduce confusion when the customer later sees the charge in their bank statement.
Exchange rates are taken from Google Finance at the moment the payment page is opened.

Payment currency

Payment currency (parameter <span class="u-richtext-element">currency</span>) is the currency in which the actual charge is made and the funds are paid out to the merchant bank account.

The customer’s card currency does not matter — after the charge, the customer’s bank will convert the amount using its own exchange rate if the card is denominated in another currency.

By default, after registering in Allpay only ILS payment currency is available. You can enable USD and EUR according to this instruction.

Supported payment currencies

Euro — EUR

Israeli new shekel — ILS

United States dollar — USD

Валюта отображения

Display currency (parameter <span class="u-richtext-element">currency_display</span>) is the currency shown to the customer on the payment page.

Send this parameter only when the display currency is different from the payment currency.

If <span class="u-richtext-element">currency_display</span> is provided:

  • the <span class="u-richtext-element">price</span> must be sent in the display currency;
  • Allpay automatically converts the amount from <span class="u-richtext-element">currency_display</span> to <span class="u-richtext-element">currency</span> using current Google Finance exchange rate;
  • the customer is always charged in the payment currency (<span class="u-richtext-element">currency</span>).

For example, for Europe customer you can display the price in EUR and charge in ILS. Or for customer from Canada display the price in CAD and charge in USD.

Supported display currencies

Australian dollar — AUD

Azerbaijani manat — AZN

Canadian dollar — CAD

Euro — EUR

Georgian lari — GEL

Israeli new shekel — ILS

Kazakhstani tenge — KZT

Norwegian krone — NOK

Pound sterling — GBP

Russian ruble — RUB

Thai baht — THB

Ugandan shilling — UGX

United Arab Emirates dirham — AED

United States dollar — USD

Ukrainian hryvnia — UAH

If the currency you need is not in the list, please contact support.

Examples of using <span class="u-richtext-element">currency_display</span> in API requests

Send <span class="u-richtext-element">currency_display</span> only when you need to display the price in one currency but charge in another.

Example 1

{  
  "items": [
    {
      "name": "Product name",
      "price": "100",
      "qty": "1",
      "vat": "0"
    }
  ],
  "currency": "USD",
  "currency_display": "CAD"
  }

Allpay will convert 100 CAD to USD and the customer will be charged in USD.

At the time this article was written: 100 CAD = 72 USD, so the charge will be 72 USD.

If the account is not approved for USD, the system will automatically convert the amount to ILS (the default currency).

Example 2

{  
  "items": [
    {
      "name": "Product name",
      "price": "100",
      "qty": "1",
      "vat": "0"
    }
  ],  
  "currency_display": "CAD"
  }

Because <span class="u-richtext-element">currency</span> is not provided, 100 CAD will be converted to ILS (the default currency), and the customer will be charged in ILS.

Example 3

{  
  "items": [
    {
      "name": "Product name",
      "price": "100",
      "qty": "1",
      "vat": "0"
    }
  ],  
  "currency": "CAD"
  }

This request is invalid because CAD cannot be used as a payment currency. However, the system will not return an error. Instead, it will convert CAD to ILS (the default currency) and charge the customer in ILS.

To test different currency combinations, use the Allpay API tester.
Keep reading
API

Filters and export

To export transactions for a specific period or of a specific type, first apply a filter and then click the export button. You can also find the required transactions using search and then export them.

Don’t forget to reset applied filters so you don’t miss any payments.
Keep reading
Profile

Rapid installment settlement (Sherut Nikayon)

By default, installment payments are credited monthly in portions according to the number of installments chosen by the customer.

For example, if a purchase is divided into 10 installments, the amount will be credited in 10 equal parts over 10 months, as the customer’s card is charged each month.

However, it is possible to receive the full amount immediately with the first payout.

This service is currently in a trial phase. The launch announcement will be made in the Telegram channel.

Activation

The service is not yet available through the Allpay interface. To activate it, please contact support.

The service is not retroactive, meaning it does not apply to payments made before activation.

Requirements

Before activating the service, the following conditions must be met:

  • You have been using Allpay for at least three months.
  • The total transaction volume during this period is at least 15,000 ILS.

These criteria help assess the business’s transaction activity and reduce chargeback risks — cases where a business receives a large payout and the cardholder later reports an unauthorized transaction.

Commission

The commission is calculated as:
M × 0.77% × (N − 1)
where M is the full transaction amount
and N is the number of installments (tashlumim) selected by the customer.

For example:
If a total of 10,000 ILS is split into 10 installments of 1,000 ILS each,
then 10,000 × 0.77% × 9 = 693 ILS.

How it works

When a customer chooses to pay in installments, the credit company normally collects the money monthly from the customer’s card and transfers it to the business in parts.

With Sherut Nikayon, the credit company pays the full amount upfront to the business, charging an additional percentage as a fee, and then collects it back from the customer in installments.

Keep reading
Payouts
Payment links
Popular

Payment page language

The payment page supports languages: Arabic, English, French, German, Hebrew, Italian, Russian and Spanish.

The language is detected automatically based on the customer’s browser language, so each customer sees the payment page in their own language. If the browser language is not supported or cannot be detected, English will be set by default.

To manually control the language of the payment page, go to <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Payment links</span> and enable the <span class="u-richtext-element">Language settings</span> toggle.

Then, in the payment link settings, you can set the language in which the customer will see the payment page, regardless of their browser language. The language switcher will still remain available on the payment page.

Translation of additional fields

If you add custom fields to the payment page, their labels can be translated into all four languages. This makes the payment page convenient for a multilingual audience. For more details, see the article about additional fields.

Language control via API

For payments initiated from your website (i.e., not through payment links created in Allpay), the payment page language can be controlled via the API according to the documentation.

By default, automatic detection based on the browser settings applies.

Keep reading
Payment links

Additional input fields on the payment page

You can request the customer's phone number, address, website, or other information by adding additional fields to the payment page.

This applies to payment links created through Allpay. If you are connected via the API, field setup is done on your website.

Adding input fields for payment links

1. Activating additional input fields  

Activate additional input fields in the <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Payment Links</span> section.  

2. Adding fields  

When creating a payment link, click <span class="u-richtext-element">Advanced</span>, then <span class="u-richtext-element">Manage Fields</span>. Add the required fields and their names, then click "Save".

The added fields will be available for ALL payment links.

3. Activating fields

Activate the toggle for the fields you want to display on the payment page for THIS SPECIFIC payment link.

If the field is also marked as required, the customer will not be able to proceed with the payment without filling it in.

4. After payment

The information entered by the customer is displayed in the transaction details on the main payment page. It is also included in payment notifications sent to Telegram, your email, and the customer.  

Field labels translation

Field labels can be translated into all available languages.

In the <span class="u-richtext-element">Field management</span> section, select a language using the language switcher and add a translation for each field.

If a translation is not added for a specific language, English will be used as the default language. Therefore, we recommend always adding an English translation.

How to insert a link  

HTML tags are allowed in input field names: <span class="u-richtext-element">a</span> for links, <span class="u-richtext-element">b</span> for bold text, <span class="u-richtext-element">i</span> for italics, and <span class="u-richtext-element">span</span> for applying custom styles.  For example, to insert a link into the name of a checkbox field, the name should look as follows:

Agree with <a href="https://allpay.co.il/terms">the terms</a>  

The result will look as follows:

«Agree with <a href="https://allpay.co.il/terms">the terms</a>»

Video tutorial

Keep reading
Payment links

Payment provider for Amuta (NPO)

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 enables NPOs to accept donations online with ease. You can create payment links with a flexible amount field, allowing donors to choose the amount they wish to contribute. For ongoing support, subscriptions with automatic monthly donations are available.

In addition, all other Allpay features will be available to you, including full integration of payments with your website.

Keep reading
Sign up

Hosted Fields: how to embed payment form on a website

Hosted Fields allow you to embed card input fields on your website or app, fully adapting them to the system's design. They create a seamless interface experience and eliminate the need to redirect the customer to an external payment page. This improves usability and conversion rates.

The input fields for the card number, expiration date, and CVC are represented as an iFrame. We provide the ability to fully customize their CSS and embed them on your site as a single frame.

Tutorial

Setup

<span class="u-richtext-counter">1</span> In the <span class="u-richtext-element">Settings</span> → <span class="u-richtext-element">Integrations</span> → <span class="u-richtext-element">My sites</span> enable Hosted Fields for the required integration.

<span class="u-richtext-counter">2</span> Click the <span class="u-richtext-element">Hosted Fields settings</span> button and specify the domain where the payment will be processed. Domains and subdomains must be entered one per line in plain format, without <span class="u-richtext-element">https://</span>, paths, or any additional parts — for example, <span class="u-richtext-element">mysite.com</span>. If needed, adjust the CSS styles for the input fields.

<span class="u-richtext-counter">3</span> On your website’s payment page, place an iFrame, assign any custom value to its <span class="u-richtext-element">id</span> parameter, and in the <span class="u-richtext-element">src</span> parameter specify the payment URL (payment_url) returned by Allpay in response to a payment creation request (see Payment request section in the API Reference). Payment URLs can also be generated using the Allpay API Tester.

<span class="u-richtext-counter">4</span> Add the following script to the payment page:

1<script src="https://allpay.to/js/allpay-hf.js"></script>
2    <script>
3    let Allpay = new AllpayPayment(
4        {
5            iframeId: 'iframe_id',
6            onSuccess: function() { alert('Payment success'); },
7            onError: function(error_n, error_msg) { alert('Payment error: ' + error_n + ' (' + error_msg + ')'); }
8        }
9    );
10    </script>

In the script, replace the following parameters with your own:

  • <span class="u-richtext-element">iframeId</span> — the id value of your iFrame.
  • <span class="u-richtext-element">onSuccess</span> — the handler for successful payment completion (what should happen after successful payment).
  • <span class="u-richtext-element">onError</span> — the handler for payment errors. For example, you can display the payment error message on the page.

<span class="u-richtext-counter">5</span> To initiate the process, execute the function <span class="u-richtext-element">Allpay.pay()</span>, for example, by assigning it to the "Pay" button:

<button onclick="Allpay.pay();">Pay</button>

Installments

If you enabled the installment option for the customer when creating the payment by passing a value in the <span class="u-richtext-element">inst</span> parameter, a field for selecting the number of payments will automatically appear in the frame.

Quick Pay Buttons

Apple Pay and Bit buttons will not be displayed in preview mode or within the iFrame if they are not activated in the <span class="u-richtext-element">Settings</span> → <span class="u-richtext-element">Modules</span>.

Additionally, these buttons are not displayed in test mode. As well as in live mode for installment or subscription payments.

Apple Pay button

At the moment, the Apple Pay button does not work inside Hosted Fields. We are working on a solution.

To ensure Apple Pay button works correctly, set the attribute <span class="u-richtext-element">allow="payment *"</span> in the <span class="u-richtext-element">iframe</span> tag. Example:

<iframe id="myPaymentIframe" allow="payment *" src="..." >
Keep reading
API

Q&A about API

What is the request limit?
60 requests per minute. Contact support if you need a higher limit.

Keep reading
API
Travolta confused - no search results
No results found.
Subscribe for important updates (ad-free)
Subscribe
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.

FAQ

Found 100 out of 200
Text Link

Is there an additional fee for payment links?

No, payment links and site payment integration are our core services, included in the plan and available immediately after registration.

Text Link

Does Allpay only work as an app?

No, your customer won't need to install Allpay. They will access the payment page just like any other website page.

Text Link

What should I do if the required integration is not on the list?

Payment integration is typically handled by the platform. Reach out to the platform's support team and request integration with Allpay — we'll provide technical assistance. If the platform allows you to develop the integration yourself, contact us for support.

Text Link

How can I find out all the costs I will incur?

Complete information is available on the Pricing page.

Text Link

Do you have Apple Pay, Google Pay and Bit fast payment buttons?

We have Apple Pay and Bit. Google Pay coming in future.

Text Link

Are there any additional costs?

Digital receipts are connected as a third-party service, which costs about 20 ILS per month.

Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Travolta confused - no search results
No results found.

Start accepting payments

Connect a sales channel for your business today
Free sign up
7-day trial
Cancel anytime
Sign up

Digital receipts

Automatic generation of digital receipts (kabalot and hashbonit mas) through integration with a licensed service.

Weekly payouts

Option to receive payouts to a bank account weekly instead of monthly.

Currencies

Payments in ILS, USD and EUR without conversion and in any other currency with deposit in ILS.

Integrations

Integrate payments with online stores, CMS, and chatbots using a single Allpay account.