Create Contribution

curl --request POST \
  --url https://server.stage.overflow.co/api/v3/contributions \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --data '
{
  "donorId": "6710f34fd5061afeec3eab57",
  "paymentMethodId": "6710f34fd5061afeec3eab57",
  "amount": 50,
  "campaignId": "6710f34fd5061afeec3eab57",
  "subcampaignId": "6710f34fd5061afeec3eab57",
  "anonymous": true,
  "donorNotes": "Donor would like to give $1,000.00 to the playground project, and the …"
}
'

{
  "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": "[email protected]",
      "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",
      "totalContributionsCount": 10
    },
    "donorCoveredFees": false,
    "subscriptionId": "6710f34fd5061afeec3eab57",
    "anonymous": false
  }
}

POST

api

contributions

Create Contribution

curl --request POST \
  --url https://server.stage.overflow.co/api/v3/contributions \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --data '
{
  "donorId": "6710f34fd5061afeec3eab57",
  "paymentMethodId": "6710f34fd5061afeec3eab57",
  "amount": 50,
  "campaignId": "6710f34fd5061afeec3eab57",
  "subcampaignId": "6710f34fd5061afeec3eab57",
  "anonymous": true,
  "donorNotes": "Donor would like to give $1,000.00 to the playground project, and the …"
}
'

{
  "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": "[email protected]",
      "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",
      "totalContributionsCount": 10
    },
    "donorCoveredFees": false,
    "subscriptionId": "6710f34fd5061afeec3eab57",
    "anonymous": false
  }
}

Authorizations

x-client-id

string

header

required

Client ID for API authentication

Body

application/json

donorId

string

required

The ID of the donor

Example:

"6710f34fd5061afeec3eab57"

paymentMethodId

string

required

The ID of the payment method to charge

Example:

"6710f34fd5061afeec3eab57"

amount

number

required

The amount to charge to the payment method

Required range: x >= 1

Example:

50

campaignId

string

The ID of the campaign

Example:

"6710f34fd5061afeec3eab57"

subcampaignId

string

The ID of the subcampaign

Example:

"6710f34fd5061afeec3eab57"

anonymous

boolean

Indicates if the donation is anonymous

Example:

true

donorNotes

string

Notes from the donor

Required string length: 1 - 500

Example:

"Donor would like to give $1,000.00 to the playground project, and the …"

Response

data

object

required

The contribution for the charge

Show child attributes

data.id

string

required

Contribution Id

Example:

"6710f34fd5061afeec3eab57"

data.createdAt

string<date-time>

required

Contribution created at

Example:

"2025-01-01T00:00:00.000Z"

data.updatedAt

string<date-time>

required

Contribution updated at

Example:

"2025-01-01T00:00:00.000Z"

data.type

enum<string>

required

Asset type

Available options:

CASH,

CRYPTO,

DAF,

MANUAL_CASH,

STOCK

Example:

"CASH"

data.amount

number

required

Contribution amount

Example:

1000

data.contributionDate

string<date-time>

required

Contribution date

Example:

"2025-01-01T00:00:00.000Z"

data.contributionReceivedAt

string<date-time> | null

required

Contribution received at

data.liquidationInitiatedAt

string<date-time> | null

required

Liquidation initiated at date for stock contributions

Example:

null

data.receivedTokensAt

string<date-time> | null

required

Received tokens at date for crypto contributions

Example:

null

data.status

required

Contribution status

Available options:

CHARGEBACK,

CONFIRMED,

FAILED,

PAID_OUT,

PENDING,

PROCESSING,

REFUNDED,

VOIDED

Example:

"PAID_OUT"

data.stocks

object

required

Stock details

Show child attributes

data.stocks.quantity

number

required

data.stocks.tickers

string[]

required

Example:

{
  "quantity": 2,
  "tickers": ["AAPL", "MSFT"]
}

data.crypto

object

required

Crypto details

Show child attributes

data.crypto.quantity

number

required

data.crypto.token

string

required

Example:

{ "quantity": 1, "token": "BTC" }

data.frequency

enum<string> | null

required

Gift frequency

Available options:

one-time,

recurring

Example:

"one-time"

data.paymentMethod

object

required

Contribution payment method information.

Show child attributes

data.paymentMethod.type

enum<string>

Available options:

ACH,

Card,

Check,

Crypto,

Physical Cash,

Stock,

Other,

Apple Pay,

Google Pay,

Cash App,

Paypal,

DAF

data.paymentMethod.last4

string

data.paymentMethod.logoUrl

string

Example:

{
  "type": "Card",
  "logoUrl": "https://example.com/logo.png",
  "last4": "4242"
}

data.depositId

string | null

required

Deposit id for the contribution

Example:

"8810f34fd5061afeec3eab67"

data.campaign

object

required

Campaign details for the contribution

Show child attributes

data.campaign.id

string

required

data.campaign.name

string

required

Example:

{
  "id": "7710f34fd5061afeec3eab78",
  "name": "Mission 2025"
}

data.subcampaign

object

required

Subcampaign details for the contribution

Show child attributes

data.subcampaign.id

string

required

data.subcampaign.name

string

required

Example:

{
  "id": "7710f34fd5061afeec3eab79",
  "name": "Toy Drive"
}

data.dedication

string | null

required

Dedication for the contribution

Example:

"In memory of Lois Lane"

data.donorNotes

string | null

required

Notes from the donor

Example:

"Happy to support this cause!"

data.donor

object

required

Donor details for the contribution

Show child attributes

data.donor.id

string

required

Donor Id

Example:

"6710f34fd5061afeec3eab57"

data.donor.createdAt

string<date-time>

required

Donor created at

Example:

"2025-01-01T00:00:00.000Z"

data.donor.updatedAt

string<date-time>

required

Donor updated at

Example:

"2025-01-01T00:00:00.000Z"

data.donor.firstName

string

required

Donor first name

Example:

"John"

data.donor.lastName

string

required

Donor last name

Example:

"Doe"

data.donor.email

string<email>

required

Donor email

Example:

"[email protected]"

data.donor.phone

string

required

Donor phone number in E.164 format

Example:

"+1234567890"

data.donor.address

object

required

Donor address

Show child attributes

data.donor.address.city

string

required

Minimum string length: 1

data.donor.address.line1

string

required

Minimum string length: 1

data.donor.address.state

string

required

Minimum string length: 1

data.donor.address.zip

string

required

data.donor.address.country

string

data.donor.address.line2

string

data.donor.address.timezone

string

Example:

{
  "line1": "123 Main St",
  "line2": "Apt 1",
  "city": "Anytown",
  "state": "CA",
  "zip": "12345"
}

data.donor.activeRecurringCount

number

The number of active recurring donations

Example:

1

data.donor.latestContributionDate

string<date-time>

The date of the latest contribution

Example:

"2025-01-01T00:00:00.000"

data.donor.totalContributionsCount

number

Total number of contributions made by the donor

Example:

10

data.donorCoveredFees

boolean

default:false

Whether the donor covered fees.

Example:

false

data.subscriptionId

string

Subscription id for contributions related to recurring gifts

Example:

"6710f34fd5061afeec3eab57"

data.anonymous

boolean

default:false

Whether the donor wants the contribution to be anonymous

Example:

false

Get Contributions Initiate Refund

⌘I

Start Here

Contributions

Donors

Subscriptions

Payment Methods

Campaigns

Status

Create Contribution

Authorizations

Body

Response