Pay Methods

❗️

Prerequisites Required

Before using the ApplePay, GooglePay, or Bit methods, make sure the corresponding payment method is enabled in your iCredit management portal.

See Prerequisites ↓

Pay

The Pay method is similar to ChargeSimple . It allows the customer to pay using Credit Card information or a digital wallet such as Google Pay, Apple Pay, or Bit.

🚧

This method works only with Rivhit and POS CreditBoxToken.

For other CreditBoxToken Types, use ApplePayPayment , GooglePayPayment, or BitPayment instead.

The Pay method processes a charge and returns a response.

The url included in the response must be displayed to the customer in your application so they can select their payment method and complete the transaction.

Additional details are later provided through the IPN.

Mandatory Request Parameters

1. CreditBoxToken - The specific terminal identifier associated with the merchant’s payment provider.
2. Amount - The transaction amount to be charged.

Additional Important Parameters

• CreateToken - Set to true if you want to save a credit card token for future charges (requires tokenization).
• IPNURL - The callback URL for receiving IPN/Webhook updates (token, auth number, etc.).
• ParamJ - Defines the transaction type:
  • 0 – Direct charge
  • 2 – Credit card check + create token
  • 5 – Pending transaction
• PreventDuplicates - Indicates whether to prevent duplicate transactions.

Method Response

The method response includes:

• url - The payment URL where the customer selects the payment method and completes the transaction.

IPN Response Contains

• [Amount] - The transaction amount sent in the original request.
• [SaleId] - The sale identifier.
• [TrasactionToken] - The card token that can be used for future transactions.
• [CustomerTransactionId] - The transaction identifier.
• [PaymentMethod] - The payment method used (Apple Pay, Google Pay, etc.).
• [TransactionParamJ] - The transaction type sent in the request.
• [TransactionAuthNum] - The approval number returned by Shva.

Prerequisites

1. Log in to the iCredit Management Portal.
2. Navigate to:

Settings → Edit User Details → Interface Settings

(הגדרות -> עריכת פרטי משתמש -> הגדרות ממשקים).

3. Enable the required payment methods: ApplePay, GooglePay, Bit.
4. These must be enabled before using the methods through the API.

Direct ApplePay and GooglePay Methods

These methods work similarly to the Pay method.
However, instead of presenting a payment selection screen, they initiate the payment directly using ApplePay or GooglePay.

• ApplePay - Available only for customers using Apple-compatible devices.
• GooglePay - Available for customers whose device supports Google Pay.