Request a Demo Search

Bloomerang.js

Bloomerang.js uses a public key API. It takes information from a form and submits it to an API endpoint on Bloomerang’s servers. It allows anyone to add donations and interactions to Bloomerang. Only constituent records can be updated, such as with a new address. These characteristics make Bloomerang.js perfect for online forms. You can also use Bloomerang’s integration with Spreedly to avoid processing credit cards yourself.

Required Functions

You must call the following functions for successful online donation submissions:

  • Bloomerang.useKey
  • Bloomerang.useProcessor
  • Bloomerang.useDonationId

Forms created through the application automatically call Bloomerang.useKey and Bloomerang.useProcessor, if necessary.

useKey Expand
useProcessor Expand
useDonationId Expand

Data Functions

The following functions set the data on the Bloomerang object model:

The data is sent to Bloomerang via the form submission functions.

Account Data Functions

These functions set information on the constituent account.

individual Expand
organization Expand
organizationName Expand
firstName Expand
middleName Expand
lastName Expand
prefix Expand
suffix Expand
informalName Expand
formalName Expand
envelopeName Expand
recognitionName Expand
jobTitle Expand
employer Expand
website Expand
facebook Expand
twitter Expand
linkedinID Expand
gender Expand
birthdate Expand
homePhone Expand
workPhone Expand
setPhone Expand
homeEmail Expand
workEmail Expand
setEmail Expand
homeAddress Expand
workAddress Expand
setAddress Expand
customFreeformField Expand
customPickField Expand
clearCustomFields Expand

Donation Data Functions

These functions set information on the submitted donation.

date Expand
note Expand
amount Expand
nonDeductible Expand
fundID Expand
campaign Expand
appeal Expand
tribute Expand
tributeType Expand
customFreeformField Expand
customPickField Expand
clearCustomField Expand

Recurring Donation Data Functions

These functions set data on a recurring donation.

date Expand
note Expand
amount Expand
nonDeductible Expand
fundID Expand
campaign Expand
appeal Expand
tribute Expand
tributeType Expand
frequency Expand
weekly Expand
monthly Expand
quarterly Expand
yearly Expand
startDate Expand
customFreeformField Expand
customPickField Expand
clearCustomFields Expand

Credit Card Data Functions

The CreditCard functions set the credit card data submitted to Bloomerang. Bloomerang does not process credit card data for security reasons. Instead, Bloomerang requires a Spreedly token.

All these functions set the payment method to CreditCard. A donation can only have one payment method. For example, a donation cannot be both credit card and in kind.

spreedlyToken Expand
expirationMonth Expand
expirationYear Expand

In Kind Data Functions

The InKind functions allow you to set properties for in-kind gifts. These are gifts of goods and services, not money.

All these functions set the payment method to InKind. A donation can only have one payment method. For example, a donation cannot be both credit card and in kind.

marketValue Expand
description Expand
type Expand
goods Expand
services Expand

Check Data Functions

The Check functions set properties for a donation made by check.

All these functions set the payment method to Check. A donation can only have one payment method. For example, a donation cannot be both credit card and check.

Bloomerang does not process checks online. You will need to deposit physical checks outside of Bloomerang. To allow constituents to pay electronically using a checking account, use EFT. See Eft Data Functions for details.

number Expand
date Expand

EFT Data Functions

The Eft functions set properties for a donation made by electronic funds transfer (EFT). This is also called ACH.

All these functions set the payment method to Eft. A donation can only have one payment method. For example, a donation cannot be both credit card and EFT.

EFT is available with the Authorize.Net and BluePay payment processors. We recommend Authorize.Net. If BluePay is used, the account must be set up to allow EFT transactions.

type Expand
checking Expand
savings Expand
accountNumber Expand
routingNumber Expand

Interaction Data Functions

These functions set data on an interaction

date Expand
subject Expand
note Expand
channel Expand
purpose Expand
inbound Expand
customFreeFormField Expand
customPickField Expand
clearCustomFields Expand

Submission Data Functions

The following functions control submitting data to Bloomerang using the API.

donate Expand
recurringDonate Expand
captchaResponse Expand
continueFinancialSubmission Expand
cancelFinancialSubmission Expand
submitInteraction Expand