How to build the link
Add parameters to your checkout URL starting with? for the first one, then & for each additional one:
Gift and form parameters
These parameters prefill the checkout form itself:
A few things worth knowing:
- There is no
fund_idparameter. Funds are set throughdesignation(by ID) ordesignation_code(by code). - Parameters only prefill what the checkout already allows. If a setting like anonymous giving or multiple designations is turned off, the parameter is ignored.
- The donor can still change any prefilled value before completing their gift, unless the checkout is configured to lock it.
UTM tracking parameters
Standard UTM parameters are captured automatically from the checkout link and stored with the resulting gift, so you can trace a donation back to the campaign or channel that drove it:
Example:
Passing custom data with a custom field
You can also carry a piece of data (like a sponsorship ID, a child and amount breakdown, or any reference value) from a checkout link straight onto the resulting payment. The value is stored on the payment without ever showing to the donor as a form question, so you can use it to reconcile the gift in your CRM.When to use this
Use this when an upstream system (your website, a CRM, a sponsorship page, or an email link) already knows something about the gift that you want stored on the payment, but you do not want to ask the donor for it on the checkout form. A common example is child sponsorship: you send a donor to checkout with a child and amount breakdown packed into the link, the value lands on the payment, and your CRM maps it to the right children and designations.What you need first
Two things have to be set up before a value will be captured:- A text custom field on the payment object. This is the field the value lands in.
- The transaction tracking URL setting turned on for your organization. If this is off, nothing from the URL is captured.
How to build the link
Append the custom field to your checkout URL as a query parameter, using the field’s key:Example
For a text custom field with keyCF_436_child_sponsor_allocation, a link that carries three children and their amounts looks like this:
Good to know
A few things to keep in mind as you set this up:- The value lands on the payment and the recurring plan only, not on individual designation or allocation records. If you need to split the value across designations, do that mapping in your CRM.
- No backfill. This applies to new checkouts going forward, not to past payments.
- If a link ever gets rewritten by an email tool or CRM link builder, you can encode commas as
%2C. It is not required, since the value is decoded on the way in.