eCommerce

 

eCommerce

With these settings, you can:

  • Set up fine payments within the user account
  • Link out to an external payment site within the user account

  

Aspen Discovery has integration with the following vendors for eCommerce:
  • Certified Payments By Deluxe
  • Comprise
  • FIS WorldPay
  • InvoiceCloud
  • PayPal
  • Xpress-pay

If you do not see your payment processor and you currently accept payments through your ILS, you can also choose to link out to your current ILS payment processing page. This link will still appear within the user account.

  

Note: eCommerce integrations are not currently available for Evolve.

  

How do I set up fine payments in Aspen?

How do I set up fine payments in Aspen?

  

If using a vendor Aspen directly integrates with:

  1. Select your vendor in Aspen Administration > eCommerce and fill in the required credentials. Read the section(s) on this page applicable to your payment vendor for more information.
  2. Finish setup in Aspen Administration > Primary Configuration > Library Systems >  Fines/e-Commerce to configure payment settings. To learn more, head to the "Fines/eCommerce Setup in Library Systems" section on this page.

 

If using a vendor Aspen does not directly integrate with:

  1. You have the option to link out to the external payment site. This will take users outside of Aspen to pay their fines and fees.
  2. Navigate to Aspen Administration > Primary Configuration > Library Systems >  Fines/e-Commerce to configure payment settings.
  3. Under Show E-Commerce Link, select "Link to ILS."
  4. Under Pay Fines Link, enter the URL where users should be directed to pay their fines.

 

Updated 2023/01/26 - md bws

Managing Payments in a Consortium

For consortiums, Aspen can support different payment options per library system. These can be set up in Aspen Administration > Primary Configuration > Library Systems > click into the system to edit > Fines/e-commerce.

Another thing to consider when setting up multiple accounts is which library receives the payment if a patron uses multiple libraries. This is a global setting (one choice per server/consortium) and can be configured in Aspen Administration > System Administration > System Variables >

By default, this is set to Patron Home Library.

Example: The home library on my account is Main Library. I have overdues and replacement costs from East Library and Main Library on my account. When I pay in Aspen, regardless of whether I am using the East Library catalog or the Main Library catalog, my money is processed through Main Library.

The other option is Active Catalog.

Example: The home library on my account is Main Library. However, I work closer to East Library and navigate their catalog (east.aspendiscovery.org) the most. I have overdues and replacement costs from both East Library and Main Library on my account. I log into east.aspendiscovery.org and pay all of my fines. My money is processed through East Library.

Updated 2023/01/26 - md bws

What setup is needed in our ILS?

What setup is needed in our ILS?

If you already allow patrons to pay their fines with credit cards via your ILS, and you want to allow patrons to pay their fines from their account in Aspen, typically there is little or no additional setup needed on the ILS side. However, you will still need to be sure your eCommerce provider works with Aspen and is configured in Aspen. Read through the sections on this page to learn more about which vendors Aspen is compatible with and what setup is required in Aspen's settings.

When a fee is paid in Aspen via direct integration, Aspen will update your ILS with the payment information, which will clear the fee from their account. 

When a fee is paid in Aspen via a link to an external payment site, that site will update your ILS with the payment information, which will clear the fee from their account. The ILS will then update the user's account in Aspen. (If you do not see the fines/fees cleared from their account in Aspen immediately after paying on an external site, you may need to click the Reload button to force an update. Otherwise, information should update within 10-15 minutes.)

I'm migrating to Koha and Aspen supported by ByWater at the same time. How do we make sure we're set up?

After confirming your eCommerce vendor, your Aspen implementor will send a ticket with instructions to obtain your credentials. The Koha implementation team will have conversations to make sure you are set up on the Koha side, if you wish to allow staff to accept payments from patrons at the service desks.

 

Updated 2023-01-27 md bws

Settings for Certified Payments By Deluxe, Comprise, FIS WorldPay, InvoiceCloud, PayPal, Xpress-pay

Within Aspen Administration > eCommerce, you will find settings for various payment integrations - Certified Payments By Deluxe, Comprise, FIS WorldPay, InvoiceCloud, PayPal, and Xpress-pay.

To add the integration with the service you prefer, simply click on the one you want to set up and you will be presented with a form to fill out.

If you are uncertain of any information you're entering, contact the vendor to verify.

 

Example from Comprise:

Example from Certified Payments by Deluxe:

