Skip to main content
POST
cURL

Overview

Creates a new pledge transaction containing one or more pledges. Each pledge represents an impact commitment tied to a specific offering.

Examples

API Reference

Authorizations

Authorization
string
header
required

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

Headers

X-Verdn-Unit-Id
string

An optional unit ID to provide when using a team-level key

Body

application/json

Input schema for creating a new pledge transaction

reference
string
required

A unique reference for the pledge transaction (e.g. order ID)

recipient
object
required
pledges
object[]
required
Minimum array length: 1
trigger
object
notifications
enum<string>[]

Optional array of notification service(s) used to alert recipient on pledge creation

Maximum array length: 3
Available options:
Email,
Klaviyo,
Cordial,
Ometria

Response

Successful response

charge
object
createdAt
string<date-time>
id
string

Unique ID for the pledge transaction

isLive
boolean

Boolean indicating production vs test pledge transaction

notifications
object[]

Array of notification statuses for this pledge transaction

pledges
object[]
recipient
object
reference
string

A unique reference for the pledge transaction (e.g. order ID)

timelineUrl
string<uri>

URL to the generated timeline, intended for the pledge recipient (should not be made public)

trigger
object