Skip to navigation
Gift ProcessingDonations

Merge Donations

Merge one donation into another. The donation named by into is kept and keeps its ID. The donation named by from is soft-deleted and points at the into donation.

The response is the into donation after the merge. A value already set on it is kept. A value it is missing can be filled with the value from the from donation.

A merge cannot be undone. Repeating a completed merge is safe: it returns the into donation again. The merge emits a donation.updated event for the into donation and a donation.deleted event for the from one.

Errors

  • 400 when the same donation is on both sides.
  • 404 when a donation does not exist.
  • 409 when an input is deleted or merged. The problem type is donation_deleted or donation_merged, and a merged input carries the ID of the donation it was merged into. A deleted or merged donation still exists, so a write conflicts with its state.
  • 409 when both donations are reconciled to a deposit. The problem type is donation_merge_conflict.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringOptional
The idempotency key for the request.

Request

This endpoint expects an object.
fromstringRequired

The donation to merge. It is soft-deleted and points at the into donation.

intostringRequired
The donation that is kept. It keeps its ID.

Response

The merge is done. The body is the into donation, with values from the from donation filled in where it had none.
idstringRead-only
The unique identifier for the donation in Chariot's system.
amount_grosslong
The total amount of the donation in minor units of the currency. For dollars, for example, this is cents.
amount_netlong
The amount of the donation that the nonprofit will receive after processing fees are deducted in minor units of the currency. For dollars, for example, this is cents.
amount_feelong
The amount of the fee that was deducted from the donation in minor units of the currency. For dollars, for example, this is cents.
currencystring

The ISO 4217 code for every amount on the donation. Defaults to USD unless the source reports another currency.

created_atdatetimeRead-only
The date and time the donation record was created in Chariot.
external_idstringOptional
Identifier provided by the source or granting organization, when present.
source_idstringOptional

The identifier of the Source that sent this donation.

individual_gift_amountlong or nullOptional
The portion of the gross amount contributed directly by the donor.
exchange_rateobject or nullOptional

The exchange rate used to convert the donation into target_currency. Null when currency is already the target currency, or when no rate was reported.

donation_typeenumOptional

The kind of gift.

  • individual: a gift from an individual donor.
  • match: a company’s match of an employee’s gift.
  • daf: a grant from a donor-advised fund.
  • other: any other kind of gift.
  • unknown: the source did not report the kind of gift.
Allowed values:
frequencyenumOptional

Whether the donor set the gift to repeat.

  • one_time: the donor gave once.
  • recurring: the donor set the gift to repeat.
  • unknown: the source did not report whether the gift repeats.
Allowed values:
effective_datedatetimeOptional
The date of the donation, as reported by the source. Expressed in RFC 3339 format.
grantorobjectOptional
The entity responsible for issuing a grant or payment to a recipient.
created_byobjectOptional
Who created the donation.
external_distribution_idstringOptional
The platform's identifier for the payout that carried this donation. Platforms such as Benevity batch many donations into one payout, so several donations can share the same value.
recipientobjectOptional
The nonprofit the donation was made out to, as named by the source.
purposestringOptional
A description of the donor's intent for the donation. This is useful to understand how the donor intended the donation to be used. For example, "Where needed most" or "General Operating Support" or "Specific Campaign".
notestringOptional
An informational note from the donor to the nonprofit about the donation. This may contain a message or other useful information that the donor wants to share with the nonprofit.
attributionobjectOptional
How the donation is attributed to a donor.
initiationobjectOptional
How and where the donor initiated the gift.
settlementobjectOptional
How the funds are moving from the donor to the recipient.
donor_advised_fund_grantobjectOptional
Details specific to Donor Advised Fund donations. Empty when the donation did not come from a DAF provider.
metadatamap from strings to anyOptional

Arbitrary key-value pairs recorded against the donation. Use this for reconciliation data, campaign identifiers, or other integration data.

corporate_matchobjectOptional
Details specific to matched donations. Empty when no corporate sponsor matched the donation.
propertieslist of objectsOptional
A list of custom properties for the donation.
artifactslist of objectsOptional

A list of source artifacts that were used to create the donation. These can include the raw source files (PDFs, CSVs, etc.) that were received from upstream platforms or systems.

updated_atdatetimeOptionalRead-only
The date and time when the donation was last updated.
canceled_atdatetime or nullOptionalRead-only
When the donation was canceled. If set, the donor's payment did not complete and the recipient did not receive the gift. Expressed in RFC 3339 format.
deleted_atdatetime or nullOptionalRead-only

When the donation was deleted or merged. Null for a live donation. GET /v1/donations/{id} still returns a deleted or merged donation, but GET /v1/donations (list) excludes it. Expressed in RFC 3339 format.

merged_into_donation_idstring or nullOptionalRead-only

The donation this one was merged into. Set only for a merged donation, as a donation ID. Null for a live or plain-deleted donation. Follow it to the donation that now holds the gift.

payment_statusenumOptionalRead-only
The payment status of the donation. Indicates the current state of the payment lifecycle.
Allowed values:
payment_source_idstringOptionalDeprecated

Deprecated. Use source_id.

platformobjectOptionalDeprecated
Deprecated. Information about the platform that facilitated the donation. Empty when no platform facilitated the donation.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error