Revolut Gateway

Configuration manual

Installation

The plugin can easily be installed via the Shopware Plugin Manager in Extensions->My extensions

How to start

To start accepting payments, you'll need to follow four simple steps:

• Sign up for Revolut Business if you don't have an account already: https://business.revolut.com/signup
• Once your Revolut Business account has been approved, apply for a Merchant Account: https://business.revolut.com/merchant
• Get your Production API Secret Key and paste it in the section "Production Merchant API": https://business.revolut.com/settings/merchant-api - if this is your first time on this page, you will need to click the Generate button to create your unique API keys
• Click the button "Get Public API Key" (or copy it from Revolut and paste into the field "Api Public Key")

How to test

To create sandbox account, you'll need to follow three simple steps:

• Sign up for Revolut Sandbox Account: https://sandbox-business.revolut.com/signup
• Get your Sandbox API Secret Key and paste it in the section "Sandbox Merchant API": https://sandbox-business.revolut.com/settings/merchant-api - if this is your first time on this page, you will need to click the Generate button to create your unique API keys
• Click the button "Get Public API Key" (or copy it from Revolut and paste into the field "Api Public Key")

To test your various payment flows for a variety of scenarios, you can use the test card numbers which are available here: https://developer.revolut.com/docs/guides/accept-payments/get-started/test-in-the-sandbox-environment/test-cards

IMPORTANT NOTE! When Sandbox Mode is active, you can only make test payments via "Revolut Card" or "Revolut Pay". Unfortunately, Revolut currently doesn't provide the possibility to make a test payments via "Apple Pay / Google Pay".

How to make a refund

• Go to the plugin configuration and make sure that the option "Refund allowed" is enabled in the section "General Settings"
• Go to the details of the selected order where in the tab "General" you will see the section "Revolut Order Information" if the order was paid using Revolut
  
• Click the button "Open Refund Manager" (please note that you can initiate a refund for Revolut's order only when it is in the COMPLETED state, in otherwise this button is not displayed)
  
• In the popup window, enter the refund amount and, if necessary, complete the description field
  
• Click the button "Refund"

Configuration

After installing the plugin, 3 new payment methods will be automatically added and activated:

• Revolut Card
• Revolut Pay
• Revolut Apple Pay / Google Pay

To customize the plugin settings, click the context menu button to go to its configuration. Below you will find a description of the most important features.

• General Settings

  • Refund allowed - when the option is active, it's possible to make refunds directly from the order by using Refund Manager
  • Sandbox Mode - use the testing (sandbox) gateway server to process transactions
  • Capture mode:
    • Automatic - the order is captured automatically after payment authorisation
    • Manual - the order is not captured automatically. You must manually capture the order later
    • Shipped - when the order delivery status reach the status "shipped", the plugin will send a request to Revolut to capture the payment
  • Cookie mode:
    • Display Revolut cookies in the group "Technically required" - after selecting this option, it will be possible to pay via Revolut without accepting its cookies
    • Display Revolut cookies in the new group "Payments" - the ability to pay via Revolut will be blocked until the customer accepts Revolut cookies
    • Don't display Revolut cookies - after selecting this option, it will be possible to pay via Revolut without accepting its cookies. Revolut cookies will not be displayed in "Cookie preferences". Option not recommended if you have a store in a country where GDPR regulations are applicable

• Debug Mode

  • Active - active debug mode to create the custom logs in the Shopware log directory. This feature can be useful to solve problems
  • Keep log files (in days) - set the number of days to keep the log files in the Shopware log directory

• Automation | Order State → Revolut State

  • Automatic cancellation - active this option to automatically cancel an order in Revolut. This means that once the order status reach the status "cancel", the plugin will send a request to Revolut to cancel an existing uncaptured order
  • Automatic refundation - active this option to automatically issue a refund in Revolut. This means that once the order status reach the status "cancel", the plugin will send a request to Revolut to issue a refund for a completed order

• Automation | Payment State → Revolut State

  • Automatic cancellation - active this option to automatically cancel an order in Revolut. This means that once the payment status reach the status "cancel", the plugin will send a request to Revolut to cancel an existing uncaptured order
  • Automatic refundation - active this option to automatically issue a refund in Revolut. This means that once the payment status reach the status "refund", the plugin will send a request to Revolut to issue a refund for a completed order

• Automation | Revolut State → Order State

  • Order state with a completed transaction - select the order state that will be set once the transaction status reach the status "completed"
  • Order state with an authorised transaction - select the order state that will be set once the transaction status reach the status "authorised"
  • Order state with a failed transaction - select the order state that will be set once the transaction status reach the status "failed"
    
  • Order state with a cancelled transaction - select the order state that will be set once the transaction status reach the status "cancel"
    
  • Order state with a pending transaction - select the order state that will be set once the transaction status reach the status "pending"
    
  • Order state with a processing transaction - select the order state that will be set once the transaction status reach the status "process"
    
  • Order state with a refunded transaction - select the order state that will be set once the transaction status reach the status "refund"