Skip to main content
POST
Preview gift ownership and sponsorship coverage

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

donor_id
integer
required

Active organization donor; financial party rules depend on giving_source.

Example:

21

designation
required

Organization-owned entity-ID or desig-ID reference, or split allocation references. Array form requires matching split_amounts.

Example:

"entity-42"

amount
number
required

Total amount, at most two decimal places. Splits must sum exactly to this amount.

Required range: x >= 0.01
Example:

75

method
required

Registered compatibility payment-method ID. DAF/QCD accept received-money methods1,2,4,7.

Example:

1

split_amounts
number[] | null

Required when designation is an array; one positive amount per reference.

Required range: x > 0
created_at
string<date-time> | null
Example:

"2026-10-20T12:00:00Z"

currency
string | null
Maximum string length: 10
Example:

"$"

dont_notify

Compatibility boolean flag; use0/1 or false/true.

Example:

false

in_kind_category
string | null
Maximum string length: 100
Example:

"goods"

check_number
string | null
Maximum string length: 100
Example:

"1042"

addSoftCredit
boolean | null

Enables manual Direct-gift recognition; requires donor, active type and positive amount.

Example:

false

soft_credit_donor_id
integer | null
Example:

24

soft_credit_amount
number | null

Required when addSoftCredit is enabled; cannot exceed the total gift.

Required range: x >= 0
Example:

25

soft_credit_split_amounts
number[] | null

For multiple allocations, sum to the soft credit total and never exceed corresponding gift splits.

Required range: x >= 0
soft_credit_type
integer | null

Active manual type; automatic DAF/QCD types are not selectable.

Example:

2

dont_send_soft_credit_email

Compatibility boolean flag; use0/1 or false/true.

Example:

false

is_tax_deductible

Scalar or allocation-aligned tax flag; QCD forces non-deductible treatment.

Example:

false

giving_source
string | null

Canonical source values; known compatibility aliases are normalized. Special sources require daf_qcd_giving_v1.

Maximum string length: 40
Example:

"direct"

advisor_donor_id
integer | null

DAF recommending supporter; named disclosure requires it.

Example:

24

intermediary_donor_id
integer | null

Organization-owned IRA custodian required for QCD.

Example:

30

daf_disclosure
enum<string> | null

DAF acknowledgement disclosure; fund_only requires a nonblank fund name.

Available options:
named,
fund_only,
anonymous,
null
Maximum string length: 16
Example:

"named"

daf_fund_name
string | null

Permitted only for named or fund_only disclosure.

Maximum string length: 191
Example:

"Community Fund"

source_reference
string | null
Maximum string length: 191
Example:

"Grant reference123"

custom_fields
object | null

Organization-defined gift field map. Definitions control keys, scalar types, choices and conditional requirements. Validated before preview; the receipt-preview handler forwards only its explicit preview fields.

Optional existing commitment ID per allocation. Omitted positions mean no link. Each linked schedule must belong to the effective person and allocation.

Example:

42

billing_after_coverage
enum<string> | null

Required when a linked charging schedule receives one or more whole covered periods.

Available options:
resume,
stop,
null
Example:

"resume"

charge_donor

Compatibility boolean flag; use0/1 or false/true.

Example:

false

frequency
integer | null

New recurring frequency is incompatible with special-source/coverage links.

Example:

0

result
string | null
Example:

"Check received"

acknowledgement_status
enum<string> | null
Available options:
acknowledged,
unacknowledged,
null
Example:

"unacknowledged"

acknowledgement_note
string | null
Maximum string length: 1000
Example:

"Thank-you letter pending."

Response

Operation result.

data
object