> ## Documentation Index
> Fetch the complete documentation index at: https://docs.verdn.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Pledge Transaction by ID

> Get an existing pledge transaction by its ID

## 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

<CodeGroup>
  ```typescript Comprehensive Request theme={null}
  const response = await fetch(
    'https://api.verdn.com/v2/pledge-transaction/ptran_00000000000000000000000000',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer verdn_sk_test_...',
      },
    },
  );
  ```

  ```json Comprehensive Response theme={null}
  {
    "createdAt": "2024-01-25T12:00:00Z",
    "reference": "order_123",
    "isLive": false,
    "charge": {
      "amount": "25.00",
      "currencyCode": "USD",
      "paidAt": null
    },
    "trigger": {
      "date": null,
      "externalUrl": null,
      "phrase": null
    },
    "pledges": [
      {
        "id": "p_00000000000000000000000000",
        "impact": {
          "amount": 100,
          "offeringId": "off_123"
        },
        "recipient": {
          "email": "customer@example.com",
          "firstName": null,
          "name": null
        },
        "details": [
          {
            "description": null,
            "externalId": null,
            "externalUrl": null,
            "image": null,
            "name": null,
            "nounPlural": null,
            "nounSingular": null
          }
        ]
      }
    ]
  }
  ```
</CodeGroup>

## API Reference


## OpenAPI

````yaml GET /v2/pledge-transaction/{id}
openapi: 3.0.0
info:
  title: Verdn API
  version: 2.0.0
  description: The Verdn API
servers:
  - url: https://api.verdn.com
    description: Production server
security:
  - bearerAuth: []
paths:
  /v2/pledge-transaction/{id}:
    get:
      description: Get an existing pledge transaction by its ID
      parameters:
        - schema:
            type: string
            description: An optional unit ID to provide when using a team-level key
          required: false
          description: An optional unit ID to provide when using a team-level key
          name: X-Verdn-Unit-Id
          in: header
      responses:
        '200':
          description: Pledge transaction found
          content:
            application/json:
              schema:
                type: object
                properties:
                  charge:
                    type: object
                    properties:
                      amount:
                        type: string
                        description: Total monetary value of the pledge transaction
                      currencyCode:
                        type: string
                        enum:
                          - USD
                          - GBP
                          - EUR
                        description: Three-letter ISO currency code (e.g. USD, EUR)
                      paidAt:
                        type: string
                        nullable: true
                        format: date-time
                  createdAt:
                    type: string
                    format: date-time
                  id:
                    type: string
                  isLive:
                    type: boolean
                    description: Boolean indicating production vs test pledge transaction
                  notifications:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                          enum:
                            - Pending
                            - Updated
                            - Actualized
                        type:
                          type: string
                          enum:
                            - Email
                            - Klaviyo
                            - LegacyKlaviyo
                            - Cordial
                            - Ometria
                    description: Array of notification statuses for this pledge transaction
                  pledges:
                    type: array
                    items:
                      type: object
                      properties:
                        details:
                          type: array
                          items:
                            type: object
                            properties:
                              description:
                                type: string
                                nullable: true
                              externalId:
                                type: string
                                nullable: true
                              externalUrl:
                                type: string
                                nullable: true
                                format: uri
                              image:
                                type: string
                                nullable: true
                                format: uri
                              name:
                                type: string
                                nullable: true
                              nounPlural:
                                type: string
                                nullable: true
                              nounSingular:
                                type: string
                                nullable: true
                        id:
                          type: string
                          description: Unique ID for the pledge
                        impact:
                          type: object
                          properties:
                            amount:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              description: >-
                                Quantity to pledge towards the offering (e.g. 10
                                trees)
                            offeringId:
                              type: string
                              description: ID of the impact offering
                  recipient:
                    type: object
                    properties:
                      email:
                        type: string
                        format: email
                        description: Email address of the recipient
                      firstName:
                        type: string
                        nullable: true
                      name:
                        type: string
                        nullable: true
                  reference:
                    type: string
                    nullable: true
                  timelineUrl:
                    type: string
                    description: >-
                      URL to the generated timeline, intended for the pledge
                      recipient (should not be made public)
                  trigger:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date-time
                      externalUrl:
                        type: string
                        nullable: true
                        format: uri
                      phrase:
                        type: string
                        nullable: true
              example:
                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
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                  - message
              example:
                error: Authentication failed
                message: Check your API key and try again.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
              example:
                error: Pledge transaction not found
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````