Help Center

Found 100 out of 200

How to integrate your platform with Allpay

Platform developers that need a payment solution can integrate with Allpay.

This model is suitable for platforms that want to add Allpay as a payment method and be listed in the Allpay integrations catalog. It does not include partner payouts and is based on mutual promotion (other partnership models).

This integration will become available to Allpay customers as a ready-made way to connect your platform.

Requirements

To have your platform added to the Allpay integrations catalog, the following conditions must be met:

You do not participate in the Allpay partner or referral program.
This integration is based on mutual promotion.
The integration must be approved by Allpay in advance.
Your platform must be in demand in Israel and already used by real customers.
You are ready to support the integration on an ongoing basis.
You are responsible for maintaining the integration and providing customer support on your side.

How to start

To approve the integration of your platform, contact Allpay support and briefly describe:

your platform;
who your customers are;
how exactly you want to use Allpay payments;
which integration method you plan to use: manual or automated;
whether there are already customers who need this integration.

Integration methods

Integration with Allpay can be implemented in two ways:

manual integration;
automated integration.

Manual integration

With manual integration, you implement the connection on your side and publish instructions for customers on your website.

The customer will need to:

Open the integrations section in the Allpay dashboard.
Create API keys.
Copy the keys and paste them into the settings of your platform.

Technical involvement from Allpay is usually not required for this type of integration. After implementation, send us information about your platform and a link to the Allpay connection instructions on your website.

After review and approval, your platform will be added to the Allpay integrations catalog.

Automated integration

Automated integration allows the platform to be connected without manually copying API keys. The user clicks the connection button in the Allpay dashboard, confirms the connection on your platform side, and the API keys are transferred automatically.

Before implementation, Allpay provides your platform with:

partner_id — the individual integration ID;

secret_key — the secret key for signing and verifying server requests.

1Redirect from Allpay to your platform page

The user opens the Settings → Integrations → Your platform section in the Allpay dashboard and clicks the connection button.

Allpay generates a one-time token for linking the accounts and redirects the user to the confirmation page on your platform side, for example:

https://your-platform.com/connect?token=TOKEN

Where TOKEN is the one-time token created by Allpay.

The standard token lifetime is 1 hour.

2Confirmation on your platform side

On your side, the user confirms the connection under their account.

After confirmation, your platform redirects the user back to the universal Allpay endpoint:

https://allpay.to/services/endpoints/exchange.php?act=connect&partner_id=PARTNER_ID&token=TOKEN&external_uid=USER_ID&display_name=DISPLAY_NAME

Where:

act=connect — the integration connection action;

partner_id — the individual integration ID;

token — the one-time token created by Allpay;

external_uid — the internal user ID on your platform.

display_name — a human-readable name of the account being connected (e.g. login, name or subdomain on your platform). This is the value shown in the Allpay dashboard's integrations list — pass something the user will recognize themselves, not an internal technical identifier. The value must be URL-encoded, max 255 characters.

3Creating and sending API keys to your platform

After verifying the token, Allpay links the Allpay user with the user on your platform, creates or finds the API keys api_login and api_key, and then sends them to your endpoint.

Example endpoint on your platform side:

POST https://your-platform.com/allpay/partner/exchange

Request body:

{
  "external_uid": "USER_ID",
  "api_login": "API_LOGIN",
  "api_key": "API_KEY",
  "sign": "SIGNATURE"
}

Where:

external_uid — the user ID on your platform;

api_login — the Allpay user's API login;

api_key — the Allpay user's API key;

sign — the request signature.

4Request signature

The server request with the API keys is signed using HMAC SHA-256.

Signature format:

hash_hmac('sha256', $payload_json, $secret_key);

Where:

payload_json — the JSON request body;

secret_key — the individual secret key.

5Response from your platform

After successfully receiving and saving the keys, your platform must return a successful response, for example:

{
  "ok": true
}

After this, Allpay marks the integration as active.

Disconnecting the integration

If the user disconnects the integration on your platform side, you must delete the saved API keys on your side.

In addition, your platform must send a POST request to Allpay to disconnect the integration:

POST https://allpay.to/services/endpoints/exchange.php?act=disconnect&partner_id=PARTNER_ID

