Skip to main content
POST
/
api
/
v3
/
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