Paypal Integration

DEAR generates electronic documents (PDF, e-mail content) to enable your customers to seamlessly pay quotes and invoices. Payment documents can contain Pay Links, a link which takes customers through the DEAR Payment workflow. DEAR supports Stripe and Paypal as payment processors, and one payment document can contain links to both payment processors. See how to pay with Stripe


Prerequisites

  • Paypal Business Account (necessary)


Table of Contents

  1. Paypal Integration Setup
  2. Payment Document Information
  3. Add a PayPal Link to a Payment Document
  4. Paying with PayPal


Paypal Integration Setup

[back to top]


You first need to establish a connection between DEAR and a PayPal Business Account to enable PayPal as a payment processor. If Paypal is not configured, Paypal paylinks will not display on quotes or invoices. 


Setup in Paypal

[back to top]


First, you will need to get some information from your PayPal Business Account and get API Keys to connect to DEAR. 


To setup PayPal:

  1. Go to your PayPal Business Account Profile Page and copy your Merchant ID (PayPal Account ID).

  2. Create PayPal Business Account integration keys (REST API keys) for DEAR at the Developer Dashboard. (See PayPal Docs here). 
  3. Choose the PayPal Account that will be used in sale payment/prepayment lines.
  4. You will need the Client ID and the Secret Key to connect DEAR to your PayPal Business Account. 



Connect to DEAR

[back to top]

 

  1. Navigate to Integration -> Paypal.
  2. Enter your Merchant ID and API details and click Connect to PayPal.
  3. Here you can test payments and set which account will be linked to PayPal payments. You can also disconnect from PayPal. Payment History can be viewed from the Log tab. 
  4. Your PayPal account is now connected and can be used to send and receive payments.



Payment Document Information

[back to top]


Types of payment documents

There are two types of payment documents:

  • Sale Quote document
  • Sale Invoice document


Sale Quote and Sale Invoice documents are generated from the Sale Quote and Sale Invoice document templates. You can see and edit the various template types by going to Settings -> Document and Email Templates. See Managing document templates for more information.


Sale Quote Payment Documents

These conditions should be met to enable Pay Links on generated Sale Quote documents:

  • Payment processor (Stripe or Paypal) should be configured
  • Sale Quote should be authorised
  • Customer Credit account should be configured on account mapping page


Amount to pay for Sale Quote documents is calculated as the difference between the Sale Quote Total and all Payments/Prepayments.


After successfully completing the payment workflow, a Customer Credit record is created with the Account defined on the Payment processor settings page.


Sale Invoice Payment Documents

These conditions should be met to enablePay Links on generated Sale Invoice documents:

  • Payment processor (Stripe or PayPal) should be configured
  • Sale Invoice should be authorised


Amount to pay for Sale Invoice documents is calculated as the difference between the Sale Invoice Total and all Payments/Prepayments.


After successfully completing the payment workflow, a Payment record is created against the relevant invoice.


Adding a PayPal PayLink to a Payment Document

[back to top]


There are two ways to insert Pay Link into a document template: with a standard Pay Link image and with a custom Pay Link image. See Managing document templates for more information about adding mail merge fields to standard documents. 


NOTE: Paypal must be connected and configured for paylinks to display.


To insert a Standard Pay Link image:

  1. In Settings -> Document & Email templates, download the quote and/or invoice template.
  2. Copy an existing field to the location you want your paylink to be. 
  3. Show the field code either by right-clicking the field and selecting Toggle Field Code or using Alt + F9 for Windows, Option + F9 for Mac.
  4. Replace the copied field with mail merge field { MERGEFIELD PayPalPay} and the field will be replaced by the PayPal PayLink image. 
  5. Toggle field codes off.
  6. Save the edited template and upload. 



To insert a Custom Pay Link image:

  1. As above - replace copied field with code { IF “{MERGEFIELD PayPalPay}”==”” “<CustomImage>” “<CustomImage>” } and this field will be replaced by PayLink with the specified <CustomImage> inserted into the Word Template. 
  2. Save the edited template and upload. 


Paying with Paypal

[back to top]


When a customer clicks on the paylink in a quote or invoice, they are taken to a page displaying the quote/invoice and payment options. 


There are two options:

  • Pay the full outstanding value of the quote/invoice.
  • Pay less - this will open a pop-up window where the customer can enter a different value (for prepayments, partial payments etc.)


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.