Request body:

{
  "external_uid": "USER_ID",
  "sign": "SIGNATURE"
}

Where:

external_uid — the user ID on your platform;

sign — the request signature.

The disconnect request is also signed using secret_key.

If the user disconnects the integration from the Allpay dashboard, Allpay can send a disconnect notification to your platform endpoint. To receive this notification, provide an endpoint on your side.

Connecting via a link from your dashboard

You can start the connection on your side instead of from the Allpay dashboard. You generate a signed link and show it to the user (a button in your dashboard):

https://allpay.to/services/endpoints/exchange.php?partner_id=<your id>&show=start&external_uid=<…>&state=<…>&display_name=<…>&expires=<unix>&return_url=<…>&sign=<…>

The user confirms the connection in Allpay, Allpay sends the keys to your keys_url, and then the user is returned to your return_url.

Link parameters

partner_id — your partner ID;

show — always start, not included in the signature;

external_uid — the ID of what is being connected on your platform (for example, the branch ID), up to 255 characters. A link with a longer value is rejected;

state — any value you generate for this link, up to 500 characters (a longer value is truncated). Store it on your side together with the user who requested the link and the external_uid. We return it in the request to keys_url and in the redirect to return_url;

display_name — what is being connected (for example, the branch name), up to 255 characters. Optional, but we recommend passing it: it is shown to the user on the Allpay confirmation screen and in the Allpay dashboard;

expires — Unix time until which the link is valid. No later than 30 days from now; a link with a later date is rejected;

return_url — required; the address to send the user back to after a successful connection. https only, and the host must match the host of your connect_url exactly (subdomains do not match). A link without a valid return_url is rejected;

sign — the link signature. Calculated with the same rules as for API requests. All parameters except show and sign are signed.

What happens next

1. The user opens the link and signs in to Allpay, if not signed in yet.

2. On the Allpay screen, the user sees which Allpay company is being connected and what exactly (display_name), and clicks "Connect".

3. Allpay sends the keys to your keys_url as a JSON POST request. The X-Allpay-Signature header contains the HMAC-SHA256 of the raw request body, signed with your partner_secret. Request body fields:

external_uid — from the link;

state — from the link (if you passed it);

api_login, api_key — the API keys;

token — an internal value, you can ignore it.

Your server must respond with exactly HTTP 200.

4. The user is returned to return_url with state added (if you passed it): return_url?state=<state>, or &state=<state> if return_url already has a query string.

If your keys_url does not respond with HTTP 200, the connection is not made, the user sees an error in Allpay, and the same link can be opened again.

Verify the user on your side

The link is not tied to a specific Allpay company: whoever opens it and signs in to Allpay can confirm it. The keys arrive at your keys_url before the user returns to you, so do not activate them right away:

when the keys arrive, find the link by state and check that external_uid matches;
on return_url, require the user to be signed in to your dashboard. If they are not, send them to sign in and then back;
check that this state was issued to the user who is now signed in, that it has not expired, and that this user has rights to that external_uid. If all checks pass, activate the keys and mark the state as used.

This check does not protect against your own user connecting the wrong Allpay company, for example by signing in under a different company. If this matters to you, show your user which connection was made before activating the keys.

Important

The link is single-use. After a successful connection through it, opening it again is rejected, even after a disconnect. Generate a new link, with a new state, for each connection attempt: links with completely identical parameters (including expires) are treated by Allpay as the same link.

An existing connection is never replaced. The connection is rejected if:

the Allpay company already has a connection to your platform, including a paused one;
this external_uid is already connected to any Allpay company.

To connect something else, first disconnect the current connection: in the Allpay dashboard, or with act=disconnect from your side. A paused connection cannot be disconnected with act=disconnect, only in the Allpay dashboard.

Open and confirm the link in the same browser. A new link from your platform opened in the same session replaces the previous one.

Security requirements

For automated integration, the following requirements must be met:

HTTPS only
All requests between Allpay and your platform must be sent only over HTTPS.
Secure key storage
The received api_login and api_key must be stored securely on your side.
Server request signatures
Server requests must be signed using secret_key.

Information for the integrations catalog

