Help Center

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" id="domains">2</span> Click <span class="u-richtext-element">Hosted Fields settings</span> and specify the domains where Hosted Fields will be used. Enter each domain or subdomain on a separate line without “https://”, for example: <span class="u-richtext-element">mysite.com</span>. To allow all subdomains, use the <span class="u-richtext-element">*</span> wildcard, 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

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="..." >

You will also need to install an Apple Pay certificate on your server. Please contact our support team to obtain it.

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 <span class="u-richtext-element">intent://</span>

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 <span class="u-richtext-element">http://</span> and <span class="u-richtext-element">https://</span> 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.

By default, the amount of an installment payment is credited in monthly parts, depending on the number of payments selected by the customer at checkout.

For example, if the amount was split into 10 payments, the funds will be credited as 1/10 of the amount over 10 months, as the customer’s card is charged.

However, the business can receive the full amount upfront — together with the first payout. The customer will still be charged in parts according to the regular installment schedule.

When using the «sherut nikayon» (שירות ניכיון) service, the credit company pays the business the full amount upfront (deducts an additional commission), and then collects the funds from the customer in parts.

It will not be possible to split payments between regular installments without an additional fee and installments upfront with an additional fee. While the service is active, all installment payments will be processed through the upfront installments mechanism.

Requirements

Since receiving the full amount upfront uses a credit mechanism, three conditions must be met before the service can be activated:

1. Business owner must be at least 21 years old.
2. Allpay must be used for at least three months.
3. Total turnover for the entire period must be at least 15,000 ILS.

These criteria allow the credit company to assess the business’s payment activity and reduce chargeback risks — situations where the business receives a payout for a significant amount, and the cardholder later claims that the charge was unauthorized.

Activation

The service is activated in <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Payment modules</span> ➙ <span class="u-richtext-element">Installments upfront</span>

After the activation request, we will send the documents for signature. Once approved by the credit company, the module will be enabled. The review usually takes 5–7 business days.

All installment payments received after the service is approved will automatically be processed using the full-amount crediting mechanism.

The service does not apply retroactively, meaning it does not apply to payments made before it was activated.

Deactivation

You can deactivate the module in the same modules section. Deactivation takes 5–7 business days. After deactivation, you will receive an email notification.

The module can be reactivated only after 30 days.

<span id="fee">Fee</span>

The credit company charges an additional fee for accelerated crediting. The fee amount and calculation method are shown on the plan page.

The <span class="u-richtext-element">Customer pays the fee</span> toggle is available in the module settings. When enabled, customers who choose two or more installments will see the additional fee on the payment page. This fee is added to the original payment amount and charged to the customer.

The fee is calculated using the gross-up formula. This means that the fee is calculated based on the final amount, which includes both the original payment amount and the fee itself. The fee cannot simply be calculated based on the original amount and added on top, because increasing the total amount also changes the fee amount.

The gross-up formula determines the final amount to be charged so that, after the fee is deducted, the business receives exactly the original payment amount:

Final amount = original amount ÷ (1 − fee rate)

Customer fee = final amount − original amount

Subscriptions are recurring charges from the customer’s card without the need to re-enter card details. In Hebrew, this is called "Oraat Keva", which literally means "standing instruction".

Activate the subscriptions module in the <span class="u-richtext-element">Settings</span> → <span class="u-richtext-element">Modules</span> section.

Creating a subscription

<span class="u-richtext-counter">1</span> When creating a payment link, clock "More" button to expand settings section and change payment type to “Subscription”.

<span class="u-richtext-counter">2</span> Specify when the subscription should start and end, then click the “Create Link” button.

<span class="u-richtext-counter">3</span> Once the customer subscribes using this link, the subscription will appear on the main screen under the “Subs” (Subscriptions) menu.

Subscription start options

Immediately — the first charge will occur at the moment the subscription is created, and then recur on the same day each month.

‍In N days — the first charge will occur after the specified number of days from the subscription start date, and then continue monthly on that same day.“Date” — the first charge will occur on the selected date. If the selected date is in the past, the subscription cannot be created.

‍Day of month — the first charge will occur on the specified day of the month and repeat monthly on that same day. If the selected day matches the subscription start date, the charge will happen immediately. If the 30th or 31st is selected but the month doesn’t have that date, the charge will occur on the last day of the month (e.g., February 28th).

Date — the first charge will occur on the selected date. If the selected date is in the past, the subscription cannot be created.

If the first charge is deferred, the card is not validated when the subscription is created because no authorization request is sent to the issuing bank. As a result, a subscription may be created with incorrect card details, and the error will only be detected when the first charge is attempted. To validate the card immediately, select the “Immediately” option.

Subscription end options

No end date — charges will continue until the subscription is manually canceled in the dashboard.

