Shva

Shva has some special integration requirements. Follow the standard PaymentsOS integration procedure, and then apply the relevant extra specifications described below.

Specifications for Card-based Transactions

The following table lists the integration specifications for Shva.

SpecificationsDetails
Minimum PaymentsOS API Version1.1.0
Requests
  • Authorize
  • Capture (including partial)
  • Charge
  • Credit
  • Refund (including multiple)
  • Void. Void after capture on the same day is supported (before the nightly batch).
CurrenciesILS, USD, EUR, GBP, AUD, CAD, CHF, DKK, EGP, JOD, NOK, SEK
Payment Methods
  • AMEX
  • DINERS
  • Isracard
  • JCB
  • MAESTRO
  • MASTERCARD
  • PL (local cards, for example, a gift card from Leumicard or Isracard.
  • VISA
3DS RedirectionNot supported

Configurations

The following table lists the configurations that are specific to Shva.

ConfigurationRequired/Optional
In the PaymentsOS Control Center create a provider configuration. We will create the necessary Shva terminals for you and connect them to your PaymentsOS account, so that Shva can process your payment requests. We'll need some input from your side. See Creating a Provider Configuration below. Required
In the PaymentsOS Control Center, register webhooks to be notified when a transaction changes its status.

Note: Many of your API requests will remain in a pending status until the nightly batch, and some may remain in that status for some time after that.
Required
In the PaymentsOS Control Center create a business unit (in the live environment). Use the provider configuration that we created for you as the default provider.Required

Sample Requests

Use the bodybuilder to create a sample request body for each request type.

Considerations when Creating a Charge

The status of "completed" Charge requests will change from pending to succeed, only after Shva's nightly transaction batch has been processed.

Considerations when Creating a Capture

Consider the items listed below when creating a Capture.

Status Changes

The status of "completed" Capture requests will change from pending to succeed, only after Shva's nightly transaction batch has been processed.

Sending a Capture Request with an Amount that Differs from the Authorization Amount

Note

This option is not supported when using installments.

Your business may require that you authorize a transaction without knowing the transaction amount in advance. In this case, add preauthorization_hold with a value of true to the provider_specific_data in your create Authorization request. This will invoke a request for approval pending the final transaction amount. Using this option requires approval of the acquirers you work with.

Here's an example of a request in which the preauthorization_hold parameter is passed:

"provider_specific_data": {
  "shva": {
      "additional_details": {
        "preauthorization_hold": "true"
      }
    }
}

Note

You can still capture an amount that differs from the original authorization amount, without passing in the preauthorization_hold parameter. Beware that this is not officially supported, however, and may cause unexpected results.

Considerations when Creating a Refund

Consider the following when creating a Refund:

  • To refund the customer for the full amount when the payment was made in installments, pass in the full amount in the refund request. The customer will be refunded for the payments already made and the remaining installment payments will be cancelled.
  • In case of a partial refund when the payment was made in installments, you can refund the customer for the required amount without cancelling the remaining installment payments. If you want to cancel the remaining payments, you need to contact the relevant card company and request that all remaining installments are cancelled.
  • Optionally, you can also pass the addendum and addendumsettl fields (as described in the Authorization or Charge request) in a Refund request as well. If you omit these fields in the Refund request, then PaymentsOS will take these fields from the Authorization or Charge request (if provided).
  • The status of "completed" Refund requests will change from pending to succeed, only after Shva's nightly transaction batch has been processed.

Considerations when Creating a Void

Consider the items listed below when creating a Void.

Passing the addendum and addendumsettl Fields

Optionally, you can pass the addendum and addendumsettl fields (as described in an Authorization or Charge request) in a Void request as well. If you omit these fields in the Void request, then PaymentsOS will take these fields from the Authorization or Charge request (if provided).

Configuration and Integration Procedures

This section details the configuration steps that are specific to Shva.

Creating a Provider Configuration

We will create the necessary Shva terminals for you, and connect them to your PaymentsOS account, so that Shva can process your payment requests. We'll need some input from your side.

Follow these steps:

  1. Register with at least one of the local acquirers (Isracard, Cal, or Leumi Card).

  2. Contact PaymentsOS support support@zooz.com, to request the "Form for opening business terminals in the Shva credit card system". Fill in the form and return it to us. The form includes your company details, as well as at least one of your "merchant numbers", registered with one of the local acquirers, etc.

  3. We'll create a provider configuration in your PaymentsOS account, in the PaymentsOS live environment.

Note

Please do not change or delete the Shva provider configurations that we create for you.

results matching ""

    No results matching ""