Get Contributions

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/contributions \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'

{
  "data": [
    {
      "id": "6710f34fd5061afeec3eab57",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z",
      "type": "CASH",
      "amount": 1000,
      "contributionDate": "2025-01-01T00:00:00.000Z",
      "contributionReceivedAt": "2023-11-07T05:31:56Z",
      "liquidationInitiatedAt": null,
      "receivedTokensAt": null,
      "status": "PAID_OUT",
      "stocks": {
        "quantity": 2,
        "tickers": [
          "AAPL",
          "MSFT"
        ]
      },
      "crypto": {
        "quantity": 1,
        "token": "BTC"
      },
      "frequency": "one-time",
      "paymentMethod": {
        "type": "Card",
        "logoUrl": "https://example.com/logo.png",
        "last4": "4242"
      },
      "depositId": "8810f34fd5061afeec3eab67",
      "campaign": {
        "id": "7710f34fd5061afeec3eab78",
        "name": "Mission 2025"
      },
      "subcampaign": {
        "id": "7710f34fd5061afeec3eab79",
        "name": "Toy Drive"
      },
      "dedication": "In memory of Lois Lane",
      "donorNotes": "Happy to support this cause!",
      "donor": {
        "id": "6710f34fd5061afeec3eab57",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "phone": "+1234567890",
        "address": {
          "line1": "123 Main St",
          "line2": "Apt 1",
          "city": "Anytown",
          "state": "CA",
          "zip": "12345"
        },
        "activeRecurringCount": 1,
        "latestContributionDate": "2025-01-01T00:00:00.000",
        "locationIds": [
          "6710f34fd5061afeec3eab57"
        ],
        "totalContributionsCount": 10
      },
      "donorCoveredFees": false,
      "subscriptionId": "6710f34fd5061afeec3eab57",
      "anonymous": false,
      "locationId": "6710f34fd5061afeec3eab58",
      "metadata": {
        "orderId": "12345",
        "campaign": "spring-2026"
      }
    }
  ],
  "totalCount": 100
}

Contributions

Get Contributions

Returns contributions for the nonprofit based on the provided filters.

Contribution Types

There are 5 types of contributions representing the different asset types Overflow supports: Cash, Crypto, DAF, Stock, and Manual contributions. They can be differentiated by the discriminator key type in the response.

Final Confirmation States

A contribution is considered successful or confirmed when it reaches the following status:

CASH: PAID_OUT
MANUAL_CASH: CONFIRMED
CRYPTO: CONFIRMED
STOCK: CONTRIBUTION_RECEIVED or BILLED
DAF: CONTRIBUTION_RECEIVED

Status Definitions by Asset Type

Cash

PENDING: Awaiting authorization by the payment gateway.
PROCESSING: Contribution is being processed. This status only applies to ACH/Bank payments.
CONFIRMED: Contribution has been authorized by the payment gateway.
PAID_OUT: Contribution has been settled and paid out to the NPO.
FAILED: Something went wrong and the contribution was never received.
VOIDED: Contribution was voided such that it never confirmed.
REFUNDED: Contribution was refunded, typically at the request of the donor.
CHARGEBACK: Disputed by the donor or rejected by the bank.

Manual Cash

PENDING: Awaiting confirmation from the NPO (currently in an open gift entry batch).
CONFIRMED: Confirmed by the NPO (gift entry batch has been closed).
VOIDED: Contribution was voided from a gift entry batch.

Crypto

PENDING: Initiated by a donor but not yet sent via their wallet.
CONFIRMED: The crypto gift has been received by the NPO.
PAYOUT_SENT: The crypto gift net-funds were processed by our team.
PAID_OUT: The crypto gift has been settled and paid out to the NPO.

DAF (Donor Advised Funds)

INITIATED: The DAF gift has been initiated but not yet captured.
IN_PROCESS: The DAF gift has been captured and is being sent to the NPO.
CONTRIBUTION_RECEIVED: The DAF gift has been received by the NPO.
PAYOUT_SENT: The DAF gift net-funds were processed by our team.
PAID_OUT: The DAF gift has been settled and paid out to the NPO.
FAILED: The DAF gift has failed to be captured or initiated.
CANCELED / ABANDONED: The DAF gift has been canceled or abandoned.

Stock

