Step 1: Register an account
Create your free payever account here, or login in case you already have one.
Step 2: Configure payment options
In order to configure your payment options, first open the Checkout app. To do this, either click on the Checkout symbol under Business Apps or click on the Manage or Open button on the Checkout section.
You can find the payment methods tab in the navigation bar on the left.
Then click on + Add.
Now a list of different payment methods appears, from which you can select as needed. To do this, click on install.
Once you have installed the payment channel, click on Open and a new page will open, the structure of which will vary depending on the payment method chosen.
With the payment methods credit card, direct debit and Paypal just click the Connect button and you will be forwarded to the respective payment provider. There you connect your existing account or create a new one.
For the payment methods Installments, invoice, Factoring and Direct Bank Transfer you have to enter the access data that you have received from Santander and then click on Connect (if you have not been in touch with Santander before, please contact support@payever.de).
Regardless of the payment method, please make sure that you always enter your access data in the Default tab.
After you have connected the payment methods, you can make changes to the settings of the specific payment method. Please refer to our documentation for the specific payment method for more information, which you can find here.
Step 3: Configure channels
Select the Channels tab in the Checkout App.
Click + Add.
Select OroCommerce from the list that now appears and click on Install.
Now you need to click Open so that you can generate the API keys in the next step.
Select API keys and click on + Add. Enter a name of your choice and click on Create. Afterwards, click on the plus icon (+) and you see the credentials that you have to insert into the shop system that you use for your online business (i.e., Client Id, Client secret, Business UUID). Please copy these to your clipboard.
Step 4: Install plugin
Log in to your OroCommerce account and get our free plugin here. A manual on how to install plugins to OroCommerce can be found here.
Step 5: Establish connection to payever
Go to System > Configuration and navigate to Integrations > payever.
In the plugin configuration menu, you can modify the following settings:
Payment settings:
- Client ID, Client Secret and Business UUID: Please enter the data that you generated in your payever account in step 3 (unless you are in sandbox mode, see next point).
- Mode: In order to submit real transactions, uncheck the "Use Default" box and select Live mode. If you are only testing for now and wish to establish a connection with our test environment, please leave the sandbox mode enabled, as well as the default Client ID, Client Secret and Business UUID. More information regarding testing can be found at the end of this article.
- Logging Level: Choose which events you want to be logged. We recommend "All messages", as a detailed logging will help our support team debug an issues you may experience.
- API version: If you are using our B2B payment solutions, please use v3. If you are not using our B2B services, you could use v2 as well.
B2B settings:
- Enable company search: This checkbox must be checked in order for you to be able to use our B2B invoice (by Allianz) solution. It will add a functionality to your checkout page that will automatically search and match the customer's company in our database (which is required in order to check if the company qualifies for payment via invoice).
- Enable credit line: Ticking this checkbox will add an additional upfront credit-line check in the background, before the customer reaches the payment option selection page. This feature allows us to only display the payment option invoice to companies that qualify for it (those who don't will not be shown the payment option and thusly can't select it). If this checkbox is disabled, any business customer will be shown the payment option, and those without sufficient credit line will get a decline message after selecting the payment option and clicking submit. Please noter that in order for you to use this feature, it needs to be enabled for you on Allianz' side, and additional fees from Allianz may apply.
- Countries: Select the country in which you're B2B clients are located.
- Company search type: Select your preferred method of displaying the company search (see first point). This can either be a dropdown unter the company name field, or it can be an overlay.
Once you have made all configurations, please click on the Save button in the settings and then click the Synchronize button (please do so in this exact order).
Step 6: edit payment methods
After you have synchronized the plugin, you can see the available payment options in the settings under System > Manage Integrations.
Here you can see at a glance which payment methods you have activated and can adapt the descriptions and names of the specific payment methods.
Testing the plugin: sandbox mode
Would you like to test the plugin first? Please activate the sandbox mode (sandbox = yes) and enter our test data in the fields Business UUID, Client Secret and Client ID, which you can find here. In sandbox mode, you are not connected to your own payever account, but to our general test account - that's why you now see all available payment methods here, not just those that you have activated in your payever account (please note that you will not see test transactions in your payever account). Also note that the test account only works on weekdays from 8 a.m. to 10 p.m., and hence you are unable to carry out test transaction in sandbox mode on weekends, late afternoons and early mornings.
To have a payment confirmed in test mode please use the relevant stub data which you can find here.
Now you can test the plugin without triggering a real transaction. We would like to ask you to test only in sandbox mode, as test transactions in Live mode, even if you subsequently cancel them immediately, can have undesirable consequences (for example, if you test too often with your credit card it may be reported and blocked or if you submit multiple installment loan applications in your name this may worsen your credit score, etc.).
When you're done testing and want to go live:
- Please do not forget to remove the test data and instead enter your own data from your payever account (see step 3), save and then synchronize (otherwise you will receive an error message when synchronizing). You cannot use your live data in sandbox mode, nor can you use our test data in live!
- Please also note that any settings made (plug-in settings, names and texts of the payment methods, etc.) are lost when switching between live and sandbox mode (regardless of the direction). With each change you reset these settings - so if you have configured everything in sandbox mode, are satisfied and therefore want to go live, please remember what you had set and repeat these settings again after going into live Mode and have synchronized.
After integration: information on processing payments
In general, our plugins are designed so that all actions available in the payever account can also be initiated from your OroCommerce backend. As a rule, you do not need to log into your payever account to find out about the status of a payment or to cancel a payment, for example!
Status Reports - the payment status Pending usually only occurs for Installment loans and the status means that the payment is not yet complete (customer still has to go through an identification process and/or submit necessary documents). If you see this status, please wait and do not ship the goods to your customer yet. The status Authorized means that the payment was successful and complete - in this case you are free to ship the goods to your customer. The status Cancelled means that the payment failed, was rejected or was canceled (for this status you shouldn't ship any goods to your customer either).
Capture / Shipping Goods - Please note that some of your payment options require capture, which is triggered by you reporting the order as shipped. To do so, please open the order details, scroll down to payment history and click following buttons:
Settlement - for B2B invoice (Allianz Trade Pay), please take note that you will need to click "settle" once you received the invoiced amount from the customer in your bank account, in order to let the insurer (Allianz) know that the invoice was paid and you are not claiming any replacement payout from their side. Please click settle as soon as you receive the money, but no later than 30 days after the order was placed, as we will consider the invoice as not paid/overdue and reach out to the customer if no settlement is received from you within this time. You can find the settle button under Sales > Orders > Payment History:
Cancellations and Refunds - If you would like to refund a transaction then please open the order details. Under payment history you can cancel the order here (with the second "x" you can cancel an order and add a note):
In order to make a refund to your customer, you can find the button Payever Refund at the top. When clicking it you can select what items you want to refund:
Please note, however, that not all of our payment methods have an automatic cancellation function: for example, B2B invoice (Allianz Trade Pay), Direct Bank Transfers and Direct Debits can only be reimbursed from your bank account via a transfer to the customer.
Any questions or problems?
Our support team is there to help you free of charge from Monday to Friday between 8 a.m. and 5 p.m. at support@payever.de.
Please let us know in your message which shop system and plugin version you are using, which shop (URL and/or email address which you are registered with us) your request concerns, and which error message / problem you are dealing with - so we can process your request as fast as possible.