gunghogeoduck/osem-fcy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add email-invoice documentation.

Browse source 
correct language errors.
This commit is contained in:
Rishabh Saxena 2016-08-05 01:17:25 +05:30
parent f40caa8b24
commit 4509bf09bb
2 changed files with 33 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

37
PAYMENTS.md
View file

@ -1,5 +1,5 @@
# Integrate your Stripe account to accept your user's payments
All the information that you need to setup your Stripe account into OSEM.
Here you will find all the information that you need to setup your Stripe account into OSEM.
If you have any problems with installing don't hesitate to [contact us](https://github.com/openSUSE/osem#contact)
## Configure Stripe into the application
@ -8,21 +8,32 @@ To configure Stripe into your application all you need to do is add the private
Add your Stripe API keys in `config/secrets.yml` into these variables:
If you are using the application in development mode your config should look like this:
`STRIPE_PUBLISHABLE_KEY = 'pk_**test**_random123example456'`
`STRIPE_SECRET_KEY = 'sk_**test**_random123example456'`
`stripe_publishable_key = 'pk_**test**_random123example456'`
`stripe_secret_key = 'sk_**test**_random123example456'`
Otherwise, while in production mode, it should look like:
`STRIPE_PUBLISHABLE_KEY = 'pk_**live**_random123example456'`
`STRIPE_SECRET_KEY = 'sk_**live**_random123example456'`
`stripe_publishable_key = 'pk_**live**_random123example456'`
`stripe_secret_key = 'sk_**live**_random123example456'`
## Configure image for your iFrame payment form
The stripe payment form uses an image of your organisation to display a personalised iFrame form for your application.
by default, the application comes with a SUSE icon, but, you can display the image of your organisation in place of that
by putting the link of your organisation's image in your corresponding `.env` file as follows:
### PCI Self Assessment Questionnaire(SAQ)
> As long as you serve your payment pages over TLS, and use either Checkout or Stripe.js
> as the only way of handling card information, Stripe automatically creates a prefilled SAQ A questionnaire for you,
> and you won’t need to undergo a PCI audit. If card data is stored or transferred through your servers,
> you are responsible for following PCI DSS guidelines for handling card data, and periodic audits by a PCI-certified auditor.
As we are using Stripe Checkout for accepting payments, Stripe will help you for filling SAQ for your application.
You can read the full security documentation [here](https://stripe.com/docs/security).
## Configure the image for your payment form
The Stripe payment form uses an image of your organisation to display a personalised form for your application.
By default, the application comes with a openSUSE icon, but you can display the image of your organisation in place of that
by putting the URL of your organisation's image in your corresponding `.env` file as follows:
`OSEM_ICON = 'your organisation's sharable image link'`
## Configure Stripe to send custom emails for your organisation
Stripe sends email reciepts for every successful payment done through its gateway.
You can also customise your payment reciepts by adding your personalisation like organisation name, logo etc.
## Configure Stripe to send emails for successful transactions
Stripe can send email reciepts for every successful payment done through its gateway.
Please refer [here](https://dashboard.stripe.com/account/emails) to enable invoice emails for your users.
You can see the options for personalisation [here](https://dashboard.stripe.com/account/public).
## Customize Stripe invoice emails for your application
You can customise your payment reciepts by adding your personalisation like organisation name, logo etc.
Please see the options for invoice personalisation [here](https://dashboard.stripe.com/account/public).