Bloomerang.js

Bloomerang.js 2016-11-17T08:27:17+00:00

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:

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

Yes No

>Bloomerang.useKey(publicKey) #

This function uses the public key to submit the form to the correct organization. Get the public key by clicking Settings, View All Settings, and then Edit on the Organization tile in Bloomerang.

publicKeyrequiredA string that begins with pub_
Yes No

>Bloomerang.useProcessor(id, type, publicKey, isTestMode, bluePayTPS, restrictBPCredit) #

Tells Bloomerang which processor to post the credit card or EFT information to. Use this function only if the form uses BluePay and supports EFT. Otherwise, Spreedly handles credit card processing.

idrequiredThe Bloomerang ID of the processor. Get the ID by clicking Settings, View All Settings in Bloomerang. Click Edit on the Transactions tile, and then Credit Card Processors. Also see How to Get Bloomerang IDs.
typerequiredValid value is BluePay
publicKeyrequiredThe BluePay processor’s public key. Find this in the Account ID field of the processor’s page in Bloomerang.
isTestModeoptionalA boolean value telling whether the processor is in test mode. Defaults to false.
bluePayTPSrequiredThe MD5 hash of the string concatenation of the BluePay private key and the string AUTH0ACH. For example, if the BluePay private key were 1111, bluePayTPS would be the MD5 hash of 1111AUTH0ACH, or c8fc6dfcf7fd6373a2b0d4154a4cb709.
restrictBPCreditrequiredA boolean value. Must be true. Ensures that bad guys can’t use the BluePay TPS to authorize credit cards fraudulently.
Yes No

>Bloomerang.useDonationId(id) #

Tells Bloomerang which donation form you are using.

idrequiredThe ID associated with this form. See How to Get Bloomerang IDs.
Yes No

Data Functions #

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

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

Yes No

>Account Data Functions #

These functions set information on the constituent account.

Yes No

=>Bloomerang.Account.individual() #

Sets the account type of the constituent to Individual (a person, not an organization).

Yes No

=>Bloomerang.Account.organization() #

Sets the account type of the constituent to Organization (not an individual).

Yes No

=>Bloomerang.Account.organizationName(name) #

Sets the full name of the organization. Also calls Bloomerang.Account.organization() to set the type of the account to Organization.

namerequiredThe full name of the organization
Yes No

=>Bloomerang.Account.firstName(name) #

Sets the constituent’s first name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

namerequiredThe constituent’s first name
Yes No

=>Bloomerang.Account.middleName(name) #

Sets the constituent’s middle name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

namerequiredThe constituent’s middle name
Yes No

=>Bloomerang.Account.lastName(name) #

Sets the constituent’s last name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

namerequiredThe constituent’s last name
Yes No

=>Bloomerang.Account.prefix(value) #

Sets the constituent’s name prefix. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

valuerequiredThe constituent’s name prefix. Valid values are Mr, Miss, Ms, Mrs, Master, Rev, Pastor, Fr, Dr, Atty, Prof, Hon, Pres, Coach , Gov, Sir, Rep, Sen, Pvt, Sgt, Maj, Capt, Cmdr, Lt, Col, Gen, Rabbi, Sr
Yes No

=>Bloomerang.Account.suffix(value) #

Sets the constituent’s name suffix. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

valuerequiredThe constituent’s name suffix. Valid values are Jr, Sr, II, III, IV, V, Esq, PhD, MD, DDS
Yes No

=>Bloomerang.Account.informalName(name) #

Sets the constituent’s informal name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

If this is not called, the informal name defaults to the constituent’s first name.

namerequiredThe constituent’s informal name
Yes No

=>Bloomerang.Account.formalName(name) #

Sets the constituent’s formal name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

If this is not called, the informal name defaults to prefix lastName. If no prefix is specified, it defaults to firstName lastName.

namerequiredThe constituent’s formal name
Yes No

=>Bloomerang.Account.envelopeName(name) #

Sets the constituent’s envelope name. This is the name that should be printed on mailing labels. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

If this is not called, the envelope name defaults to prefix firstName lastName suffix.

namerequiredThe constituent’s envelope name
Yes No

=>Bloomerang.Account.recognitionName(name) #

Sets the constituent’s recognition name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

