Skip to main content
GET
/
v2
/
pledge-transaction
/
{id}
cURL
curl --request GET \
  --url https://api.verdn.com/v2/pledge-transaction/{id} \
  --header 'Authorization: Bearer <token>'
{
  "createdAt": "2023-04-27T16:10:48.000Z",
  "reference": "my-custom-reference",
  "isLive": true,
  "charge": {
    "amount": 0,
    "currencyCode": "USD",
    "paidAt": "2024-10-01T00:00:00.000Z"
  },
  "trigger": {
    "date": "2021-03-13T00:00:00.000Z",
    "externalUrl": null,
    "phrase": null
  },
  "pledges": [
    {
      "id": "p_00000000000000000000000000",
      "impact": {
        "offeringId": "io_00000000000000000000000000",
        "amount": 2
      },
      "details": [
        {
          "name": null,
          "description": null,
          "nounSingular": null,
          "nounPlural": null,
          "image": null,
          "externalId": null,
          "externalUrl": null
        }
      ],
      "recipient": {
        "email": "customer@example.com",
        "name": "Customer",
        "firstName": null
      }
    }
  ]
}

​
Overview

Gets an existing pledge transaction by its ID. A single pledge transaction may contain one or more pledges. Each pledge represents an impact commitment tied to a specific offering.

​
Examples

const response = await fetch(
  'https://api.verdn.com/v2/pledge-transaction/ptran_00000000000000000000000000',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer verdn_sk_test_...',
    },
  },
);

​
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

Response

Pledge transaction found

​
charge
object
​
createdAt
string<date-time>
​
id
string
​
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 | null
​
timelineUrl
string

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

​
trigger
object
⌘I