After the technical part is completed and the integration is working, send us the following information to add your platform to the Allpay integrations catalog:

platform logo in SVG format;
short platform description of up to 200 characters;
extended platform description of up to 360 characters;
technical support contacts for the integration: email and WhatsApp or Telegram;
information on whether your integration supports installments, recurring payments, and refunds;
link to the Allpay connection instructions on your website.

Allpay branding guidelines

Use the correct brand spelling:

correct: Allpay;

incorrect: AllPay, All Pay, allpay.

Use the official Allpay logo.

Keep reading

Integrations

API

J5 transaction: reserving funds on a client's card for later charge

A J5 transaction is a two-step payment process that begins with a pre-authorization. In the first step, the specified amount is reserved (held) on the buyer’s card for up to 168 hours (7 days) without actually charging the card.

To charge the reserved funds, the seller must initiate a charge request within that time frame and within the reserved amount. If the charge is for a smaller amount, the remaining balance is automatically released.

The term “J5” is used in Israeli payment systems as an internal code to refer to this type of transaction.

Use Cases

Delivery orders – The amount is reserved when the order is placed and charged after delivery is confirmed.

Variable price orders – For example, when buying products sold by weight (meat, fruits, vegetables), the final price is determined after weighing.

‍Pay as you go – The customer uses a service within a limit, and the final amount is calculated at the end.

Car rentals & hotels – The amount is reserved to cover possible damages or extra expenses.

Custom-made products – When ordering custom furniture or jewelry, the amount is reserved at checkout and charged when the product is ready.

Limitations

The charged amount cannot exceed the reserved amount.

Charging is allowed only once. Any attempt to charge again or after 168 hours will result in an error.

Supported Payment Methods

Both Israeli and international credit and debit cards are supported.

Quick payment methods (Apple Pay, Google Pay, Bit) are not supported for J5. These buttons will be hidden on the authorization page.

Important to know

An authorization may look like an actual payment to the customer: some card issuers send an SMS in the same format as they do when a card is charged. However, in the card issuer’s online account, the transaction is usually marked as “Amount not final” or something similar.

If you subsequently charge less than the authorized amount, the remainder is released automatically. However, the card issuer may need a from few hours to few days to update the transaction details and make the unused amount available to the customer again.

How to Use

J5 functionality is available to developers via the Allpay API: view API documentation.

Demo

Keep reading

API

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 (optional parameter currency_payment) 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

Display currency (required parameter currency_display) is the currency shown to the customer on the payment page.

Always send this parameter, even if display currency is same as payment currency.

the item cost provided in price must be sent in the display currency;
Allpay automatically converts the amount from currency_display to currency_payment using current Google Finance exchange rate;
the customer is always charged in the payment currency (currency_payment). If not porovided, ILS used as default.
If the display currency and the payment currency are different, the webhook includes the currency_course parameter with the conversion rate that was applied.

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

Chinese Yuan — CNY

Euro — EUR

Georgian lari — GEL

Japanese yen — JPY

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 currency_display in API requests

Always send currency_display even if it is matches currency_payment.

Example 1

{  
  "items": [
    {
      "name": "Product name",
      "price": "100",
      "qty": "1",
      "vat": "0"
    }
  ],
  "currency_payment": "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 currency_payment 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_payment": "CAD"
  }

API will return error since currency_display was not provided.

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

Keep reading

API

Users and access

In Settings → Team you can add employees as users of your Allpay account.

Access permissions

The Team section is available only to the business owner. Only the owner can add users, edit their details and manage access.

Users you add have access to all other sections of the account. They cannot add other users or edit their details. Custom access permissions are not currently available.

Adding a user

Open Settings → Team and click the plus button.
Enter the user’s full name and position on the team.
Add at least one contact for signing in: an email address, phone number or Telegram.

You can add multiple contacts, including several of the same type, such as multiple email addresses. The same contact cannot be linked to different users.

Verifying contacts

Each contact you add must be verified within 48 hours. To do this, the user must sign in to Allpay using that contact.

Allpay does not send automatic invitations, so let the employee know that they have been given access. You can copy the sign-in link from the user’s profile.

