Skip to main content
POST
Preview a commitment payment receipt

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

commitment_id
integer
required

Commitment id in the current organization.

Body

application/json

Validated request fields for this operation.

amount
number
required

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

Required range: x >= 0
Example:

75

method
required

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

Example:

1

created_at
string<date-time> | null
Example:

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

currency
string | null
Maximum string length: 10
Example:

"$"

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_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

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.

do_not_email

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

Example:

false

Response

Operation result.

status
enum<string>
required
Available options:
available,
skipped,
suppressed,
unavailable
Example:

"available"

reason
string | null
required
Example:

"no_template"

trigger
enum<string>
required
Available options:
pay_receipt,
pay_fail
Example:

"pay_receipt"

recipient
object
required
previews
object[]
required
unavailable_designations
string[]
required
recipients
object[]
required