Help Center

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.

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

How to Use

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

Demo

В свойствах отклоненных платежей можно увидеть название ошибки и понять причину.

Коды ошибок

20004 Refusal by credit company. Please try a different card

Платёж не был одобрен банком, выпустившим карту. Для израильских карт это чаще всего связано с превышением кредитного лимита (мисгерет) или недостатком средств на счёте при оплате дебетовой картой. Для иностранных карт банк мог отклонить платёж, сочтя его подозрительным. В обоих случаях держателю карты следует обратиться в свой банк, чтобы уточнить причину отказа.

20010 Payment is not approved for debit cards

Попытка осуществить платеж в рассрочку по дебетовой карте. Такие платежи возможны только по кредитным картам и только выпущенным в Израиле. Больше информации.

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 Tag

Each transaction processed via the API has an <span class="u-richtext-element">API</span> tag on it. By clicking on the tag, you can view headers and body of the associated request and response.

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

Since payments can come from outside Israel, as well as from tourists or Israeli residents without a Teudat Zehut, the payment page includes a checkbox labeled “I am not an Israeli citizen”, which hides the Teudat Zehut input field.

If the payment page is accessed from outside Israel, this checkbox is enabled by default.

Hiding the field for payment links

The Teudat Zehut input field and the “I am not an Israeli citizen” checkbox can be completely hidden from the payment page. This is useful for those accepting payments exclusively from abroad.

To enable this, go to <span class="u-richtext-element">Settings</span> --> <span class="u-richtext-element">Payment Links</span> and activate the switch <span class="u-richtext-element">Hide Teudat Zehut input field</span>.

Make sure to consult your accountant before enabling this setting.

Hiding 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.

‍

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

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. еее

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.

When designing a user account interface for managing tokens to charge a customer's card in line with your platform's pricing plan, it's essential to focus on user experience, transparency, and error handling.

Below are key recommendations to ensure an efficient and user-friendly interface:

Automate retries for failed charges

If a charge fails due to insufficient funds or other errors, automate the retry process to increase the likelihood of successful payment.

Recommended schedule: Attempt the charge up to 7 times, with a 1-day interval between each attempt.

If all attempts fail, terminate the rebilling process and notify the user.

Notify users about retries and allow them to top up their account or update their payment method before the next attempt.

Provide a manual retry option

Include a button that allows users to manually retry a failed payment.

This empowers users to resolve issues on their own after addressing payment failures (e.g., topping up their card).

Ensure the section with this button remains accessible, even during failed transactions.

Display refunds in transaction history

If a refund is processed, make sure it is clearly displayed in the transaction history.

Include details such as the refunded amount, reason for the refund, and the associated transaction.

It improves transparency and helps users easily track their financial activity.

Allow linking of multiple cards

Enable users to add a second card as a backup payment method.

Attempt to charge the primary card first. If it fails, automatically charge the backup card.

This reduces the likelihood of payment failures, ensuring uninterrupted service for the user.

Easy access to unsubscribe

Make the unsubscribe button visible and easy to find.

Do not automatically delete a user’s saved card unless explicitly requested. This allows users to easily return and reactivate their subscription without having to re-enter card details.

Clearly display plan and charge information

Provide detailed information about charges directly in the interface.

Show the base subscription cost, applicable taxes, fees, and any other components that make up the total charge.

This reduces confusion and prevents complaints by keeping the user fully informed.

Real-time notifications

Notify users via email or in-app messages for important events, such as failed charges, refunds, or subscription renewals.

To have the Bit payment button appear on your payment pages, activate the Bit module in the <span class="u-richtext-element">Settings</span> ➙ <span class="u-richtext-element">Modules</span> ➙ <span class="u-richtext-element">Bit</span> section.

Payment via Bit is only possible from a mobile device on which the Bit app is installed. When paying from a computer, the system will display a QR code for scanning and switching to payment from a mobile device.

Payments received through Bit are credited to the business's bank account along with the payout in the same way as other payments.

Bit button for foreign customers

Since Bit is an Israeli system, we make it possible to hide the Bit button for customers who pay from abroad. The system determines the client's geolocation by its IP.

The corresponding switch can be found in the module settings.

Restrictions

Up to 5000 ILS. Payment via Bit cannot exceed 5,000 shekels. The sum of all payments per month from all customers cannot exceed 20,000 shekels.

ILS. Bit only supports payments in shekels.

There are no installments. You can only pay with Bit in one payment.

There are no subscriptions. Bit does not allow you to save your customer card for future charges, so we hide the Bit button for “Subscription” payment links.

Ten minutes. From the moment you press the Bit button, the customer has 10 minutes to make a payment.

Diners. Diners and Discover brand cards are not supported by Bit.

Name and email

Bit does not give us the payer's name and e-mail address, so we request them ourselves when making a payment. The e-mail field is optional, and if it is not filled in by the customer, a payment confirmation will not be sent.

Integrations

For payment integrations from ours catalogue The Bit button will be shown on the payment page if the module is activated and hidden if not.

API

Software integration developers documentation<span class="u-richtext-element">, can control the display of the Bit button on the payment page by using the show_bit parameter.</span> However, the Bit module must first be activated through your Allpay account.

For test payments, use the real card attached to the Bit app. At the same time, don't forget to activate the test mode for payment integration.