Introduction

Form-Prepopulation-API

How to prepopulate form values with GET parameter?

All fields of the payment form can be prepopulated. The following parameters can be appended to the corresponding url. These variables can be appended to the javascript embed code or directly to the url address.

👍

This API is available in all FundraisingBox plans.

Fieldnames and values

Name

Values

Description

salutation

Mr. | Mrs.

title

Varchar(50)

first_name

Varchar(100)

last_name

Varchar(100)

company_name

Varchar(100)

address

Varchar(300)

post_code

Varchar(10)

city

Varchar(100)

country

2-letter ISO 3166 country code in uppercase

Set default country in dropdown, e.g. "DE" for "Germany"

email

Varchar(100)

phone

Varchar(100)

amount

Float

Without currency symbols, e.g. 5.50

interval

0 | 1 | 3 | 6 | 12

once, monthly, quarterly, half-yearly, yearly

wants_receipt

no_receipt | receipt_now | receipt_end_of_year

message

Varchar(500)

public_name

Varchar(100)

public_message

Varchar(1000)

wants_newsletter

0 | 1

is_terms_accepted

0 | 1

is_privacy_accepted

0 | 1

birthday

Dateformat YYYY-MM-DD

fb_item_id

Integer

Item ids can be found at “Forms” > ”Edit” > ”Transaction settings” > ”Items” > "Info-Icon at the item",
Item selection is shown and item is preselected,
Item has to be visible in the form.

fb_item_id_fix

Integer

Item selection is hidden and item name is shown
Special case: Item has NOT to be visible in the form.

fb_project_id

Integer

If a project is allocated to an item, this item can be preselected with the corresponding project id as well.
Project ids can be found at "Configuration" > "Projects".

Requirement: there is only one item with this project.

Item selection is shown and item is preselected,
Item has to be visible in the form.

fb_project_id_fix

Integer

Item selection is hidden and item name is shown
Special case: Item has NOT to be visible in the form.

person_custom_field_ID

Mixed (depends on the custom field type)

Custom field ids can be found in “settings”>”Custom fields”.
Custom field has to be added to the form.
Example: to prepopulate the custom field with ID “123“ with the text “example“ use: “person_custom_field_123=example“

donation_custom_field_ID

Mixed (depends on the custom field type)

Custom field ids can be found in “settings”>”Custom fields”.
Custom field has to be added to the form.
Example: to prepopulate the custom field with ID “123“ with the text “example“ use: “donation_custom_field_123=example“

payment_method

direct_debit | sepa_direct_debit | wikando_direct_debit | micropayment_direct_debit | bfs_direct_debit | paypal | sofortueberweisung | micropayment_credit_card | eps | stripe_credit_card | amazon_pay | stripe_apple_pay | stripe_google_pay

Recommendation: do NOT prepopulate Apple Pay and Google Pay, because you do not know if these payment methods are available on the device of the visitor.

Non editable prepopulation

If you do not want that the prepopulated field is editable add a "_fix" to the parameter.
For example: "first_name_fix", "amount_fix", "donation_custom_field_123_fix".

Attention: fixing values will prevent the donor to change or correct values. Use it with care.

📘

Session-API

You can use also the Session API for form value prepopulation. This offers you various advantages.