Skip to main content
POST
Create wire donation pledge

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
pledgedAmountMicroDollars
string
required

The amount to donate in microdollars (1 USD = 1,000,000 microdollars)

Example:

"5000000"

receivingFundId
string
required

The UUID of the fund that will receive the donation

Example:

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

idempotencyKey
string
required

Client-generated UUID to ensure idempotency of the request

Example:

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

partnerOperationId
string

Partner-owned reference for this operation. Required at runtime for the partner-settled cash flows, ignored otherwise.

Maximum string length: 36
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

isRebalanceRequested
boolean
default:false

Whether the fund should be rebalanced after the donation is fulfilled

Example:

false

donorIdentity
object

Donor identity information to be used in the donation receipt

Response

Wire transfer pledge successfully created

id
string<uuid>
required

Unique identifier of the created donation pledge

Example:

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