VERIFYING_INFORMATION: Gathering transaction information from the donor.
INITIATED: Donor intent to give received through the platform.
IN_PROCESS: Forms sent to the sending brokerage and being processed.
DONOR_BROKERAGE_SENT_SHARES: Donor has seen shares leave their account.
RECEIVED_FOR_LIQUIDATION: Shares received by Overflow’s brokerage.
LIQUIDATION_INITIATED / LIQUIDATION_COMPLETE: Selling shares to lock in value.
CONTRIBUTION_RECEIVED: NPO has received the shares or liquidation cash.
BILLED: Successfully billed the client for this contribution.
COMPLETED: Client has paid the bill; gift lifecycle complete.
PAYOUT_SENT / PAID_OUT: Proceeds transferred and settled to the NPO.
TROUBLESHOOTING / DONOR_UNRESPONSIVE: Delays or loss of contact with donor.
CANCELED: Transaction never fully processed or was canceled.

GET

api

contributions

Get Contributions

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/contributions \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'

{
  "data": [
    {
      "id": "6710f34fd5061afeec3eab57",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z",
      "type": "CASH",
      "amount": 1000,
      "contributionDate": "2025-01-01T00:00:00.000Z",
      "contributionReceivedAt": "2023-11-07T05:31:56Z",
      "liquidationInitiatedAt": null,
      "receivedTokensAt": null,
      "status": "PAID_OUT",
      "stocks": {
        "quantity": 2,
        "tickers": [
          "AAPL",
          "MSFT"
        ]
      },
      "crypto": {
        "quantity": 1,
        "token": "BTC"
      },
      "frequency": "one-time",
      "paymentMethod": {
        "type": "Card",
        "logoUrl": "https://example.com/logo.png",
        "last4": "4242"
      },
      "depositId": "8810f34fd5061afeec3eab67",
      "campaign": {
        "id": "7710f34fd5061afeec3eab78",
        "name": "Mission 2025"
      },
      "subcampaign": {
        "id": "7710f34fd5061afeec3eab79",
        "name": "Toy Drive"
      },
      "dedication": "In memory of Lois Lane",
      "donorNotes": "Happy to support this cause!",
      "donor": {
        "id": "6710f34fd5061afeec3eab57",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "phone": "+1234567890",
        "address": {
          "line1": "123 Main St",
          "line2": "Apt 1",
          "city": "Anytown",
          "state": "CA",
          "zip": "12345"
        },
        "activeRecurringCount": 1,
        "latestContributionDate": "2025-01-01T00:00:00.000",
        "locationIds": [
          "6710f34fd5061afeec3eab57"
        ],
        "totalContributionsCount": 10
      },
      "donorCoveredFees": false,
      "subscriptionId": "6710f34fd5061afeec3eab57",
      "anonymous": false,
      "locationId": "6710f34fd5061afeec3eab58",
      "metadata": {
        "orderId": "12345",
        "campaign": "spring-2026"
      }
    }
  ],
  "totalCount": 100
}

Authorizations

x-client-id

string

header

required

Client ID for API authentication

x-api-key

string

header

required

API Key for API authentication

Query Parameters

limit

number

default:25

The number of contributions to return.

Required range: 1 <= x <= 100

page

number

default:1

The page number of the contributions to return.

Required range: x >= 1

minimumUpdatedDate

string<date-time>

The minimum updated date of the contributions to return.

Example:

"2025-01-01"

maximumUpdatedDate

string<date-time>

The maximum updated date of the contributions to return.

Example:

"2025-02-01"

minimumInitiatedDate

string<date-time>

The minimum date the contributions were initiated to return.

Example:

"2025-01-01"

maximumInitiatedDate

string<date-time>

The maximum date the contributions were initiated to return.

Example:

"2025-02-01"

statusBucket

enum<string>[]

Filter contributions by status buckets.

Available options:

CANCELED,

CONFIRMED,

PENDING,

FAILED

Example:

["PENDING", "CONFIRMED"]

campaignId

string

Filter by campaign id.

subcampaignId

string

Filter by subcampaign id.

locationIds

string[]

Filter by location ids.

Response

200 - application/json

data

object[]

required

List of contributions.

Show child attributes

totalCount

number

required

Total number of contributions matching the filters.

Example:

100

Common Patterns Create Contribution

⌘I

Documentation Index

Authorizations

Query Parameters

Response