DonorSession
- churchType: string
_id requiredRoster identifier of the church this record belongs to.
- expiresType: stringFormat: date-time
_at requiredDate and time the link or session stops being valid, in UTC.
- idType: stringrequired
Identifier of this visit to the donor flow, not a donor identifier.
- modeType: "pct" or "fixed"enumrequired
How the recurring gift is calculated: pct is a percentage; fixed is a fixed dollar amount.
- statusType: stringenumrequired
Progress of this donor session. The current service reports created, opened, completed and expired. Other declared states are reserved and are not currently produced.
valuescreatedopenedin_progresscompletedexpiredabandonedfailed - valueType: numberrequired
Giving amount for the selected mode: a percentage for pct, or US dollars for fixed.
- donorType: nullableProperties: 7
The donor verified in this session: name, email, phone and mailing address. Present once the session is completed, and null when the verified profile is not available. It is returned only where financial integration is enabled, which today is the sandbox; production returns null. Birth date, government identifiers, documents and bank details are never included.
- enrollmentType: string
_id The recurring gift this session created. Present once the session is completed; read the gift with
GET /v1/enrollments/{id}. - fundType: string
Fund or designation for the gift in your platform, as you sent it when creating the session. It does not change where money goes.
- fundsType: array of objectProperties: 4
How the donor split the gift among funds of the same church, as you sent it when creating the session: your fund identifier, the name, and the percent or the amount. It does not change where money goes.
- referenceType: string
Your platform's identifier for the donor, as you sent it when creating the session.
- urlType: stringFormat: uri
Hosted flow URL — returned once, on the creating
201only. The embedded token is single-use with a 30-minute TTL.