Paysafe Hosted API Gateway WooCommerce

Paysafe Hosted API gateway supports Paysafe Hosted API. This documentation will include the installation and configuration of the plugin using the Hosted API.

  1. Upload the ‘woocommerce-gateway-netbanx‘ folder to the ‘/wp-content/plugins/‘ directory.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.
  3. Navigate to `WooCommerce > Settings > Payment Gateways > Paysafe` to configure the Paysafe Hosted API gateway settings.
  4. For alternative installation using the WordPress Admin panel | Click Here
  5. If you need help on how to upload and activate a WordPress plugin | Click Here.

First thing you need to do before you go on further is you make sure that for Paysafe API you select HOSTED, then save settings. This will ensure that you are configuring the plugin for the Hosted API.

If you are unsure where to find the API key, please contact your Paysafe representative for further help. We are going to show you how to obtain a credentials, but only on the test environment. The live environment should be identical to what we show you.

  1. Create and account or login to your https://developer.optimalpayments.com
  2. In My Account page, you will find the API Key.
  3. Copy the whole key and paste it in the API Key field in the plugin settings
  4. The API Key is in form of “Username:Passwordpaysafe-api-key

Setting up the gateway settings is very simple. There are barely 5 gateway specific settings to be set.

  1. Login to your store and navigate to WooCommerce > Settings > Checkout > Paysafe
  2. Set the Hosted API to be the API in use.
  3. Go through the next general settings and set the gateway name and description for the checkout page. Enable the plugin and choose, to test transactions or go live.
  4. By now you should have your API Key, so enter it in the API Key field. This field will look always empty, so don’t worry, if you just save something and it is still empty.
  5. paysafe-settingsChoose your Paysafe payment page language. You can pick from British English, US English, French and French Canadian.
  6. You can also sent order details to Paysafe with the order request. Enable it, if you want to see that.
  7. Synchronous responses are a bit tricky. If enabled, you orders will be processed right after the payment was processed, but Paysafe will not have time to retry any none responsive payment attempts. If disabled, Paysafe will have time to do its work on the background, but your orders will be processed with some delay. You can play with this feature to make sure you pick the option you want.
  8. The Customer ID Prefix is used to make sure that customer profiles will be unique for multiple stores using the same Paysafe account.paysafe-settings-cont-1
  9. iFrame Section:
    1. Here you can enable the presentation of the payment page to be in an iframe, directly on your site.
    2. You have three options: Height,Width and Scroll of the iframe. These should be set to match your prefered presentation. The scroll option will allow the iframe to be scrolled up and down.
  10. Debug mode: this is useful, when you have troubles with the gateway. It will give you essential data for troubleshooting and identifying problems.

In this section you will be able to reset your customers saved profiles. It is a nice option in case there are errors with the profiles. Resetting the profiles will essentially remove the saved profiles from your store and generate new profiles for the existing customers, on their next payment.

paysafe-reset-profiles

To reset the profiles all you need to do is:

  1. Check the “Show Reset Profiles” checkbox. When checked a “Reset Profiles” button will appear
  2. Click on the “Reset Profiles” button.
  • Paysafe API
    • Choose the Paysafe API you are goind to use.
  • Enable/Disable
    • Enable the gateway.
  • Sandbox
    • . Testing the plugin.
  • Method Title
    • This controls the title which the user sees during checkout.
  • Description
    • This controls the description which the user sees during checkout.
  • API Key
    • Enter the API Key given to you by Paysafe for API connection. The API Key field will always appear empty. Just enter the API Key, when you want to set it. Leave empty otherwise.
    • IMPORTANT: This option is required for the plugin to show on the checkout page
  • Payment Pages Language
    • Enable, if you want to send a breakdown of all order details (items, taxes, shipping costs) to Paysafe .
    • Disable, if you want to just send the Order Total for the customer to pay.
  • Synchronous responses
    • Enable, payment response will be made synchronously, in-line with the customer returning to your store.
    • Disable, payment responses will be made asynchronously, will be delayed a bit, allowing the callback system can detect problems with the merchant system and retry any failed attempts until a successful response is received.
    • Recommended from Paysafe: Disable.
  • Customer ID Prefix
    • Enter here a prefix for the customer ID send to Paysafe. Because the customer ID is required to be unique, we will enter a prefix for it, to make sure it will be. (Example: WC-)
  • Merchant Notification Email
    • Enter merchant email, to which the merchant will receive email notifications. If empty, the notification parameter will not be send.
  • Iframe Settings

  • Enable Iframe
    • Enable iframe to have the customer payment form display in an Iframe on your site. If disabled, your customers will be redirected to Paysafe payment page.
  • Iframe Width
    • Width of the iframe window. Enter only numbers in pixels (i.e. 700) or you can enter number in percentage but you need to suffix it with “%” (i.e. 55%).
  • Iframe Height
    • Height of the iframe window. Entered can be a number in pixels (i.e. 850) or you can enter number in percentage but you need to suffix it with “%” (i.e. 55%).
  • Iframe Scroll
    • Should the iframe be scrollable or not. If scrollable, the customer will be able to scroll to the iframe to reach its borders.
  • Debug Log
    • Debug log will provide you with most of the data and events generated by the payment process. File location will be something like wp-content/uploads/wc-logs/paysafe-787405d5cc82ed0263be5ad3ba3aae60.log

Please visit the plugin changelog page for more information.