If the user does not verify the contact within this time, the business owner can extend the deadline by another 48 hours by clicking the corresponding button.

Updating details

The business owner can edit a user’s details by clicking “Edit” on the user’s card.

The business owner’s details and contacts can only be updated if the owner personally contacts Allpay Support.

Disabling a user

A user can sign in to the account while the “Account active” toggle on their card is enabled.

If you turn it off, the user will lose access to the account and be automatically signed out. If they previously connected the account to an AI assistant through MCP, that access will also be revoked.

The business owner cannot be disabled.

Activity history

You can view all users’ activity in the “Activity log” tab.

Access to multiple companies

If the same user contact is listed for several companies, the user can switch between them in the settings menu or the “Profile” section.

Contacting support

When contacting Allpay Support about your account, use a contact listed under your name in the “Team” section.

If a request comes from a contact that is not listed for the business owner or an employee in the “Team” section, Allpay Support may decline to disclose sensitive account information.

Keep reading

Profile

Security

How to receive installment payments (tashlumim)

When creating a payment link, you can enable installment payments and set the maximum number of installments — up to 12. The customer can choose how many installments to split the total into, within the limit you set.

If the customer chooses two or more installments, their card will be charged and you will receive the funds in monthly installments until the full amount is paid.

There is no additional installment fee for either the business or the customer. If you want to receive the full amount upfront, you can activate the “Installments upfront” service, which carries an additional fee.

Installment payments are available only with credit cards issued in Israel.

1 Create a payment link

When creating the link, open the More section, select Installments as the payment type, and specify the maximum number of payments the customer will be able to choose.

2 Send the link to the customer

On the payment page, the customer will see an option to choose the number of payments. If they leave it as one payment, the full amount will be charged immediately.

Example

For a service costing 6,000₪, you enabled up to 5 installments. The customer chose to pay in 3 installments. At the time of payment, 2,000₪ will be charged, another 2,000₪ a month later, and the final 2,000₪ in the third month.

A receipt for installment payments is generated for the full amount immediately. The payment schedule is shown in the receipt.

If the installment payment fails

The most likely reasons are:

The customer’s card is not a credit card but a debit card;
The card was not issued by an Israeli bank;
The card’s credit limit (misgeret) is lower than the total payment amount.

Why installments are not available for foreign cards

Installment payments work only with Israeli credit cards within their credit limit. Since the system cannot manage credit limits of foreign banks, payment splitting on such cards is not supported.

This is a limitation of the financial system. In essence, installments are a form of credit. If the customer doesn’t have sufficient funds in their account, you (the business) still receive the next payment because the bank provides credit to the customer. Managing credit limits and collecting debts in case of nonpayment can only be guaranteed within the country.

If the customer cancels the card

You will continue receiving installment payments even if the customer closes or cancels the credit card that was used for the payment.

Keep reading

Payment links

Popular

Language of emails and notifications from Allpay

Each user can choose the language of emails and notifications from Allpay.

To change the language, go to Settings → Profile and select an option in the “Email and notification language” field.

This setting applies to all emails and Telegram notifications about payments, payouts, and account status, as well as email newsletters.

Recipients outside your team

In the Notifications section, you can specify email addresses and Telegram accounts for people who have not been added as users. They will receive notifications without access to the system.

These messages are sent in the system language selected in the company owner’s profile.

Customer emails

This setting does not affect customer emails. Customers receive payment emails in the language of the payment page.

Keep reading

Profile

Accepting payments in USD and EUR

In addition to shekels, Allpay supports payments in US dollars (USD) and euros (EUR).

Available payment currencies are shown in the Settings ➙ Permissions section.

By default, only payments in shekels are enabled after registration. To accept payments in USD or EUR, a separate permission must be requested.

Before requesting permission to accept payments in foreign currencies

In many cases, accepting payments in shekels is sufficient for a business. However, if your customers are located in Europe, the US, or other countries, it may be more convenient for them to view prices in USD or EUR.

For this purpose, we offer a special feature — currency display conversion. This means the customer will see the payment amount in, for example, euros, but the actual charge will be made in shekels based on their bank’s exchange rate.

No permission is required to use this feature — it is already available.
‍

More details: How to display the payment amount in USD or EUR.

