Stripe 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 PayPal.


  1. Stripe Integration Setup
  2. Add a Stripe Link to a Payment Document
  3. Payment Document Information



Stripe Integration Setup

[back to top]


You first need to establish a connection between DEAR and a Stripe Account to enable Stripe as a payment processor.



Setup in Stripe

[back to top]



You need to establish a connection between DEAR and your Stripe Account to enable Stripe payment processor. 



To setup Stripe:

  1. Go to your Stripe Account Dashboard and select API Keys
  2. Copy Secret Key and Publishable Key for the next step, Connect to DEAR. You can use Live keys or Test keys.
  3. You will also need to choose an Account that will be used in sale payment/prepayment lines.






Connect to DEAR

[back to top]



To connect Stripe to DEAR:   

  1. Navigate to Integration -> Stripe

  1. Enter the API Details and click Connect to Stripe

  1. Here you can change any Stripe settings, disconnect from Stripe and change which account is associated with Stripe payments.
  2. Your Stripe account can now send and receive payments through DEAR




Adding a Stripe 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 document templates and mail merge documentation for more information about adding mail merge fields to standard documents. 


Once a customer clicks on the PayLink, they will be taken through the Stripe payment process. 


To insert a Standard Pay Link image:

  1. Use mail merge field { MERGEFIELD StripePay} and it will be replaced by the Stripe PayLink image. 



To insert a Custom Pay Link image:

  1. Use field with code { IF “{MERGEFIELD StripePayLink}”==”” “<CustomImage>” “<CustomImage>” } and this field will be replaced by PayLink with the specified <CustomImage>.



Payment Document Information

[back to top]


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.




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



Sale Quote Payment Documents

A number of requirements should be met to enable Pay Links on generated Sale Quote documents:

  • Payment processor (Stripe or Paypal) should be configured
  • Sale Quote should be authorized
  • Pre-Payment 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 Prepayment record is created with the Account defined on the Payment processor settings page.



Sale Invoice Payment Documents

A number of 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 authorized


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.