Funds

The Fundraise API allows to manage comprehensive fundraising activities by handling funds (base entity for collecting money), campaigns (targeted fundraising initiatives tied to specific funds), pledges (promises for future donations), and actual donations. Create and track multiple fundraising campaigns simultaneously, each connected to one or more funds, while managing incoming donations and pledges.

Endpoints

The Donation object

A donation records an actual monetary contribution to a specific fund, optionally associated with a campaign and potentially fulfilling one or more pledges through the applications array. Each donation tracks its amount, currency, and can be linked to a specific customer, sales channel, and campaign, with optional notes and external references for integration purposes. If a donation fullfils a pledge, it can be linked to the corresponding pledge by pledgeId while creating the donation (The applications will be handled automatically and are not allowed to be set by payload).

Attributes

_id

Required

string

The ID of the Donation

amount

Required

number

The amount of the donation

currency

Required

string

The currency of the donation

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWDBRLBWPNADKESSCRTRYSZLLSLTZSUGXZMWZWGGHSNGNSLELRDXOF

customerId

Required

string

The ID of the customer of the donation

fundId

Required

string

The ID of the fund of the donation

sellerId

Required

string

The ID of the seller owning the donation

createdAt

Required

string date-time

An ISO timestamp indicating when the donation was created.

updatedAt

Required

string date-time

An ISO timestamp indicating when the donation was updated.

Optional Attributes

Collapse all

applications

Optional

array

An array of pledges that have been fulfilled through this donation.

applications[].pledgeId

Required

string

The ID of the pledge that was fulfilled through this donation.

applications[].amount

Required

number

The amount of the donation that was applied to the pledge.

campaignId

Optional

string

The ID of the campaign of the donation

salesChannelId

Optional

string

The ID of the sales channel of the donation

notes

Optional

string

The notes of the donation

externalId

Optional

string

The external ID of the donation

cartItemId

Optional

string

The ID of the cart item from which the donation created

appliedAt

Optional

string date-time

An ISO timestamp indicating when the donation was applied. (esp. helpful for donations from external integrations)

Was this section helpful?

Yes No

{
  "_id": "string",
  "amount": 1,
  "currency": "EUR",
  "applications": [
    {
      "pledgeId": "string",
      "amount": 1
    }
  ],
  "customerId": "string",
  "fundId": "string",
  "campaignId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "externalId": "string",
  "cartItemId": "string",
  "appliedAt": "2030-01-23T23:00:00.123Z",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create a Donation

Payload

amount

Required

number

The amount of the donation

fundId

Required

string

The ID of the fund of the donation

customerId

Required

string

The ID of the customer of the donation

Optional Attributes

Collapse all

campaignId

Optional

string

The ID of the campaign of the donation

salesChannelId

Optional

string

The ID of the sales channel of the donation

notes

Optional

string

The notes of the donation

externalId

Optional

string

The external ID of the donation

appliedAt

Optional

string date-time

An ISO timestamp indicating when the donation was applied. (esp. helpful for donations from external integrations)

pledgeId

Optional

string

The ID of the pledge that will fulfill (partly or fully) through this donation.

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "amount": 1,
  "campaignId": "string",
  "fundId": "string",
  "customerId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "externalId": "string",
  "appliedAt": "2030-01-23T23:00:00.123Z",
  "pledgeId": "string"
}

{
  "_id": "string",
  "amount": 1,
  "currency": "EUR",
  "applications": [
    {
      "pledgeId": "string",
      "amount": 1
    }
  ],
  "customerId": "string",
  "fundId": "string",
  "campaignId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "externalId": "string",
  "cartItemId": "string",
  "appliedAt": "2030-01-23T23:00:00.123Z",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get a Donation

Parameter

Required

The ID or external ID of the donation to retrieve. In case of external ID, the external ID must be prefixed with 'externalId:'.

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "amount": 1,
  "currency": "EUR",
  "applications": [
    {
      "pledgeId": "string",
      "amount": 1
    }
  ],
  "customerId": "string",
  "fundId": "string",
  "campaignId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "externalId": "string",
  "cartItemId": "string",
  "appliedAt": "2030-01-23T23:00:00.123Z",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}