Date — charges will continue until the selected date. For example, if the end date is set to August 15, 2030, and charges occur on the 16th of each month, the last charge will take place on July 15, 2030, and there will be no charge in August.

After N charges — the subscription will end after the specified number of charges. For example, to create a one-year subscription, set it to 12.

Subscription statuses

<span class="u-richtext-element" style="background-color: rgba(68, 203, 138, 0.5)">Active</span> — charges are being processed successfully.

<span class="u-richtext-element" style="background-color: rgba(113, 124, 144, 0.2)">Completed</span> — all scheduled charges have been successfully processed.

<span class="u-richtext-element" style="background-color: rgba(242, 201, 76, 0.8)">Cancelled</span> — you manually cancelled the subscription charges.

<span class="u-richtext-element" style="background-color: rgba(221, 94, 94, 0.4)">Failed</span> — a charge attempt failed; the system will make up to 6 more retry attempts.

Tracking subscriptions

Charges from subscriptions appear in two sections:

1. On the main payments screen, alongside other payments;
2. In the “Subs” section, where you can view the full charge schedule for each subscription.

Notifications about subscription charges are sent by email and Telegram — just like regular payments — if the notification option is enabled in <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Notifications</span>.

Cancelling a subscription

In the settings of the desired subscription, select “Cancel subscription”. The customer will receive an email notification that their subscription has been cancelled.

It is not possible to resume charges on a cancelled subscription. The customer will need to re-subscribe.

Failed charge

A scheduled subscription charge may fail if the card has insufficient funds, the credit limit is exceeded, the card has expired, or it has been cancelled.

If a charge fails, the system will automatically make up to 6 more attempts — one per day. If all attempts fail, the subscription will remain in “Failed” status, and the charge history will include a note: “Subscription stopped”.

In the subscription management menu, a “Retry charge” option will appear, allowing you to manually initiate a new charge. Before retrying, we recommend checking with the customer to make sure their card is working properly.

If, when setting up a subscription with the first charge set to “Immediately”, the first charge attempt fails, for example because the card has insufficient funds, the subscription will still be created with the “Failed” status. The system will then automatically schedule a retry attempt.

Subscriptions vs installments

Since installment payments work only with Israeli credit cards, some businesses use subscriptions to collect payments from international customers in multiple parts.

It’s important to understand the difference: With installments you are guaranteed to receive the full amount — even if the customer’s card has insufficient balance on future dates. With subscriptions, each charge is a separate transaction, and if the card has no funds at the time of billing, the charge will fail.

Life hack: a one-time charge on a future date

A subscription can be used not only for recurring payments but also for a one-time charge scheduled for a future date.

When creating the subscription, select “Date” or “In N days” and specify when the first charge should occur. In the subscription end settings, select “After N charges” and set the value to 1.

The customer enters their card details immediately, but the actual charge is made on the selected date or after the specified number of days. Once this single payment has been completed, the subscription ends automatically, so there is no need to cancel it manually.

This is useful for pre-orders, reservations, or deferred payment for services: you secure the customer and their payment method now and process the payment when needed.

All standard subscription mechanisms still apply: the customer receives a notification when the subscription is created, and if the charge fails on the scheduled date, the system makes six additional attempts—one per day.

A token is an encrypted representation of a customer’s payment card stored in the payment system. The customer enters their card details once, after which they are saved as a token.

Your system can then use this token to process future charges without requiring the customer to enter their card details again. The amount of each charge may vary.

For SaaS services, Allpay’s token API endpoints provide more flexible billing management than the Subscriptions API. Once a card token has been obtained, your system can submit it via the API for each new payment while independently determining the amount, date, and conditions of the charge. This allows you to change pricing plans and implement custom recurring payment scenarios that match your product’s business model.

Therefore, we recommend using the token API endpoints when building billing for SaaS products.

The recommendations below will help you create a simple and intuitive billing management interface.

Consent to future charges

Before the card is saved, the customer must understand the terms of future charges.

Show the price, payment frequency, date of the first charge, and subscription cancellation terms. If the amount may vary, explain how it is calculated.

The customer must explicitly consent to future automatic charges.

Automatic payment retries

If a payment fails, for example due to insufficient funds, set up automatic retry attempts.

We recommend making 5–7 attempts and gradually increasing the interval between them.

Notify the customer about the failed payment and allow them to add funds or update their card before the next attempt.

Manual payment retry

Add a “Retry payment” button so the customer can initiate another charge after resolving the issue.

The button should remain available until the payment is completed successfully or canceled.

Card management

Allow the customer to add a new card, select a primary card, and delete a saved card.

Display only the card brand and the last four digits in the interface.

Attempt to charge the primary card first. If the payment fails, try the backup card. This reduces the risk of service interruption.