Select the libraries who use this payment vendor credentials. If all libraries within the consortium use the same payment service, you can "Select All."

If you are not seeing all of these payment options, check your permissions in Aspen Administration > System Administration > Permissions > eCommerice and make sure you have the corresponding permissions.

Updated 2023-04-18 km bws

Additional Information for FIS WorldPay

Important information for working with FIS WorldPay. 

Aspen needs FIS to setup the following fields:

  • UserPart1 as payment ID (this is the minimum required field)
  • UserPart2 for Patron’s First Name
  • UserPart3 for Patron’s Last Name
  • UserPart4 for Patron’s catalog username/barcode

The production and test URLs also need to be sent to FIS to be whitelisted on their firewall before payments will go through.

Additional Information for PayPal (REST API)

Our Aspen integration uses PayPal's REST-APIs (https://developer.paypal.com/api/rest/).

Note: This is not the same as PayPal Pay Flow. Please check that you have the correct credentials and PayPal account in order to set up this integration.

 

Your PayPal settings can be added at any time during implementation. To add the integration, you will need to get your Client ID and Client Secret.

 

Get Information From PayPal:

 

Step 1: Log in to https://developer.paypal.com

 

 

 

 

 


Once you have the credentials, enter them in Aspen Administration > eCommerce > PayPal Settings.  Next, set up configurations in the corresponding Library System in Aspen Administration > Primary Configuration > Library Systems > Fines/ e-commerce.

 


Testing with PayPal Sandbox

Note: testing is no longer available with live API credentials. In order to test fine payments without real transactions being posted, you'll need to set up a sandbox environment using the instructions below.



In order to test paying fines in Aspen, you'll need to use sandbox credentials instead of live credentials. This requires a unique set of sandbox credentials from your PayPal account, and tied to these sandbox credentials are sandbox credit card information. 

Below are the instructions for obtaining PayPal Sandbox credentials, both the client ID/secret and testing CC info. Using any other credit card information with the PayPal Sandbox account will produce errors.

Step 1: Log in to https://developer.paypal.com

 

 

 

Now, to obtain your corresponding sandbox credit card info:

 

 

 



Once you have entered in the Sandbox credentials into Aspen and tested the functionality to your satisfaction, you must go back to retrieve your Live paypal credentials and enter those into Aspen instead. Finally, make sure that "Use Sandbox Mode" is not checked in Aspen Administration > eCommerce > PayPal Settings.

Updated 2023-05-09 - md bws

Fines/eCommerce Setup in Library Systems

1. First, if you are using a payment vendor that Aspen integrates with via API, make sure your vendor credentials are set up in Aspen Administration > eCommerce. See the above sections for more specific information.

2. Next, from Aspen Administration, navigate to Primary Configuration > Library Systems > click into the library system > Fines/e-Commerce to finish configuring payment settings.

 

 

3. Show E-Commerce Link: Select your payment processing option from the following:

Note: If you are not accepting online payments, you'll want to make sure this is set to "No Payment." 

If you are accepting online payments with a vendor Aspen does not integrate with at this time, you may link out to an external payment site. In this case, select "Link to ILS."

 

4. Which Fines Should Be Paid?: Select which types of fines can be paid via Aspen.

All Fines: The user must pay the full total of fines/fees all at once. (No partial payments)

Selected Fines: allows users to choose with a checkbox which fines they would like to pay.

Partial payment of selected fines: allow users to choose with a checkbox which fines they would like to pay AND allow them to type in a portion of that amount to pay.

 

5. Fine Payment Order by type (separated with pipes): Enter which types of payments you would like to accept before others, if applicable. In this example, the library has chosen to prioritize Account Management, Lost, and then Overdue.

 

 

6. Pay Fines Link: The default link where users are sent to make payments will be {yourAspenURL}/MyAccount/Fines unless you set the URL to something else.

 

7. Pay Fines Link Text: The default text that shows to patrons will be "Click to Pay Fees Online." If you'd like this link to say something else, enter that text here.

 

8. Minimum Fine Amount: To avoid expensive credit card processing fees, libraries can choose a minimum fine amount to process. For example: setting a minimum of something like $5 to avoid paying the processing fee on someone's 0.25 cent fine transaction.

In the below example, the user owes $15 and the library has set the Minimum Fine Amount to $20. As a result, the user will not see the Click to Pay Fees Online option until they have reached at least $20 in fines.

 

 