If this is not called, the recognition name defaults to prefix firstName middleName lastName suffix.

namerequiredThe constituent’s recognition name
Yes No

=>Bloomerang.Account.jobTitle(title) #

Sets the constituent’s job title.

titlerequiredThe constituent’s job title
Yes No

=>Bloomerang.Account.employer(name) #

Sets the name of the constituent’s employer.

namerequiredThe constituent’s employer
Yes No

=>Bloomerang.Account.website(url) #

Sets the constituent’s website.

urlrequiredThe URL of the constituent’s website
Yes No

=>Bloomerang.Account.facebook(id) #

Sets the constituent’s Facebook account.

idrequiredThe constituent’s Facebook page URL
Yes No

=>Bloomerang.Account.twitter(id) #

Sets the constituent’s Twitter account.

idrequiredThe constituent’s Twitter handle
Yes No

=>Bloomerang.Account.linkedInId(id) #

Sets the constituent’s LinkedIn account.

idrequiredThe constituent’s LinkedIn URL
Yes No

=>Bloomerang.Account.gender(value) #

Sets the constituent’s gender.

valuerequiredThe constituent’s gender. Valid values are Male, Female, or Other.
Yes No

=>Bloomerang.Account.birthdate(date) #

Sets the constituent’s date of birth.

daterequiredThe constituent’s date of birth. String in yyyy-mm-dd format.
Yes No

=>Bloomerang.Account.homePhone(number, ext) #

Sets the constituent’s primary phone number, with a type of Home. Shortcut for Bloomerang.Account.setPhone(Home). You can only set one phone number on a constituent via forms.

When the phone number is submitted, it is added as a new phone number and marked as primary. If the constituent already has that phone number, it is marked as primary.

numberrequiredThe constituent’s home phone number. String. Add + in front of an international number. For example, +82112223333.
extoptionalThe phone number’s extension.
Yes No

=>Bloomerang.Account.workPhone(number, ext) #

Sets the constituent’s primary phone number, with a type of Work. Shortcut for Bloomerang.Account.setPhone(Work). You can only set one phone number on a constituent via forms.

When the phone number is submitted, it is added as a new phone number and marked as primary. If the constituent already has that phone number, it is marked as primary.

numberrequiredThe constituent’s work phone number. String. Add + in front of an international number. For example, +82112223333.
extoptionalThe phone number’s extension.
Yes No

=>Bloomerang.Account.setPhone(type, number, ext) #

Sets the constituent’s primary phone number and specifies the type. You can only set one phone number on a constituent via forms.

When the phone number is submitted, it is added as a new phone number and marked as primary. If the constituent already has that phone number, it is marked as primary.

typerequiredThe type of phone number. Valid values are Home, Work, Mobile, or Fax.
numberrequiredThe constituent’s phone number. String. Add + in front of an international number. For example, +82112223333.
extoptionalThe phone number’s extension.
Yes No

=>Bloomerang.Account.homeEmail(address) #

Sets the constituent’s primary email address, with a type of Home. Shortcut for Bloomerang.Account.setEmail(“Home”, address). You can only set one email address on a constituent via forms.

When the email address is submitted, it is added as a new email address and marked as primary. If the constituent already has that email address, it is marked as primary.

addressrequiredThe constituent’s home email address
Yes No

=>Bloomerang.Account.workEmail(address) #

Sets the constituent’s primary email address, with a type of Work. Shortcut for Bloomerang.Account.setEmail(“Work”, address). You can only set one email address on a constituent via forms.

When the email address is submitted, it is added as a new email address and marked as primary. If the constituent already has that email address, it is marked as primary.

addressrequiredThe constituent’s work email address
Yes No

=>Bloomerang.Account.setEmail(type, address) #

Sets the constituent’s primary email address and specifies the type. You can only set one email address on a constituent via forms.

When the email address is submitted, it is added as a new email address and marked as primary. If the constituent already has that email address, it is marked as primary.

typerequiredThe type of email address. Valid values are Home or Work.
addressrequiredThe constituent’s email address
Yes No

=>Bloomerang.Account.homeAddress(street, city, state, zip, country) #

Sets the constituent’s primary address, with a type of Home. Shortcut for Bloomerang.Account.setAddress(Home). You can only set one address on a constituent via forms.

