Fundraising

Resend Receipt

Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description

fundraising-v1.json

fundraising-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/

https://fundraising.api.rhythmsoftware.com/

Appeals

Operations

Billing Templates

Operations

Campaigns

Operations

Donor Clubs

Operations

Donor Levels

Operations

Donor Statement Templates

Operations

Donor Statements

Operations

Donors

Operations

Fund Categories

Operations

Funds

Operations

Gift Notices

Operations

Gifts

Operations

Giving Processes

Operations

Pledge Levels

Operations

Pledge Notices

Operations

Pledges

Operations

Resend Receipt

Request

Resends the pledge receipt

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

Payload for the pledge

donor_infoobject(Donor Info)

Optional info for public pledges

electronic_payment_infoobject(Electronic Payment Info)

The payment info

pledge_payloadobject(Pledge Payload)required

pledge_payload.amountnumber(float)(Amount)required

Gift amount

pledge_payload.anonymousboolean(Anonymous)

Anonymous

pledge_payload.appeal_idstring(Appeal)

The id for the appeal associated with the gift

pledge_payload.campaign_idstring(Campaign)

The id for the campaign associated with the gift

pledge_payload.contact_idContact (string)(Contact)

The rolodex contact id for the gift giver

One of:

The rolodex contact id for the gift giver

string(Contact)

The rolodex contact id for the gift giver

pledge_payload.cover_transaction_costsboolean(Cover Transaction Costs)

If selected, the donor covers the transaction fees

pledge_payload.currency_codestring(Currency Code)

The currency code of the gift

pledge_payload.currency_symbolstring(Currency Symbol)

Currency

pledge_payload.custom_field_valuesArray of objects(Custom Field Values)

pledge_payload.donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"

pledge_payload.fund_idstring(Fund)required

The id for the fund associated with the gift

pledge_payload.giving_process_idstring(Giving Process)

The process of that led to the gift

pledge_payload.has_splitsboolean(Has Splits)

If true, this gift is split into different funds

pledge_payload.installment_plan_idstring(Installment Plan)required

The installment plan for the pledge

pledge_payload.notesstring(Notes)

Notes about the gift

pledge_payload.organization_idOrganization (string)(Organization)

The organization id associated with this gift

One of:

The organization id associated with this gift

string(Organization)

The organization id associated with this gift

pledge_payload.premium_assignmentstring(Premium Assignment)

Enum"assigned""declined by donor""not applicable"

pledge_payload.premium_fair_market_valuenumber(float)(Premium Fair Market Value)

The amount of any premiums associated with the gift

pledge_payload.premium_idstring(Premium)

If the user has selected a premium it is here

pledge_payload.shipping_addressobject(Address)

A complete address

pledge_payload.splitsArray of objects

An array of fund allocations for this gift

pledge_payload.tribute_giftboolean(Tribute Gift)

Whether or not this is a tribute gift

pledge_payload.tribute_gift_infoobject(Tribute Gift Info)

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/process' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "donor_info": {},
    "electronic_payment_info": {},
    "pledge_payload": {
      "amount": 0.1,
      "anonymous": true,
      "appeal_id": "string",
      "campaign_id": "string",
      "contact_id": null,
      "cover_transaction_costs": true,
      "currency_code": "string",
      "currency_symbol": "string",
      "custom_field_values": [
        {
          "boolean_value": true,
          "custom_field_id": "string",
          "file_url_value": "string",
          "list_value": [
            "string"
          ],
          "numeric_value": 0.1,
          "string_value": "string",
          "table_value": [
            {}
          ]
        }
      ],
      "donor_type": "contact",
      "fund_id": "string",
      "giving_process_id": "string",
      "has_splits": true,
      "installment_plan_id": "string",
      "notes": "string",
      "organization_id": null,
      "premium_assignment": "assigned",
      "premium_fair_market_value": 0.1,
      "premium_id": "string",
      "shipping_address": {
        "city": "string",
        "country": "string",
        "country_name": "string",
        "county": "string",
        "latitude": 0.1,
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "longitude": 0.1,
        "postal_code": "string",
        "state": "string",
        "time_zone_id": "string"
      },
      "splits": [
        {
          "amount": 0.1,
          "fund_id": "string"
        }
      ],
      "tribute_gift": true,
      "tribute_gift_info": {
        "address": {
          "city": "string",
          "country": "string",
          "country_name": "string",
          "county": "string",
          "latitude": 0.1,
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "longitude": 0.1,
          "postal_code": "string",
          "state": "string",
          "time_zone_id": "string"
        },
        "contact_id": "string",
        "details": "string",
        "email_address": null,
        "inform_honoree": true,
        "inform_honoree_by": "email",
        "message": null,
        "name": "string",
        "type": "in honor of"
      }
    }
  }'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring(date-time)(Start Date)

The start date of the execution

Response

application/json

{
  "executionArn": "string",
  "notification_channel": "string",
  "notification_publishKey": "string",
  "notification_subscribeKey": "string",
  "start_date": "2019-08-24T14:15:22Z"
}

Resend Receipt

Request

Resends the pledge receipt

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

Payload for the pledge

donor_infoobject(Donor Info)

Optional info for public pledges

electronic_payment_infoobject(Electronic Payment Info)

The payment info

pledge_payloadobject(Pledge Payload)required

pledge_payload.amountnumber(float)(Amount)required

Gift amount

pledge_payload.anonymousboolean(Anonymous)

Anonymous

pledge_payload.appeal_idstring(Appeal)

The id for the appeal associated with the gift