When the user clicks into My Account > Fines and Messages, there will be no option to pay and there will be a default message about the library's minimum amount. The default notice is "Fines and fees can be paid online when you owe more than {minimum fine amount}." This allows users to still see their fines and fees, even if they can't pay them.

 

 

9. Symphony Payment Type: Symphony libraries can define how the payment comes through to the ILS with this field. By default, payments made through Aspen will show as CREDITCARD, but you can use whatever you need in this field instead (such as PAYPAL or ASPEN, for example).

 

2023-03-07 md bws
Reports - eCommerce Report and Donation Report

The eCommerce and Donations reports will display payment information for fines and donations, respectively.

eCommerce Report

  • Payment Type: Payment type
  • Transaction Date: Date of transaction
  • Transaction Type: The kind of transaction it was
  • User: The user who made the payment
  • Paid From: The interface used when making the payment
  • Library: The patron's home library
  • Order ID: The ID of the order within the payment system
  • Transaction ID: The ID of the transaction order within the payment system (if different from the order id)
  • Total Paid: Amount paid
  • Fines Paid: The ID of the order within the payment system
  • Completed?: The payment processor accepted the transaction
  • Cancelled?: The user cancelled the payment
  • Error: If we got an error back from the payment processor or if we got an error updating the ILS
  • Message: A message returned by the payment system

Donation Report

The Donation Reports can be filtered at the top from a number of filters.

The Donation Report includes the following fields:

  • Id: Numerical assignment after transcation
  • Date Completed: The date the donation was completed
  • First Name: First name of person making donation
  • Last Name: Last name of person making donation
  • Email: Email of person making donation
  • Anonymous: Will be checked if the person making the donation would like to remain anoymous
  • Donate To: Library location or branch donation is to go to
  • Donation Amount: Amount of donation
  • Donation Completed: Confirmation of transaction completion
  • Earmark: Specific program or initiative funds should be donated to
  • Dedicated? Will be checked if donation was dedicated to someone
  • Dedication Type: If they have selected to donate money in someones honor or memory; 1 is yes
  • Honoree First Name: If Dedication Type is selected, this will contain the first name of honoree
  • Honoree Last Name: If Dedication Type is selected, this will contain the last name of honoree
  • Notify someone of gift?: Whether or not the donor wants someone to be notified about this gift
  • Notification Party First Name: The first name of the person to notify of the donation
  • Notification Party Last Name: The last name of the person to notify of the donation
  • Notification Party Address: The address of the person to notify of the donation
  • Notification Party Address - City: The city of the person to notify of the donation
  • Notification Party Address - State: The state of the person to notify of the donation
  • Notification Party Address - Zip: The zipcode of the person to notify of the donation

 

Updated 2023-03-13 km bws
Donations Settings

To add the option for patrons to make donations:

Go to eCommerce > Donations Settings and click Add New.

Libraries can choose from the following options:

  • Allow users to select a specific branch to send their donation to
  • Allow users to choose an earmark for their donation
  • Allow users to make their donation in dedication of someone

Then, libraries can set the Page Contents of the form in the text box. 

In the next box, libraries can configure an Email Template to send a thank you for the donation.

 

 

The Page Content box will show at the top of the Donation form:

 

In the Donation Values, you can set preset donation amounts. 

These amounts will show like this on the Donation Form:

In the Donation Earmarks section

The Donation Earmarks will show on the Donation form as a dropdown menu.

In Donation Dedication Types, you can add Labels such as In honor of or In memory of.

 

These will show up on the Donation form when a user checks Dedicate my donation in honor or in memory of someone. Honoree information will expand and show the Donation Dedication Types and information on the honoree. 

 

Select the library or libraries for which these donation settings should apply.

On the Donation form, users can check Notify somone about this in memory or in honor of gift. This will expand Notification party information. 

At the bottom of the Donation form, the user can put in their first and last name.

Users can also choose Don't show my name publicly. 

If users add an email address, they can be emailed a receipt.

Once you've configured your donations settings, you can view the donations page at:

{yourlibrarycatalogURL}/Donations/NewDonation

When linking to this page from within Aspen -- for example, in a menu link -- you can simply link to /Donations/NewDonation and Aspen will automatically fill in your library's catalog URL. This will also ensure that your link will work even if your catalog URL changes in the future.

 

Updated 2023-03-13 km bws

Aspen Weekly