Skip to content

PFRP

Peer-to-Peer Registration - Primary#

Occurrence: A participant has registered as a fundraiser for a site. In addition to creating the participant as an entity in the system, the process creates the fundraiser's page.

Co-Occurrence: If the participant registers to create a new team, or to join an existing team, separate transactions will be generated to indicate this. You should process PFRP before PFTC (which creates a new team) or PFTA (which associates a fundraiser with an existing team).

Key data: The page identifier of the fundraiser's page is returned, to which any participation fees or additional donations made by the fundraiser themselves during the registration process will be recorded. The transaction identifies the site the fundraiser is associated with, and provides basic details about the participant. The participant is associated with a supporter record, which may hold more details about the individual depending on how the registration process was laid out.

Note

If a participant is joining as member of an existing team, form settings can determine whether values for the transactional Other 1 - 4 and Appeal Code fields should be inherited from the team. Default behaviour is to store the the values supplied on the page.

Export file columns#

Account ID#

Identifies the subaccount this item belongs to

Example: 94

Supporter ID#

The unique numerical database identifier for a supporter.

Example: 212200 Default: 0

Supporter Email#

The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated. <= 500 characters

Example: otto.nv@example.com

Date Created#

The date a supporter was created. [ISO 8601 format date]

Example: 2024-12-01

Date Modified#

The date a supporter was last modified. [ISO 8601 format date]

Example: 2024-12-01

Campaign Number#

The database identifier of a page belonging to a fundraiser.

Example: 4031

Campaign Type#

PFRPThe Campaign Type is used to determine the layout of the data columns in the output stream.

Campaign ID#

A reference name given to this fundraisers's page. <= 100 characters

Campaign Date#

The recorded date [YYYY-MM-DD] of this transaction. If left blank during transactional import, the service will apply the import date. The reference timezone for this service is US/Eastern.

Example: 2024-12-01

Campaign Time#

The recorded time [HH:MM:SS] of this transaction. The reference timezone for this service is US/Eastern.

Example: 13:53:02 Default: 00:00:00

Campaign Status#

No output for this transaction type.

Campaign Data 1#

The numerical database identifier for a Peer-to-Peer site.

Campaign Data 2#

The reference name used to refer to this site within the dashboard. <= 100 characters

Campaign Data 3#

The database identifier for a participant.

Campaign Data 4#

The fundraising goal set by the participant during registration.

Campaign Data 5#

No output for this transaction type.

Campaign Data 6#

No output for this transaction type.

Campaign Data 7#

The database identifier for the selected participant type.

Campaign Data 8#

The name identifying a type of participant. <= 150 characters

Campaign Data 9#

The amount to raise for the selected participant type.

Campaign Data 10#

The type of goal set for the selected participant type.

Allowed values:

FIXED SUGGESTED MINIMUM

Campaign Data 11#

No output for this transaction type.

Campaign Data 12#

No output for this transaction type.

Campaign Data 13#

No output for this transaction type.

Campaign Data 14#

The unique numerical database identifier for a supporter.

Example: 212200 Default: 0

Campaign Data 15#

The role assigned to a participant. A participant can register to take part as an individual, or choose to be the captain or a member of a fundraising team. The role can change over time, as a participant can move from fundraising on their own, to becoming part of a team, or leave a team.

Allowed values:

Individual Team Captain Team Member

Campaign Data 16#

The database identifier of a page belonging to a team of fundraisers.

Example: 5042

Campaign Data 17#

A reference name given to a team's page. <= 100 characters

Campaign Data 18#

No output for this transaction type.

Campaign Data 19#

No output for this transaction type.

Campaign Data 20#

No output for this transaction type.

Campaign Data 21#

Other 1: A client defined tagged field which can be used to store any additional data that may relate to the current transaction. <= 500 characters

Example: Text containing some information that could prove useful when we handle this transaction, for example additional notes from a supporter directly relating to this particular donation.

Campaign Data 22#

Other 2: A client defined tagged field which can be used to store any additional data that may relate to the current transaction. <= 500 characters

Example: Text containing some information that could prove useful when we handle this transaction, for example additional notes from a supporter directly relating to this particular donation.

Campaign Data 23#

Other 3: A client defined tagged field which can be used to store any additional data that may relate to the current transaction. <= 500 characters

Example: Text containing some information that could prove useful when we handle this transaction, for example additional notes from a supporter directly relating to this particular donation.

Campaign Data 24#

Other 4: A client defined tagged field which can be used to store any additional data that may relate to the current transaction. <= 500 characters

Example: Text containing some information that could prove useful when we handle this transaction, for example additional notes from a supporter directly relating to this particular donation.

Campaign Data 25#

No output for this transaction type.

Campaign Data 26#

No output for this transaction type.

Campaign Data 27#

No output for this transaction type.

Campaign Data 28#

No output for this transaction type.

Campaign Data 29#

No output for this transaction type.

Campaign Data 30#

No output for this transaction type.

Campaign Data 31#

No output for this transaction type.

Campaign Data 32#

No output for this transaction type.

Campaign Data 33#

No output for this transaction type.

Campaign Data 34#

No output for this transaction type.

Campaign Data 35#

An appeal code assigned to this submission.

The value may be passed as a field present on the page, or with the url parameter supporter.appealCode. Any appeal code will be recorded on the supporter's record, and in regular page processing it will also be noted on the transactional level.

When posting data using processPage or processCardPayment, the function of this field is more flexible, and can be either part of the supporter object or of the page object, and will be stored separately in each. The page-builder behaviour can easily be replicated by passing identical values for appealCode to both the page object and the supporter object in the post request.

<= 300 characters

Example: EOY

External Reference 1#

No output for this transaction type.

External Reference 2#

No output for this transaction type.

External Reference 3#

No output for this transaction type.

External Reference 4#

No output for this transaction type.

External Reference 5#

No output for this transaction type.

External Reference 6#

No output for this transaction type.

External Reference 7#

No output for this transaction type.

External Reference 8#

No output for this transaction type.

External Reference 9#

No output for this transaction type.

External Reference 10#

No output for this transaction type.

Email Address#

The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated. <= 500 characters

Example: otto.nv@example.com

Title#

A supporter's title to be used in salutations <= 50 characters

Example: Dr

First Name#

A supporter's first name <= 500 characters

Example: Otto

Middle Name#

A supporter's middle name <= 500 characters

Example: Niemand

Last Name#

A supporter's last name <= 500 characters

Example: Normalverbraucher

Address 1#

The first line of the supporter's address <= 1000 characters

Address 2#

The second line of the supporter's address <= 1000 characters

Address 3#

The third line of the supporter's address <= 1000 characters

City#

The city in a supporter's address <= 500 characters

Example: Musterstadt

Region#

The supporter's region, state, county, province or similar <= 500 characters

Example: Musterregion

Country#

The supporter's country <= 500 characters

Example: DE

Phone Number#

The primary phone number for a supporter <= 200 characters

Example: +49 4066969123