DonorSessionInput
- churchType: string
_id requiredMust be a church registered to the partner.
- modeType: "pct" or "fixed"enumrequired
Percentage of salary or fixed amount.
- valueType: numbermin:1max:20000required
With mode
pct, the percentage of each paycheck, a whole number from 1 to 35 (12, never12.5). With modefixed, US dollars per paycheck, from 1 to 20000 with at most two decimal places (12.50, never12.345). - donorType:Properties: 3
Information your platform already knows and sends to prefill the donor flow. The donor confirms or corrects it. The raw session prefill is not returned by session reads. Authorized confirmed profile fields can later be sent in donor and donation updates; birth date and identity documents are excluded. Email and mailing address are not accepted: the flow obtains them during identity verification and the donor confirms them.
- donorType: string
_phone Donor phone number, including country code, to prefill the flow (for example +12025550100, a sandbox test number). The donor confirms it. Session reads do not echo raw prefill. The authorized confirmed profile may later include the phone.
- fundType: stringmin length:1max length:60
The fund or designation for this gift in your platform, such as General Fund. Returned in the session and in the enrollment it creates. Surrounding spaces are removed. Roster does not use it to route money.
- fundsType: array of object 1…10
How the donor split this gift among funds of the same church, as your platform shows them, such as 50% to a building fund and 50% to missions, or, for a fixed gift, US$30 to a building fund and US$20 to missions. Each fund has your identifier, an optional name, and either a percent with at most two decimal places or, only with mode
fixed, an amount in dollars. Use the same form for every fund: the percents add up to exactly 100, or the amounts add up exactly tovalue. Identifiers do not repeat. Every donation of the gift then reports the amount of each fund in US cents; if the donor later changes the gift, each fund keeps its share of the split. Roster does not use funds to route money: every fund is the same church bank account. Sendfundorfunds, not both. - referenceType: string
Your platform's identifier for this donor, returned in the session and in the enrollment it creates. Letters, digits, '.', '_', ':' and '-', up to 64 characters; never an email address, phone number or name. Surrounding spaces are removed before the check.