We recommend using this solution in most cases.

Requesting permission to accept payments in foreign currencies

Go to Settings ➙ Modules and activate the “USD & EUR” module.

To activate it, you’ll need to upload a bank letter with the details of your foreign currency account. The letter must:

Include the account number in IBAN format
Include your name (or company name) and Teudat Zehut number (or company number)

Examples of bank letters:‍ Discount, Leumi, Hapoalim.

The confirmation letter can be downloaded from your bank's online account or obtained by visiting the bank in person. Letters that do not meet the above requirements will not be accepted.

The letter will be forwarded to the relevant credit company (Isracard or CAL — depending on how your business is connected to the Allpay system) with a request to approve foreign currency operations for your account.

The average approval time is 2–4 business days.

Allpay cannot guarantee approval for foreign currency transactions; however, we do everything possible to ensure that all our customers receive the necessary authorization.

When a business website has an English version and clearly displays products or services with prices in USD or EUR, it increases the likelihood of approval.

Once the approval is granted, the module status will change to “Active” and you will receive a notification. Please make sure notifications are enabled under Settings ➙ Notifications.

How to accept payments in foreign currency

When creating a payment link, you will see an option to switch the payment currency.

When creating payments via API, you can pass the values "USD" or "EUR" in the currency parameter.

Commission and withdrawals

We do not charge any additional commission for foreign currency payments — standard rates apply.

However, your bank may charge a fee for receiving currency withdrawals. These withdrawals are made via the SWIFT system and go through a chain of three banks: our bank, your bank’s foreign branch, and your bank in Israel. The total fee per withdrawal can reach up to $40. We cannot influence this fee, but you can ask your bank for better terms.

For this reason, withdrawals are made starting from 100 USD/EUR. Any amount below 100 USD/EUR will be carried over to the next withdrawal.

Receipts

According to the law, official receipts (kabalot and heshbonit mas) must be issued in shekels.

Therefore, for foreign currency payments, the service price in the receipt appears in the payment currency, while the VAT amount and total are shown in shekels based on the current exchange rate. We use exchange rates from Google Finance.

If your customer needs a receipt showing the total amount in the original payment currency (not in shekels), a copy can be downloaded from the EasyCount or Morning dashboard.

Keep reading

Profile

Payment links

Documents

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

1 In the Settings → Integrations → My sites enable Hosted Fields for the required integration.

2 Click Hosted Fields settings and specify the domains where Hosted Fields will be used. Enter each domain or subdomain on a separate line without “https://”, for example: mysite.com. To allow all subdomains, use the * wildcard, for example: *.mysite.com.

If needed, adjust the CSS styles for the input fields.

3 On your website’s payment page, place an iFrame, assign any custom value to its id parameter, and in the src 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.‍

4 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:

iframeId — the id value of your iFrame.
onSuccess — the handler for successful payment completion (what should happen after successful payment).
onError — the handler for payment errors. For example, you can display the payment error message on the page.

5 To initiate the process, execute the function Allpay.pay(), 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 inst 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 Settings → Modules.

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

Apple Pay button

For the Apple Pay button to work correctly, complete the following two steps:

1Add the allow="payment *" attribute to the iframe tag. Example:

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

2Upload the Apple Pay certificate to your domain’s server. The certificate and installation instructions are available in the Hosted Fields settings in your Allpay account.

Google Pay button

For the Google Pay button to work on your domain, the domain must be verified by Google, after which your Google Merchant ID must be added to the payment system.

1Create a profile in the Google Pay & Wallet Console.

2In Google Pay API → Web integration, enter your domain and select Gateway as the integration type.

3Upload screenshots of the buyflow from your website. After activating Google Pay in Allpay’s payment modules, the Google Pay button will appear but will not work yet. This will allow you to take screenshots of the Item selection, Pre-purchase screen, and Payment method screen.

For the Google Pay API payment screen, upload a screenshot of the error that appears when you click the button. For the Post-purchase screen, upload a screenshot of your successful payment page, even if it does not mention Google Pay.

4Submit your application and wait for Google’s approval. The review may take several business days.