If the constituent already has an address, Bloomerang normalizes the submitted address. (“123 North 4th Street” becomes “123 N 4TH ST”.) Then it compares the normalized address with the existing addresses. If a match is found, the existing address is updated and marked as primary. If not, a new address is added and marked as primary.

If the country is not United States, Canada, or Bermuda, put the entire address in the street argument. Don’t use city, state, or zip.

streetrequiredThe street part of the constituent’s address (123 4th Street).
cityoptionalThe city part of the constituent’s address (Indianapolis).
stateoptionalThe state part of the constituent’s address (Indiana). We recommend using state abbreviations (IN).
zipoptionalThe ZIP code for the constituent’s address (46216).
countryoptionalThe country for the constituent’s address. We recommend using the 2- or 3-digit country code. See https://www.iso.org/obp/ui/#search. Default is US.
Yes No

=>Bloomerang.Account.workAddress(street, city, state, zip, country) #

Sets the constituent’s primary address, with a type of Work. Shortcut for Bloomerang.Account.setAddress(Work). You can only set one address on a constituent via forms.

If the constituent already has an address, Bloomerang normalizes the submitted address. (“123 North 4th Street” becomes “123 N 4TH ST”.) Then it compares the normalized address with the existing addresses. If a match is found, the existing address is updated and marked as primary. If not, a new address is added and marked as primary.

If the country is not United States, Canada, or Bermuda, put the entire address in the street argument. Don’t use city, state, or zip.

streetrequiredThe street part of the constituent’s address (123 4th Street)
cityoptionalThe city part of the constituent’s address (Indianapolis)
stateoptionalThe state part of the constituent’s address (Indiana). We recommend using state abbreviations (IN).
zipoptionalThe ZIP code for the constituent’s address (46216)
countryoptionalThe country for the constituent’s address. We recommend using the 2- or 3-digit country code. See https://www.iso.org/obp/ui/#search. Default is US.

 

Yes No

=>Bloomerang.Account.setAddress(type, street, city, state, zip, country) #

Sets the constituent’s primary address and specifies the type. You can only set one address on a constituent via forms.

If the constituent already has an address, Bloomerang normalizes the submitted address. (“123 North 4th Street” becomes “123 N 4TH ST”.) Then it compares the normalized address with the existing addresses. If a match is found, the existing address is updated and marked as primary. If not, a new address is added and marked as primary.

If the country is not United States, Canada, or Bermuda, put the entire address in the street argument. Don’t use city, state, or zip.

typerequiredThe type of address. Valid values are Home, Work, Vacation.
streetrequiredThe street part of the constituent’s address (123 4th Street)
cityoptionalThe city part of the constituent’s address (Indianapolis)
stateoptionalThe state part of the constituent’s address (Indiana). We recommend using state abbreviations (IN).
zipoptionalThe ZIP code for the constituent’s address (46216)
countryoptionalThe country for the constituent’s address. We recommend using the 2- or 3-digit country code. See https://www.iso.org/obp/ui/#search. Default is US.

 

Yes No

=>Bloomerang.Account.customFreeformField(fieldId, value) #

Sets a freeform custom field on the constituent account.

fieldIdrequiredThe ID of the custom field
valuerequiredThe value (a string, number, or date) that should be set for the field
Yes No

=>Bloomerang.Account.customPickField(fieldId, valueId1, valueId2, ...) #

Sets a pick one or pick multiple custom field on the constituent account.

For a pick one field, only pass in one value’s ID. This value replaces an existing value for that field.

For a pick multiple field, you can pass in as many value IDs as there are defined values. Each value is a separate argument. Submitted values are added to the field, and no values are removed.

fieldIdrequiredThe ID of the field
valueIdrequiredThe IDs of the values that should be set for the field
Yes No

=>Bloomerang.Account.clearCustomFields() #

Clears all the custom field values on the account. Call this function to remove any selections left over from a previous submission attempt. Then update the custom fields with values from the form.

This does not delete any custom field values in the Bloomerang database.

Yes No

>Donation Data Functions #

These functions set information on the submitted donation.

Yes No

=>Bloomerang.Donation.date(date) #