pledge_payload.campaign_idstring(Campaign)

The id for the campaign associated with the gift

pledge_payload.contact_idContact (string)(Contact)

The rolodex contact id for the gift giver

One of:

The rolodex contact id for the gift giver

string(Contact)

The rolodex contact id for the gift giver

pledge_payload.cover_transaction_costsboolean(Cover Transaction Costs)

If selected, the donor covers the transaction fees

pledge_payload.currency_codestring(Currency Code)

The currency code of the gift

pledge_payload.currency_symbolstring(Currency Symbol)

Currency

pledge_payload.custom_field_valuesArray of objects(Custom Field Values)

pledge_payload.donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"

pledge_payload.fund_idstring(Fund)required

The id for the fund associated with the gift

pledge_payload.giving_process_idstring(Giving Process)

The process of that led to the gift

pledge_payload.has_splitsboolean(Has Splits)

If true, this gift is split into different funds

pledge_payload.installment_plan_idstring(Installment Plan)required

The installment plan for the pledge

pledge_payload.notesstring(Notes)

Notes about the gift

pledge_payload.organization_idOrganization (string)(Organization)

The organization id associated with this gift

One of:

The organization id associated with this gift

string(Organization)

The organization id associated with this gift

pledge_payload.premium_assignmentstring(Premium Assignment)

Enum"assigned""declined by donor""not applicable"

pledge_payload.premium_fair_market_valuenumber(float)(Premium Fair Market Value)

The amount of any premiums associated with the gift

pledge_payload.premium_idstring(Premium)

If the user has selected a premium it is here

pledge_payload.shipping_addressobject(Address)

A complete address

pledge_payload.splitsArray of objects

An array of fund allocations for this gift

pledge_payload.tribute_giftboolean(Tribute Gift)

Whether or not this is a tribute gift

pledge_payload.tribute_gift_infoobject(Tribute Gift Info)

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/public/process' \
  -H 'Content-Type: application/json' \
  -d '{
    "donor_info": {},
    "electronic_payment_info": {},
    "pledge_payload": {
      "amount": 0.1,
      "anonymous": true,
      "appeal_id": "string",
      "campaign_id": "string",
      "contact_id": null,
      "cover_transaction_costs": true,
      "currency_code": "string",
      "currency_symbol": "string",
      "custom_field_values": [
        {
          "boolean_value": true,
          "custom_field_id": "string",
          "file_url_value": "string",
          "list_value": [
            "string"
          ],
          "numeric_value": 0.1,
          "string_value": "string",
          "table_value": [
            {}
          ]
        }
      ],
      "donor_type": "contact",
      "fund_id": "string",
      "giving_process_id": "string",
      "has_splits": true,
      "installment_plan_id": "string",
      "notes": "string",
      "organization_id": null,
      "premium_assignment": "assigned",
      "premium_fair_market_value": 0.1,
      "premium_id": "string",
      "shipping_address": {
        "city": "string",
        "country": "string",
        "country_name": "string",
        "county": "string",
        "latitude": 0.1,
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "longitude": 0.1,
        "postal_code": "string",
        "state": "string",
        "time_zone_id": "string"
      },
      "splits": [
        {
          "amount": 0.1,
          "fund_id": "string"
        }
      ],
      "tribute_gift": true,
      "tribute_gift_info": {
        "address": {
          "city": "string",
          "country": "string",
          "country_name": "string",
          "county": "string",
          "latitude": 0.1,
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "longitude": 0.1,
          "postal_code": "string",
          "state": "string",
          "time_zone_id": "string"
        },
        "contact_id": "string",
        "details": "string",
        "email_address": null,
        "inform_honoree": true,
        "inform_honoree_by": "email",
        "message": null,
        "name": "string",
        "type": "in honor of"
      }
    }
  }'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring(date-time)(Start Date)

The start date of the execution

Response

application/json

{
  "executionArn": "string",
  "notification_channel": "string",
  "notification_publishKey": "string",
  "notification_subscribeKey": "string",
  "start_date": "2019-08-24T14:15:22Z"
}

Resend Receipt

Request

Resends the pledge receipt

Path

tenantIdstringrequired

The tenant

idstringrequired

The ID of the pledge

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/resendReceipt/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Premiums

Operations

Products

Operations

Query Definitions

Operations

Recurring Gifts

Operations

Settings

Operations

Statistics

Operations

Fundraising (v1-2025-04-18)

Appeals

Billing Templates

Campaigns

Donor Clubs

Donor Levels

Donor Statement Templates

Donor Statements

Donors

Fund Categories

Funds

Gift Notices

Gifts

Giving Processes

Pledge Levels

Pledge Notices

Pledges

Resend Receipt

Request

Responses

Was this helpful?

Resend Receipt

Request

Responses

Was this helpful?

Resend Receipt

Request

Responses

Was this helpful?

Premiums

Products

Query Definitions

Recurring Gifts

Settings

Statistics

Fundraising (v1-2025-04-18)

Appeals

Billing Templates

Campaigns

Donor Clubs

Donor Levels

Donor Statement Templates

Donor Statements

Donors

Fund Categories

Funds

Gift Notices

Gifts

Giving Processes

Pledge Levels

Pledge Notices

Pledges

Resend Receipt

RequestExpand all

Responses

Was this helpful?

Resend Receipt

RequestExpand all

Responses

Was this helpful?

Resend Receipt

Request

Responses

Was this helpful?

Premiums

Products

Query Definitions

Recurring Gifts

Settings

Statistics

Request

Request