ChangeUp DMS

Fetch and filter donations

get

List all donation(s) associated with a partner account in a paginated list.

Query parameters

limitintegerOptional

Limit of records to return

Example: 30

pageintegerOptional

Which page to return. This endpoint is paginated.

Example: 1

charityIdstringOptional

(Optional) - Filter by charity Id

Example: cml8u99jg0004jy017qbr7gtf

transactionIdstringOptional

(Optional) - Your transaction id used to create the donation(s)

Example: p12444

startDatestringOptional

(Optional) - Filter donations with a start date MM/DD/YYY

Example: 05-10-2025

endDatestringOptional

(Optional) - Filter donations with a end date

Example: 06-10-2025

sortOrderstringOptional

(Optional) - sort asc or desc

Example: desc

sortBystringOptional

(Optional) - sort by any field

Example: transactionId

Header parameters

x-api-keyanyOptional

(Required)

Example: ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6

x-client-idanyOptional

(Required)

Example: 64ea17367eb6abe306f06bc5bcb918cc4

Responses

200

Sucess

application/json

get

/v1/donations

HTTPcURLJavaScriptPython

GET /v1/donations HTTP/1.1
Host: donations.api.changeup.com
Accept: */*

200

Sucess

{
  "docs": [
    {
      "id": "cmmz6lpxc004mmt01fc1ea4nl",
      "partnerId": "cm8brntw4000508lhetd69ncv",
      "daf": "benevity",
      "dafAccountType": "MERCHANT_PAID_FEES",
      "amount": 5,
      "causeId": "840-050395601",
      "charityId": "cml60yr0j0000k1012zx8y2gr",
      "transactionId": "91c0418d-9278-4b66-b3c5-9460787457be",
      "currency": "USD",
      "country": "US",
      "jobId": null,
      "invoiceId": null,
      "receipt": null,
      "environment": "test",
      "type": "user",
      "transactionOrderDate": "2026-03-20T17:37:03.892Z",
      "reason": null,
      "source": "USER",
      "widgetId": "cm8bs2hj1000elb0163rwv28x",
      "delayReportBy": 0,
      "status": "complete",
      "invoiced": false,
      "generateReceipt": false,
      "invoicedAt": null,
      "reportTransactionAt": "2026-03-20T17:37:08.873Z",
      "createdAt": "2026-03-20T17:37:08.651Z",
      "updatedAt": "2026-03-20T17:37:08.875Z",
      "benevityDonationCreatedAt": "2026-03-20T17:37:10.436Z",
      "benevityResponse": [
        {
          "data": {
            "id": "1f713e45-b4f2-416b-baa5-2e12aedb27ee",
            "type": "donations",
            "attributes": {
              "funds": {
                "amount": 5,
                "source": "USER",
                "paymentType": "DONATION_REPORT",
                "currencyCode": "USD"
              },
              "state": {
                "processingStatus": "ACCEPTED",
                "statusLastUpdated": "2026-03-20T17:37:10.289Z"
              },
              "destination": {
                "recipientId": "840-050395601"
              }
            }
          }
        }
      ]
    }
  ],
  "meta": {
    "total": 10,
    "lastPage": 11,
    "currentPage": 1,
    "perPage": 30,
    "prev": null,
    "next": 2
  }
}

Create donation

post

Send a single or batch of donations.

Creates a single donation or batch donations. Batch donations accepts a limit of 15 per request. to any nonprofit.

Note: To schedule a future to be posted at a future date, set the delayReportBy field (e.g., a value of 5 will delay the report for 5 days). This allows you to cancel a donation before it is finalized. Please note that once a donation is posted after the delay period, it cannot be cancelled. The maximum allowable delay is 90 days.

Header parameters

x-api-keyanyOptional

(Required) - API Key Secret

Example: ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6

x-client-idanyOptional

(Required) - Client Secret

Example: 64ea17367eb6abe306f06bc5bcb918cc4

Body

application/json

typestringOptional

requiredstring[]Optional

Responses

201

Success

application/json

403

Error

application/json

post

/v1/donations

HTTPcURLJavaScriptPython

POST /v1/donations HTTP/1.1
Host: donations.api.changeup.com
Content-Type: application/json
Accept: */*
Content-Length: 655

"{\n    \"donations\": [\n        {\n            \"userDonationAmount\": 50, //(number - required) number is represented in cents,\n            \"partnerDonationAmount\": 50, // (number - optinal) number is represented in cents,\n            \"delayReportBy\": \"number (optional) // delay transaction from xdays\",\n            \"causeId\": \"string (required) // eg causeId from DMS\",\n            \"widget\": \"string (required) // eg widgetId from DMS\",\n            \"transactionId\": \"string (required) // eg: internaltransaction id\",\n            \"transactionOrderDate\": \"string (optional) // eg: 2026-02-07T23:58:19\" \n        }\n    ]\n}"

