search-icon

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 that takes customers through the DEAR Payment workflow. 


Aside from our own payment platform, DEAR Payments, DEAR supports PayPal and Stripe as payment processors. To allow your customers to pay for their transactions using their preferred processor, you can define a payment document containing links to these different payment processors.


For more information on DEAR Payments, see Getting Started with DEAR Payments.


For more information on using Stripe as a payment processor, see Stripe Integration


Prerequisites

  • PayPal Business Account (required)


Table of Contents


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. 


Set Up a PayPal Business Account

[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 set up your PayPal account for connecting to DEAR:

  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 (click here for more information). 
  3. Choose the PayPal Account that will be used in sale payment/prepayment lines.
  4. Copy the Client ID and the Secret Key. You will need these information 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. Once connected, you will be taken to the PayPal integration page, where you can send and receive payments, test payments and set which account will be linked to PayPal payments. You can also disconnect from PayPal.


View PayPal payment history

[back to top]


You can view your PayPal payment history from the Log tab.


Payment Document Information

[back to top]


There are two types of payment documents:

  • Sale Quote
  • Sale Invoice


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 enable Pay 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 a PayPal 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. Navigate to Settings > Document & Email templates and 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 pressing Alt + F9 (on Windows) or Option + F9 (on 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 off the field codes by again pressing Alt + F9 (on Windows) or Option + F9 (on Macs).
  6. Save the edited template and upload.



To insert a Custom Pay Link image:

  1. Navigate to 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 pressing Alt + F9 (on Windows) or Option + F9 (on Mac).
  4. Replace the copied field with code { IF “{MERGEFIELD PayPalPay}”==”” “<CustomImage>” “<CustomImage>” } and insert a PayLink with the specified <CustomImage> into the Word Template.
  5. 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, of which there are two payment 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.