Depreciated. Bloomerang automatically uses the date the donation was submitted.

Yes No

=>Bloomerang.Donation.note(text) #

Sets the Note field on the donation.

textrequiredThe note to be added to the transaction. String, up to 64KB in length.
Yes No

=>Bloomerang.Donation.amount(amount) #

Sets the donation amount.

amountrequiredThe amount of the donation. String (with U.S. formatting, $5.00) or number (5).
Yes No

=>Bloomerang.Donation.nonDeductible(amount) #

Sets the nondeductible part of the donation amount. (The tax-deductible part is amount minus nonDeductible.)

amountrequiredThe nondeductible amount. Number.
Yes No

=>Bloomerang.Donation.fundId(id) #

Sets the fund for the donation.

If the submitted fund does not exist in Bloomerang, the transaction defaults to the form’s first fund.

idrequiredThe fund’s Bloomerang ID
Yes No

=>Bloomerang.Donation.campaign(name) #

Sets the campaign for the donation. This overrides any campaign set in the Bloomerang form builder.

This function does not create campaigns in Bloomerang! You must first create the campaign in Bloomerang and then use the exact name on your form.

namerequiredThe name of the campaign as set in Bloomerang. If the name changes, you must update the form to use the new name. Defaults to the campaign set in Bloomerang’s form builder.
Yes No

=>Bloomerang.Donation.appeal(name) #

Sets the appeal for the donation. This overrides any appeal set in the Bloomerang form builder.

This function does not create appeals in Bloomerang! You must first create the appeal in Bloomerang and then use the exact name on your form.

namerequiredThe name of the appeal as set in Bloomerang. If the name changes, you must update the form to use the new name. Defaults to the appeal set in Bloomerang’s form builder.
Yes No

=>Bloomerang.Donation.tribute(name) #

Sets the tribute for the donation.

This function does not create tributes in Bloomerang! You must first create the tribute in Bloomerang and then use the exact name on your form.

namerequiredThe name of the existing tribute as set in Bloomerang. If the name changes, you must update the form to use the new name.
Yes No

=>Bloomerang.Donation.tributeType(name) #

Sets the donation’s tribute type.

namerequiredThe name of the tribute type. Valid values are In Honor of, In Memory of.
Yes No

=>Bloomerang.Donation.customFreeformField(fieldId, value) #

Sets a custom field on the donation. The constituent can type anything into this field.

fieldIdrequiredThe field’s Bloomerang ID
valuerequiredValid formats are string, number, date
Yes No

=>Bloomerang.Donation.customPickField(fieldId, valueId1, valueId2, ...) #

Sets a custom field on the donation. The constituent can pick one or more values. This depends on how the field was created in Bloomerang.

This function replaces the field’s values on the JavaScript object.

fieldIdrequiredThe field’s Bloomerang ID
valueId(s)requiredThe values’ Bloomerang IDs. For pick one fields, pass in one valueId. For pick multiple fields, you can pass in multiple valueIds, each as a separate argument.
Yes No

=>Bloomerang.Donation.clearCustomFields() #

Clears all the custom field values for the donation. Call this function to remove any selections left over from a previous submission attempt. Then update the custom fields with values from the form.

This does not delete any custom field values in the Bloomerang database.

Yes No

>RecurringDonation Data Functions #

These functions set data on a recurring donation.

Yes No

=>Bloomerang.RecurringDonation.date(date) #

Depreciated. Bloomerang automatically uses the date the recurring donation was submitted.

The start date of a recurring donation is set using Bloomerang.RecurringDonation.startDate.

Yes No

=>Bloomerang.RecurringDonation.note(text) #

Sets the Note field on the recurring donation.

textrequiredThe note to be added to the transaction. String, up to 64KB in length.
Yes No

=>Bloomerang.RecurringDonation.amount(amount) #

Sets the amount of the recurring donation. The amount is charged at each interval specified by Bloomerang.RecurringDonation.frequency(value).

amountrequiredThe amount of the recurring donation
Yes No

=>Bloomerang.RecurringDonation.nonDeductible(amount) #

Sets the nondeductible part of the recurring donation amount. (The tax-deductible part is amount minus nonDeductible.)

amountrequiredThe nondeductible amount. Number. Does not accept strings.
Yes No

