Preview a commitment payment receipt
Resolves donor and designation from the organization-owned commitment and renders the actual receipt plan for the proposed payment. Amount may be zero, selecting pay_fail rather than pay_receipt. Does not create a payment, advance the commitment, charge or send email. Honors manual recognition requirements, configured templates, suppression and preferences. Requires permission: one of donations, reports_view, reports_manage.
Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Commitment id in the current organization.
Body
Validated request fields for this operation.
Total amount, at most two decimal places. Splits must sum exactly to this amount.
x >= 075
Registered compatibility payment-method ID. DAF/QCD accept received-money methods1,2,4,7.
1
"2026-10-20T12:00:00Z"
10"$"
100"goods"
100"1042"
Enables manual Direct-gift recognition; requires donor, active type and positive amount.
false
24
Required when addSoftCredit is enabled; cannot exceed the total gift.
x >= 025
Active manual type; automatic DAF/QCD types are not selectable.
2
Compatibility boolean flag; use0/1 or false/true.
false
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.
Compatibility boolean flag; use0/1 or false/true.
false
Response
Operation result.
available, skipped, suppressed, unavailable "available"
"no_template"
pay_receipt, pay_fail "pay_receipt"