source: main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/payments/README-paypal.rst @ 12027

Last change on this file since 12027 was 12019, checked in by uli, 10 years ago

Give hints to get people started with paypal.

File size: 1.9 KB
Line 
1Support for PayPal(tm) Payments
2*******************************
3
4Ikoba generally supports paying things via PayPal. For this, we use
5the REST-API provided by PayPal.
6
7To make that work, you have to (1) obtain app credentials from PayPal
8and (2) make that credentials known to ikoba.
9
10
11Getting Credentials from PayPal
12+++++++++++++++++++++++++++++++
13
141) Create a general PayPal account
15
16   Browse https://www.paypal.com and create a new account. If you plan
17   to provide services or goods payed via PayPal. you should of course
18   create a business account. You can, however, start with a personal
19   account as it is upgradeable at a later point in time.
20
21   For only testing ikoba PayPal support, a personal account is
22   sufficient.
23
242) Register as a developer at PayPal
25
26   Go to https://developer.paypal.com and log in with the credentials
27   obtained in step 1. This will create some fake users/merchants for
28   you, which are *not* suitable for use with the PayPal REST API.
29
303) Create a REST-API compatible application
31
32   After logging in on https://developer.paypal.com/ go to the
33   dashboard and create a new app by clicking the respective button.
34
35Afterwards, in the developer dashboard under "My apps" you can find
36your new set of client IDs and secrets for both, sandbox and live use.
37
38
39Setting PayPal Client ID, secret, etc.
40++++++++++++++++++++++++++++++++++++++
41
42To make the credentials known to Ikoba, put them into configuration
43files like this::
44
45  # paypal.conf
46
47  [rest-client]
48  id = <YOUR-VERY-OWN-PAYPAL-REST-CLIENT-ID>
49  secret = <YOUR-VERY-OWN-PAYPAL-REST-CLIENT-SECRET>
50  # valid values: sandbox, live
51  mode = sandbox
52
53Out of the box, we expect these files to be in the following _two_
54locations:
55
56  path/to/ikoba/install/etc/paypal.conf
57  path/to/ikoba/install/etc/paypal-testing.conf
58
59Obviously, the second file is used for (automated) testing. As these
60credentials are bound to persons/companies/organisations, we do not
61share them via version control.
Note: See TracBrowser for help on using the repository browser.