Evergreen can interface with services like Authorize.net, Stripe, PayPal, or Payflow to allow users to pay fines and other charges in the Public Catalog. Credit card settings can be configured in the xref:admin:librarysettings.adoc[Library Settings Editor].
-As of 3.6 Stripe in Evergreen is using version 3 of the Stripe client library and the Elements API.
-
== Setting up credit card payments ==
Credit card payments are controlled in the library settings. These settings are protected by two permissions. In order to view the
be adjusted according to the test payment.
Your credit card provider should be able to provide test credit card numbers for your testing purposes.
+
+[[stripe_settings]]
+== Stripe Settings ==
+
+As of 3.6 Stripe in Evergreen is using version 3 of the Stripe client library and the Elements API. As of 3.8, Stripe in Evergreen is using the Payment Intents API.
+
+There are several Library Settings related to Stripe. As with other payment processor settings, setting or changing these requires the `ADMIN_CREDIT_CARD_PROCESSING` permission and viewing these settings requires the `VIEW_CREDIT_CARD_PROCESSING` permission.
+
+Settings are checked relative to the patron’s home library.
+
+* **Allow credit card payments** - this must be set to TRUE in order for any payment processors to be used
+* **Name default credit processor** - this setting designates which payment processor to use, and should be entered as Stripe
+* **Enable Stripe payments** - set to TRUE in order to allow Stripe to process payments
+* **Stripe ISO 4217 currency code** - this must be entered in lower case and will default to **usd** if unset. Stripe supports a subset of ISO 4217: https://stripe.com/docs/currencies. This setting is new in 3.8.
+* **Stripe publishable key** - this value is provided by Stripe when you set up an account with them. It must be entered precisely as given or payment processing will not work.
+* **Stripe secret key** - this value is provided by Stripe when you set up an account with them. It must be entered precisely as given or payment processing will not work.
+
+If you wish to test your Stripe setup, there are test cards and responses available from Stripe:
+
+* https://stripe.com/docs/testing
+
+Additional documentation from Stripe related to the Payment Intents API can be seen on these pages:
+
+* https://stripe.com/docs/api/payment_intents
+* https://stripe.com/docs/payments/payment-intents
\ No newline at end of file
before using this feature.
====================
+[[myaccount_payments]]
+== Making Payments in MyAccount ==
+
+[NOTE]
+====================
+The below instructions are specific to libraries using Stripe with Evergreen 3.8 or higher.
+====================
+
+If a patron has bills on their account and their library permits online payments, the patron will be given options to pay all or selected bills via MyAccount.
+
+After logging in to MyAccount, the patron should select the **Charges** menu item, and then select **Current Charges**.
+
+image::media/opac_current_charges.png[MyAccount Current Charges]
+
+Next, they should (optionally) select the charges they wish to pay and then select either **Pay Selected Charges** or **Pay All Charges**.
+
+image::media/opac_select_charges.png[Select Charges]
+
+They will be prompted to enter their credit card information on the next screen. The patron should enter their credit card information and select **Submit Payment**. There is no confirmation step. Note that credit card information is not masked, so patrons should take care if they are in a public place.
+
+image::media/opac_cc_entry.png[Credit Card Entry]
+
+There will be a processing message displayed while the payment is processed.
+
+image::media/opac_cc_inprocess.png[Credit Card Processing]
+
+Lastly, the patron will receive a confirmation and an option to print a receipt.
+
+image::media/opac_cc_receipt.png[Credit Card Receipt]
+
+Receipts can also be printed or emailed by navigating to **Charges → Payment History** and selecting the relevant print or email option from the Payment History grid. Receipts can be configured in the xref:admin:actiontriggers.adoc[Notifications and Action Triggers] interface.
+
+=== Error Messages ===
+
+If a credit card is declined, the patron will be given a declined message when they attempt to submit payment information.
+
+image::media/opac_cc_declined.png[Credit Card Declined]
+
+Stripe supports sending various types of error messages, including messages for an expired card, invalid CVV code, incorrect zip code, and more.
+
+If there is an error in Evergreen’s Stripe configuration, the patron will be presented with an error message when they attempt to initiate a payment. This will be displayed at the point when a patron selects either the **Pay Selected Charges** or **Pay All Charges** button, before the payment form is rendered.
+
+image::media/opac_cc_config_error.png[Configuration Error Message]
\ No newline at end of file
projects / evergreen-equinox.git / commitdiff