[
  {
    "statusCode": 200,
    "success": true,
    "id": "cmmz7tdu7000mml01kabz72aa",
    "sourceId": "USER",
    "status": "pending",
    "transactionId": "eff3db80-3aeb-4d0e-b32f-e8f42708962b"
  }
]

Fetch donation by id

get

Use to fetch the status and details of a single donation by Id

Path parameters

idstringRequired

(Required) - donation id

Example: cmmz7tdu7000mml01kabz72aa

Header parameters

x-api-keystringOptional

(Required)

Example: ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6

x-client-idstringOptional

(Required)

Example: 64ea17367eb6abe306f06bc5bcb918cc4

Responses

200

Success

application/json

idstringOptional

partnerIdstringOptional

dafstringOptional

dafAccountTypestringOptional

amountintegerOptional

causeIdstringOptional

charityIdstringOptional

transactionIdstringOptional

currencystringOptional

countrystring · colorOptional

jobIdstringOptional

invoiceIdnullOptional

receiptnullOptional

environmentstringOptional

typestringOptional

transactionOrderDatestring · date-timeOptional

reasonstringOptional

sourcestringOptional

widgetIdstringOptional

delayReportByintegerOptional

statusstringOptional

invoicedbooleanOptional

generateReceiptbooleanOptional

invoicedAtnullOptional

reportTransactionAtstring · date-timeOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

benevityDonationCreatedAtnullOptional

benevityResponsearrayOptional

get

/v1/donations/{id}

HTTPcURLJavaScriptPython

GET /v1/donations/{id} HTTP/1.1
Host: donations.api.changeup.com
Accept: */*

200

Success

{
  "id": "cmkxeytld00039kd2of33musy",
  "partnerId": "cm8brntw4000508lhetd69ncv",
  "daf": "benevity",
  "dafAccountType": "MERCHANT_PAID_FEES",
  "amount": 10,
  "causeId": "840-271720480",
  "charityId": "cm8yp19ue000ijx019ythvd1i",
  "transactionId": "0c3d0149-a19b-4781-b288-b139a2ca0bf9",
  "currency": "USD",
  "country": "840",
  "jobId": "831e69ce-4d7c-4168-9dff-48f8d3c892d5",
  "invoiceId": null,
  "receipt": null,
  "environment": "test",
  "type": "partner",
  "transactionOrderDate": "2026-01-28T02:36:19.372Z",
  "reason": "not needed",
  "source": "COMPANY",
  "widgetId": "cm8bs2hj1000elb0163rwv28x",
  "delayReportBy": 1,
  "status": "cancelled",
  "invoiced": false,
  "generateReceipt": false,
  "invoicedAt": null,
  "reportTransactionAt": "2026-01-29T02:36:19.638Z",
  "createdAt": "2026-01-28T02:36:19.921Z",
  "updatedAt": "2026-01-28T03:11:43.710Z",
  "benevityDonationCreatedAt": null,
  "benevityResponse": [],
  "widget": {
    "id": "cm8bs2hj1000elb0163rwv28x",
    "widgetName": "Test Widget"
  },
  "charity": {
    "id": "cm8yp19ue000ijx019ythvd1i",
    "displayName": "TEAM RUBICON"
  }
}

Cancel a donation

patch

Cancel a donation that has not been posted to a DAF. When a donation is posted, it goes from:

PENDING -> COMPLETED

Donation(s) marked as COMPLETED cannot be canceled.

Once a donation is canceled, the status will be marked as CANCELED.

Field	Type	Description
reason	String	Optional Reason for canceling the donation

Path parameters

idstringRequired

(Required) - donation id

Example: cmmz7tdu7000mml01kabz72aa

Header parameters

x-api-keystringOptional

(Required)

Example: ad44f9tolL0Q64zihoeuFTkA6wRqHWtNRZEaqfJghr6

x-client-idstringOptional

(Required)

Example: 64ea17367eb6abe306f06bc5bcb918cc4

Body

application/json

reasonstringOptional

Responses

200

Success

application/json

messagestringOptional

patch

/v1/donations/{id}/cancel

HTTPcURLJavaScriptPython

PATCH /v1/donations/{id}/cancel HTTP/1.1
Host: donations.api.changeup.com
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "reason": "<string>"
}

200

Success

{
  "message": "donation cmmz7tdu7000mml01kabz72aa cancelled successfully"
}