better-payment / bp-plugin-shopware6-api2

Shopware 6 Plugin for Better Payment API2
Other
0 stars 0 forks source link

[Documentation] Merchant Manual #49

Closed gadimbaylisahil closed 1 year ago

gadimbaylisahil commented 1 year ago

Description

Provide a merchant manual just like Custom Web provides for Shopware 5.

gadimbaylisahil commented 1 year ago

@hasanzade-hasan @Obstobst @bp-rzahradka

This is a small table of contents for the merchant manual. Please, let's be short and clear in the documentation.

Account in Better Payment

Before installing the plugin, please make sure to have an account in Better Payment or any of its whitelabel partners. Please, also make sure that the payment methods you are going to use, is activated in the payment gateway.

Installation of the plugin

Talk about how to get the plugin and how to upload it to the website.

Configuration

Go through each configuration option and explain what it is and how it should be used. Also, mention to add necessary payment methods to the sales channels

Payment Methods

Include a section to each payment method. What they are and how they behave. For example, talk about mandate agreement for SEPA. Talk about payment instructions for Invoice and Invoice B2B etc...

Risk Cheks

Explain what risk checks are briefly and explain what our plugin does in regards to risk check config. Talk about gender and date of birth config and how they affect the checkout.

Supported Languages

Mention supported languages (DE, EN). Also mention that new ones can be added on request.

Webhooks

Mention that Better Payment has to connect to your shop to send notifications about payment statuses. Mention outboung IP address of the Better Payment API2 for both test and production environments. @bp-rzahradka can provide it.

Refunds

Talk briefly about refunds and how they work.

gadimbaylisahil commented 1 year ago

@hasanzade-hasan @Obstobst Include screenshots in the documentation where it makes sense, to have something more than text.

gadimbaylisahil commented 1 year ago

@hasanzade-hasan Provided a MVP merchant manual to @Obstobst, who should finish the polishing and distribution parts.

gadimbaylisahil commented 1 year ago

@Obstobst @bp-rzahradka

Closing this ticket as manual is completed by Steven and is in his possession. @Obstobst Please, share the manual here as PDF.