Stripe Integration

DEAR generates electronic documents (e.g. PDF and email content) to enable your customers to seamlessly pay quotes and invoices. Payment documents contain Pay Links, which take 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. For more information on using PayPal as a payment processor, see PayPal Integration.


NOTE: The integration between DEAR and Stripe meets the General Data Protection Regulation (GDPR) standards implemented in May 2018.


Table of Contents


Stripe Integration Setup

[back to top]


Integration is a two-step process:

  1. Generate live API keys
  2. Connect DEAR to your Stripe account


Generate Live API Keys

[back to top]


You must first generate the API keys vital to integrating Stripe with DEAR.


NOTE: This article assumes that you have signed up for and/or set up a Stripe account. For assistance related to your Stripe account, see the Stripe documentation website.


To generate live API keys:

  1. Go to your Stripe Account Dashboard and activate your account.
  2. Select Get your live API Keys.

NOTE: If you're not ready to go live with the connection and just want to test how Stripe works with DEAR, select Get your test API keys instead. The test API keys are meant for testing and development – do not use them in your live environment. Once you're ready to go live with the DEAR-Stripe integration, you need to get your live API keys and connect the two platforms again. For more information on Stripe's test and live keys, read this article on the Stripe documentation website.

  1. Click to copy the Publishable Key for the next step, Connect DEAR to your Stripe account


Connect DEAR to your Stripe Account

[back to top]


After setting up your Stripe account, you can then connect DEAR and Stripe.


To connect DEAR to Stripe:  

  1. Navigate to Integration -> Stripe.



  2. On the Setup tab, enter your Stripe account name and click Connect to Stripe.



  3. If you haven't set up and activated your Stripe account previously, you will have the opportunity to fill up the Stripe account form at this time. Otherwise, DEAR will then connect directly to Stripe.

NOTE: You can skip the Stripe account setup form if you're using test API keys for testing and development.

  1. You are then taken back to the Stripe Integration page in DEAR where, on the Setup tab, you can change the account associated with Stripe payments and the time zone, set Stripe to ask for billing information, and disconnect DEAR and Stripe, if necessary.



  2. Click Save Settings. Your Stripe account can now send and receive payments through DEAR.


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 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 Stripe Pay Link 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: Stripe 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 the mail merge field { MERGEFIELD StripePay} and the field will be replaced with the Stripe 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 the copied field with the code { IF “{MERGEFIELD StripePay}”==”” “<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 Stripe

[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.