Transaction history

Show all successful and failed charges, as well as refunds, in the transaction history.

For each transaction, display the amount, date, and status. For a refund, also show the related original transaction.

Easy subscription cancellation

The subscription cancellation button should be clearly visible and easy to access.

Stop all future charges after cancellation. Do not automatically delete the saved card unless the customer requests it. Provide a separate option to delete the card.

Clear plan information

Show the customer:

• plan name;
• subscription price;
• taxes and fees;
• payment frequency;
• date of the next charge;
• total amount.

The customer should understand what they are paying for, how much they will be charged, and when.

Notifications

Notify the customer about important events:

• an upcoming charge if the amount has changed;
• a successful renewal;
• a failed payment;
• a price change;
• a refund;
• subscription cancellation.

Notifications can be sent by email or through other available channels and can also be displayed in the interface.

Weekly (accelerated) payouts let you receive money more often than with the standard once-a-month schedule.

How it works

After a customer makes a payment, it is processed within 3–7 business days. Immediately after processing, the payment is added to your payout balance and becomes available for transfer to your bank account.

Every Monday, an automatic payout of available funds is executed. As a rule, the money appears in your bank account within three business days.

If needed, you can request a payout manually without waiting for Monday.

Examples

• A payment made on Sunday and processed on Thursday will be included in the payout on the nearest Monday.
• A payment made on Friday and processed on Tuesday will skip the Monday that fell within the processing period and will be paid the next Monday, unless you request the payout earlier manually.

Requirements

Before enabling the module, three conditions must be met:

1. Business owner must be at least 21 years old.
2. Using Allpay for at least three months.
3. Total turnover of at least 15,000 ILS during that time.

These criteria help assess your business’s payment activity and reduce chargeback risks — situations where a business receives a large payout and the cardholder reports an unauthorized charge.

The module applies only to payments received after it is activated (it is not retroactive).

Activation

The module is enabled in <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Payment modules</span> ➙ <span class="u-richtext-element">Weekly payouts</span>

After you request activation, we will send documents for signature. Once the acquiring institution approves them, the module will be turned on. The review usually takes 5–7 business days.

After approval, payouts will automatically switch from monthly to weekly.

Deactivation

You can deactivate the module in the same section. Deactivation takes 5-7 business days. After that you will receive e-mail notification.

Reactivation is only possible after 30 days.

Fees

Since weekly payouts are considered accelerated, the credit company charges an additional fee on each payment. The fee amount and the calculation method are shown on the pricing page.

The fee is charged even if you temporarily use the manual payout mode, because the accelerated processing has already been completed and the payment is available for payout.

To stop paying the additional fee and return to the standard monthly schedule, disable the weekly payouts module. The new terms apply only to payments made after the module is disabled.

Notifications and documents

Payout notifications are sent by e-mail and in Telegram if these options are enabled in <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Notifications.</span>

On the 11th day of each month, the payout history shows a monthly payment breakdown and a fee receipt, which can be used for accounting.

To allow customers to choose the quantity on the checkout 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">Manage quantity</span> option.

After that, when creating a payment link, you can set the minimum and maximum number of units a customer can select, as well as the total quantity available for all customers when paying via this link.

If the minimum number of units is set to 0 (zero), the customer will be able to exclude this item from the payment.

The remaining quantity is shown on the payment link tile. When the stock is depleted (equals zero), the payment link is automatically disabled.

If the total quantity is not set (that is, the customer can select any quantity without limits), an infinity symbol is displayed on the payment link.

Simultaneous purchase of the last item

When multiple customers try to purchase the last remaining items at the same time, the purchase will be successful for the customer who completes the payment first.

For example, if 5 units are left in stock and customer A tries to buy all 5, while at the same time customer B buys 2 units and completes the payment first, customer A will see a message that only 3 units are available.

In the details of a declined payment, you can view the error message and determine the reason for the decline.

Error codes

Refusal by credit company. Please try a different card (20004)

‍The payment was declined by the card-issuing bank. For Israeli cards, this is most commonly caused by exceeding the credit limit (misgeret) or insufficient funds when using a debit card. For international cards, the bank may have declined the payment because it considered the transaction suspicious. In either case, the cardholder should contact their bank to determine the exact reason for the decline.

Payment is not approved for debit cards (20010)

‍An installment payment was attempted using a debit card. Installment payments are only supported for credit cards issued in Israel. Learn more.

Verification failed, please try again (21017)

‍The cardholder did not complete 3DS verification: they did not enter the SMS code, approve the payment in their banking app, or complete verification using another method provided by their bank.

‍

1. Open this link in Safari: Allpay App
2. Go to your browser's menu and select Share and then Add to Home screen.
3. Save it.