Skip to main content
POST
/
v1
/
donation-pledges
/
cash-settled
Create a partner-settled cash donation pledge
curl --request POST \
  --url https://api.endaoment.org/v1/donation-pledges/cash-settled \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-endaoment-user-id: <x-endaoment-user-id>' \
  --data '
{
  "receivingFundId": "123e4567-e89b-12d3-a456-426614174000",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "pledgedAmountMicroDollars": "50000000000",
  "partnerOperationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Documentation Index

Fetch the complete documentation index at: https://docs.endaoment.org/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-endaoment-user-id
string
required

UUID of the Endaoment user the partner is acting on behalf of

​
x-api-key
string
required

Partner API key used for authentication

Body

application/json
​
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"

​
pledgedAmountMicroDollars
string
required

Settled cash donation amount in microdollars

Example:

"50000000000"

​
partnerOperationId
string
required

Partner-owned reference for this operation

Maximum string length: 36
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Partner-settled cash donation pledge successfully created

​
id
string<uuid>
required

Unique identifier of the created donation pledge

Example:

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