PayPal (Payment Processor)

Owned by Robert Lenk
Last updated: Oct 23, 2024
4 min read

About PayPal Integration

Campus Cafe supports an integration with PayPal to facilitate the processing of credit card payments. Customers are responsible for establishing a PayPal account and all fees associated with processing payments and maintaining a PayPal account.

Configure PayPal

  1. Log in to PayPal

  2. In the upper right click your name

  3. Click Account Settings

  4. On the left click Notifications

  5. Next to Instant Payment Notification click Update

  6. Click Edit Settings

  7. In the Notification URL box enter https://***-web.scansoftware.com/cafeweb/public/paypal?word=baseball replacing *** with your school code and baseball with a secret word of your choice

  8. Under IPN messages choose Receive IPN messages (Enabled)

  9. Click Save

  10. In the upper right click your name

  11. Click Account Settings

  12. On the left click Website payments

  13. Next to Website preferences click Update

  14. In the Auto Return for Website Payments section under Auto Return click On

  15. In the Return URL box enter https://***-web.scansoftware.com/cafeweb/Payment?handler=viewWithCourses replacing *** with your school code

  16. Click Save

Campus Café Client Web App Configuration

Campus Café must be configured with values retrieved from PayPal to enable the use of PayPal as a hosted-payment web form provider.

  1. Log in to Campus Café

  2. Navigate to Admin > Web App

  3. In the search box enter PayPal

  4. Set the following values

  • PAYMENT_ADMIN_EMAIL_ADDRESS: The email address of the individual to receive a notification of payment. Separate multiple emails with a comma. Must be configured to allow emailed payment receipts to payers.

  • PAYMENT_CONFIRMATION_EMAIL_ADDRESS: The email address that will be used to send payment confirmation emails. Must be configured to allow emailed payment receipts to payers.

  • PAYPAL_EMAIL: The email address associated with the PayPal account configured earlier

  • PAYPAL_SCHOOL_NAME: The name of the institution

  • PAYPAL_SECRET: The secret word configured earlier in PayPal

  • PAYPAL_URL: Enter https://www.paypal.com/cgi-bin/webscr

Campus Café Custom Control Configuration

To set Campus Café to send a payer to the PayPal, the Custom Control Setting WEBPAYMENT must be changed.

  1. Log in to Campus Café

  2. Navigate to Admin > Custom Control

  3. In the search box, enter WEBPAYMENT

  4. Click the pencil icon for WEBPAYMENT sequence 2, parameter 4

  5. In Parameter Value 4 enter PAYPAL_FORM

  6. Click Save & Back

  7. Contact Campus Café to request a restart of the Tomcat server or wait overnight. 

Set Transaction Code Associated with Online Tuition Payments

Payments made toward tuition and fees from the Make Payment screen will enter Cash Batch tied to the transaction code configured.

  1. Log in to Campus Café

  2. Navigate to Admin > Custom Control

  3. In the search box, enter WEBPAYMENT

  4. Click the pencil icon for sequence 2, parameter 1

  5. In the Parameter Value 1 box enter the transaction code

    1. First value will be credit card, the second comma separated value will be for ach/e-check transactions.

      1. Please note that if any portion of an e-check payment is made through a PayPal Balance, Credit Card, or instant transfer it will come through as a credit card transaction. This is hard coded in PayPal and cannot be changed. PayPal will only send the Campus Cafe system an “echeck” payment type if the transaction is 100% funded from a bank account.

      2. https://developer.paypal.com/api/nvp-soap/ipn/IPNandPDTVariables/#:~:text=has%20been%20voided.-,payment_type,-echeck%3A%20This%20payment

        image-20241023-171342.png

  6. Click Save

  7. Contact Campus Café to request a restart of the Tomcat server or wait overnight. 

Email Receipt Branding and Content

Campus Café provides customizable web text to allow a school to customize the look and feel of the emailed payment receipt. The content of the email (body) supports HTML and references to images stored on the Campus Cafe server or elsewhere.

For this function to work, Web App item PAYMENT_ADMIN_EMAIL_ADDRESS must have a valid email address.

Configure Email Sender

This is the email address that will send the confirmation

  1. Log in to Campus Café

  2. Navigate to Admin > Web App

  3. In the search box, enter PAYMENT_CONFIRMATION_EMAIL_ADDRESS

  4. Update the value to the email address

  5. To apply the changes, reload the cache by navigating to Admin > Refresh Data Cache

Configure Email Content

  1. Log in to Campus Café

  2. Navigate to Admin > Adjustable Text

  3. In the AR module, update the values for PAY_CONF_MAIL_SUBJ (email subject line) and PAY_CONF_MAIL_BODY (content of email)
    Note: The subject line does not support merge fields or HTML. The body supports HTML and the specific merge fields noted below.

  4. To apply the changes, reload the cache by navigating to Admin > Refresh Data Cache

Merge Fields

A merge field inserts variable data such as the individual's name into the content of the email body. Merge fields are wrapped in double brackets. Enter the full field, including the brackets, for the merge to function. The body supports only the below merge fields.

  • [[FULL_NAME]] = Student's full name

  • [[AMOUNT_PAID]] = The amount remunerated

  • [[PAYMENT_PROVIDER]] = The payment processor (e.g. PayPal)