5Copy your Google Merchant ID and enter it in the Hosted Fields settings in your Allpay account. It may take several days for the ID to be configured in the payment system, after which Google Pay payments will start working.

Your website may not pass Google’s review if it does not comply with the Google Pay and Wallet API's Acceptable Use Policy or the Google’s Terms of Service.

If you represent a nonprofit organization (amuta) follow Google’s instructions.

Embedding in a mobile app (WebView)

If you embed the payment page in a mobile app using a WebView (android.webkit.WebView or WKWebView), some payment methods may not work correctly. For example, Bit or 3D Secure verification may redirect the user to a payment or banking app using special links such as intent://

Unlike a standard browser, WebView does not always handle these redirects automatically. As a result, the external app may not open, preventing the user from completing the payment.

We recommend opening the payment page using a system browser component:

Chrome Custom Tabs on Android;
SFSafariViewController on iOS.

These components behave similarly to a standard mobile browser and provide better support for redirects to payment and banking apps.

If you need to use WebView, handle navigation within the mobile app:

open regular http:// and https:// links inside the WebView;
pass links that use other schemes to the operating system so it can open the appropriate app;
if the required app is not installed, use the provided fallback link to open the browser, App Store, or Google Play.

This limitation is related to how WebView handles external links, not to Hosted Fields itself.

Keep reading

API

No results found.

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form.

Start accepting payments

Connect a sales channel for your business today

Free sign up

7-day trial

Cancel anytime

Major card brands

Accepting payments with Visa, MasterCard, American Express, Diners, Discover, JCB and Isracard.

Integrations

Connect unlimited online stores, CMS platforms, and AI tools including ChatGPT and Claude.

Currencies

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

Apple Pay, Google Pay and Bit

Fast and convenient payment methods with no additional fees.

Contact

info@allpay.co.il

Updates

News releases Telegram channel

Solutions

Payment links Integrations API reference

Resources

Help Center Allpay logo System status

Docs

App

Install
on iPhone

Allpay LTD. PCI DSS Level 1 compliant.

By clicking "Accept", you allow us to store cookies to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Privacy Policy for details.

Accept Reject Preferences

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form.

Help Center

How to integrate your platform with Allpay

Requirements

How to start

Integration methods

Manual integration

Automated integration

<span class="u-richtext-counter">1</span>Redirect from Allpay to your platform page

<span class="u-richtext-counter">2</span>Confirmation on your platform side

<span class="u-richtext-counter">3</span>Creating and sending API keys to your platform

<span class="u-richtext-counter">4</span>Request signature

<span class="u-richtext-counter">5</span>Response from your platform

Disconnecting the integration

Connecting via a link from your dashboard

Link parameters

What happens next

Verify the user on your side

Important

Security requirements

<span id="info">Information for the integrations catalog</span>

Allpay branding guidelines

J5 transaction: reserving funds on a client's card for later charge

Use Cases

Limitations

Supported Payment Methods

Important to know

How to Use

Demo

API currency management and supported currencies

Payment currency

Supported payment currencies

Display currency

Supported display currencies

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

Example 1

Example 2

Example 3

Users and access

Access permissions

Adding a user

Verifying contacts

Updating details

Disabling a user

Activity history

Access to multiple companies

Contacting support

How to receive installment payments (tashlumim)

<span class="u-richtext-counter">1</span> Create a payment link

<span class="u-richtext-counter">2</span> Send the link to the customer

Example

If the installment payment fails

Why installments are not available for foreign cards

If the customer cancels the card

Language of emails and notifications from Allpay

Recipients outside your team

Customer emails

Accepting payments in USD and EUR

Before requesting permission to accept payments in foreign currencies

Requesting permission to accept payments in foreign currencies

How to accept payments in foreign currency

Commission and withdrawals

Receipts

Hosted Fields: how to embed payment form on a website

Tutorial

Setup

Installments

Quick Pay Buttons

Apple Pay button

<span id=google-pay>Google Pay button</span>

Embedding in a mobile app (WebView)

FAQ

Is there an additional fee for payment links?

Are there any additional costs?

Does Allpay only work as an app?

Do you have webhooks?

Does your API support hosted fields?

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

Start accepting payments

Major card brands

Integrations