=>Bloomerang.RecurringDonation.fundId(id) #

Sets the fund for the recurring donation.

If the submitted fund does not exist in Bloomerang, the transaction defaults to the form’s first fund.

idrequiredThe fund’s Bloomerang ID
Yes No

=>Bloomerang.RecurringDonation.campaign(name) #

Sets the campaign for the recurring donation. This overrides any campaign set in the Bloomerang form builder.

This function does not create campaigns in Bloomerang! You must first create the campaign in Bloomerang and then use the exact name on your form.

namerequiredThe name of the campaign as set in Bloomerang. If the name changes, you must update the form to use the new name. Defaults to the campaign set in Bloomerang’s form builder.
Yes No

=>Bloomerang.RecurringDonation.appeal(name) #

Sets the appeal for the recurring donation. This overrides any appeal set in the Bloomerang form builder.

This function does not create appeals in Bloomerang! You must first create the appeal in Bloomerang and then use the exact name on your form.

namerequiredThe name of the appeal as set in Bloomerang. If the name changes, you must update the form to use the new name. Defaults to the appeal set in Bloomerang’s form builder.
Yes No

=>Bloomerang.RecurringDonation.tribute(name) #

Sets the tribute that should be used for the current recurring donation.

This function does not create tributes in Bloomerang! You must first create the tribute in Bloomerang and then use the exact name on your form.

namerequiredThe name of the existing tribute as set in Bloomerang. If the name changes, you must update the form to use the new name.
Yes No

=>Bloomerang.RecurringDonation.tributeType(name) #

Sets the recurring donation’s tribute type.

namerequiredThe name of the tribute type. Valid values are In Honor of, In Memory of.
Yes No

=>Bloomerang.RecurringDonation.frequency(value) #

Sets how often the recurring donation should occur.

valuerequiredThe frequency of the recurring donation. Valid values are Weekly, Monthly, Quarterly, Yearly. Invalid values default to Monthly.
Yes No

=>Bloomerang.RecurringDonation.weekly() #

Sets the recurring donation to happen weekly. Shortcut for Bloomerang.RecurringDonation.frequency(“Weekly”).

Yes No

=>Bloomerang.RecurringDonation.monthly() #

Sets the recurring donation to happen monthly. Shortcut for Bloomerang.RecurringDonation.frequency(“Monthly”).

Yes No

=>Bloomerang.RecurringDonation.quarterly() #

Sets the recurring donation to happen quarterly. Shortcut for Bloomerang.RecurringDonation.frequency(“Quarterly”).

Yes No

=>Bloomerang.RecurringDonation.yearly() #

Sets the recurring donation to happen yearly. Shortcut for Bloomerang.RecurringDonation.frequency(“Yearly”).

Yes No

=>Bloomerang.RecurringDonation.startDate(date) #

Sets the date when the recurring donation should start processing payments. This is not the same as Bloomerang.RecurringDonation.date, which is when the form was submitted.
If the start date is the same as the current date, the first payment processes immediately. Otherwise, it occurs in the early morning of the start date (UTC time).
Time zones can set the start date earlier than the donation’s date. If this happens, Bloomerang changes the start date to match the donation’s date. The payment processes immediately.

daterequiredThe date on which the recurring donation should start processing donations. String in yyyy-mm-dd format.
Yes No

=>Bloomerang.RecurringDonation.customFreeformField(fieldId, value) #

Sets a custom field on the recurring donation. The constituent can type anything into this field.

fieldIdrequiredThe field’s Bloomerang ID
valuerequiredValid formats are string, number, date
Yes No

=>Bloomerang.RecurringDonation.customPickField(fieldId, value1, value2, ...) #

Sets a custom field on the donation. The constituent can pick one or more values. This depends on how the field was created in Bloomerang.
This function replaces the field’s values on the JavaScript object.

fieldIdrequiredThe field’s Bloomerang ID.
valueId(s)requiredThe values’ Bloomerang IDs. For pick one fields, pass in one valueId. For pick multiple fields, you can pass in multiple valueIds, each as a separate argument.
Yes No

=>Bloomerang.RecurringDonation.clearCustomFields() #

