Skip to main content
POST
/
v1
/
donation-pledges
/
partner
/
stock-settled
Create stock donation pledge
curl --request POST \
  --url https://api.endaoment.org/v1/donation-pledges/partner/stock-settled \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "stockPledgeData": {
    "shares": 100,
    "ticker": "AAPL",
    "lots": [
      {
        "numberOfShares": 50,
        "purchasePrice": 150.75,
        "purchaseDate": "2023-01-15T00:00:00.000Z",
        "employeeStockPlan": "RSU",
        "lotId": "LOT123"
      }
    ]
  },
  "receivingFundId": "123e4567-e89b-12d3-a456-426614174000",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "donationValueMicroDollars": "50000000000",
  "partnerOperationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "partnerUserIdentifier": "c3f8b2e4-9d1a-4f6b-8e2c-7a5d90c41b3f"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-endaoment-user-id
string

UUID of the Endaoment user for this partner-settled operation. Optional when a body partnerUserIdentifier is supplied on an API-key-only request.

​
x-api-key
string
required

Partner API key used for authentication

Body

application/json
​
stockPledgeData
object
required

Settled stock pledge details reported by the partner

​
receivingFundId
string<uuid>
required

Unique identifier of the receiving fund

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
idempotencyKey
string<uuid>
required

Client-generated key to ensure idempotency of the request

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
donationValueMicroDollars
string
required

Settled donation value in microdollars

Example:

"50000000000"

​
partnerOperationId
string
required

Partner-owned reference for this operation

Maximum string length: 36
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
partnerUserIdentifier
string

Opaque partner-generated identifier for the acting user. Used only to resolve or corroborate the user; it is not stored on the pledge or returned in the response.

Required string length: 16 - 64
Pattern: ^[\x20-\x7E]{16,64}$
Example:

"c3f8b2e4-9d1a-4f6b-8e2c-7a5d90c41b3f"

Response

Partner-settled stock donation pledge successfully created

​
id
string<uuid>
required

Unique identifier of the created donation pledge

Example:

"123e4567-e89b-12d3-a456-426614174000"