Clears all the custom fields for the donation. Call this function to remove any selections left over from a previous submission attempt. Then update the custom fields with values from the form.
This does not delete any custom field values in the Bloomerang database.

Yes No

>CreditCard #

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.

Yes No

=>Bloomerang.CreditCard.spreedlyToken(token) #

Sets the Spreedly token for processing a credit card. Spreedly is a service that reduces PCI compliance scope by securely handling credit card processing.

Bloomerang recommends you use the Spreedly Express Payment Widget to obtain a Spreedly token.

tokenrequiredThe Spreedly token that should be charged.
Yes No

=>Bloomerang.CreditCard.expirationMonth(month) #

The month the credit card expires.

monthrequiredThe expiration month
Yes No

=>Bloomerang.CreditCard.expirationYear(year) #

The year the credit card expires.

yearrequiredThe expiration year
Yes No

>InKind #

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.

Yes No

=>Bloomerang.InKind.marketValue(value) #

The gift’s fair market value.

valuerequiredThe gift’s fair market value. String in U.S. formatting, or number.
Yes No

=>Bloomerang.InKind.description(text) #

A description of the gift.

textrequiredThe description of the gift. Up to 255 characters.
Yes No

=>Bloomerang.InKind.type(type) #

Sets the type of gift (whether it was goods or services).

typerequiredThe type of gift. Valid values are Goods, Services.
Yes No

=>Bloomerang.InKind.goods() #

Sets the gift type to Goods. Shortcut for Bloomerang.InKind.type(“Goods”).

Yes No

=>Bloomerang.InKind.services() #

Sets the gift type to Services. Shortcut for Bloomerang.InKind.type(“Services”).

Yes No

>Check #

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.

Yes No

=>Bloomerang.Check.number(number) #

Sets the check number.

numberrequiredThe check number
Yes No

=>Bloomerang.Check.date(date) #

Sets the date of the check.

daterequiredThe date the check was written. String in yyyy-mm-dd format.
Yes No

>Eft #

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.

Yes No

=>Bloomerang.Eft.type(type) #

Sets the type of EFT account (checking or savings).

typerequiredThe EFT account type. Valid values are Checking, Savings.
Yes No

=>Bloomerang.Eft.checking() #

Sets the EFT account type to Checking. Shortcut for Bloomerang.Eft.type(“Checking”).

Yes No

=>Bloomerang.Eft.savings() #

Sets the EFT account type to Savings. Shortcut for Bloomerang.Eft.type(“Savings”).

Yes No

=>Bloomerang.Eft.accountNumber(number) #

Sets the account number that will be charged with the EFT.

numberrequiredThe account number that will be charged
Yes No

=>Bloomerang.Eft.routingNumber(number) #

Sets the bank’s nine-digit routing number.

numberrequiredThe routing number for the EFT account
Yes No

Submission Functions #

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

Yes No

>Bloomerang.Api.donate() #

Posts a one-time donation to Bloomerang. Set up all the data you want to post using the data functions before calling this function. Or set up the data as part of your Bloomerang.Api.OnSubmit handler.

Yes No

>Bloomerang.Api.recurringDonate() #

Posts a recurring donation to Bloomerang. Set up all the data you want to post using the data functions before calling this function. Or set up the data as part of your Bloomerang.Api.OnSubmit handler.

Yes No

>Bloomerang.captchaResponse(response) #

Google reCAPTCHA sends a Base64-encoded response to the form after client-side validation. Use this function to pass the CAPTCHA response from Google to Bloomerang.
For this function to work, CAPTCHA must be turned on in Bloomerang for the type of form you are using (transaction or interaction).

responserequiredThe CAPTCHA response from Google
Yes No

>Bloomerang.continueFinancialSubmission(form) #

This helper function checks that you are not submitting financial information more than once.
Call this immediately before submitting the form. If it returns true, the form has not been submitted. If it returns false, do not continue the submission. Another submission for the same form is already in progress.

formrequiredThe form’s JavaScript DOM element
Yes No

>Bloomerang.cancelFinancialSubmission(form) #

A helper function to clear the restriction set by Bloomerang.continueFinancialSubmission().
Call this when you are finished processing the form. This might be after an error response or if you want the constituent to be able to submit the form again.

formrequiredThe form’s JavaScript DOM element
Yes No