Skip to content
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
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1
https://fundraising.api.rhythmsoftware.com

Appeals

Appeals

Operations

Billing Templates

Billing Templates

Operations

Campaigns

Campaigns

Operations

Donor Clubs

Donor Clubs

Operations

Donor Levels

Donor Levels

Operations

Donor Statement Templates

Donor Statement Templates

Operations

Donor Statements

Donor Statements

Operations

Donors

Donors

Operations

Fund Categories

Fund Categories

Operations

Funds

Funds

Operations

Gift Notices

Gift Notices

Operations

Gifts

Gifts

Operations

Preview Gift Receipt

Request

Sends out a preview of the gift receipt email

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

destination_email_addressstring(Destination Email Address)required
email_templateobject(Email Template)
gift_idstring(Gift)
pledge_idstring(Pledge)required
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/gifts/{tenantId}/previewReceipt' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destination_email_address": "string",
    "email_template": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "gift_id": "string",
    "pledge_id": "string"
  }'

Responses

The record was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Resend Receipt

Request

Resends the gift receipt

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

Payload for the gift

donor_infoobject(Donor Info)

Optional info for public gifts

electronic_payment_infoobject(Electronic Payment Info)

The payment info

gift_payloadobject(Gift Payload)required
gift_payload.​amountnumber(float)(Amount)required

Gift amount

gift_payload.​anonymousboolean(Anonymous)

Anonymous

gift_payload.​appeal_idstring(Appeal)

The id for the appeal associated with the gift

gift_payload.​campaign_idstring(Campaign)

The id for the campaign associated with the gift

gift_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)
gift_payload.​cover_transaction_costsboolean(Cover Transaction Costs)

If selected, the donor covers the transaction fees

gift_payload.​currency_codestring(Currency Code)

The currency code of the gift

gift_payload.​currency_symbolstring(Currency Symbol)

Currency

gift_payload.​custom_field_valuesArray of objects(Custom Field Values)
gift_payload.​donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
gift_payload.​fund_idstring(Fund)required

The id for the fund associated with the gift

gift_payload.​giving_process_idstring(Giving Process)

The process of that led to the gift

gift_payload.​has_splitsboolean(Has Splits)

If true, this gift is split into different funds

gift_payload.​make_recurringboolean(Make Recurring)

Whether to make this a recurring gift

gift_payload.​notesstring(Notes)

Notes about the gift

gift_payload.​organization_idOrganization (string)(Organization)

The organization id associated with this gift

One of:

The organization id associated with this gift

string(Organization)
gift_payload.​premium_assignmentstring(Premium Assignment)
Enum"assigned""declined by donor""not applicable"
gift_payload.​premium_fair_market_valuenumber(float)(Premium Fair Market Value)

The amount of any premiums associated with the gift

gift_payload.​premium_idstring(Premium)

If the user has selected a premium it is here

gift_payload.​recurring_frequencystring(Recurring Frequency)
Enum"monthly""quarterly""yearly"
gift_payload.​recurring_gift_end_datestring(Recurring Gift End Date)

optional end date for gift

gift_payload.​shipping_addressobject(Address)

A complete address

gift_payload.​splitsArray of objects

An array of fund allocations for this gift

gift_payload.​tribute_giftboolean(Tribute Gift)

Whether or not this is a tribute gift

gift_payload.​tribute_gift_infoobject(Tribute Gift Info)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/gifts/{tenantId}/process' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "donor_info": {},
    "electronic_payment_info": {},
    "gift_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,
      "make_recurring": true,
      "notes": "string",
      "organization_id": null,
      "premium_assignment": "assigned",
      "premium_fair_market_value": 0.1,
      "premium_id": "string",
      "recurring_frequency": "monthly",
      "recurring_gift_end_date": "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"
}

Get Public Giving Form Manifest

Request

Public API Endpoint that gets information used to populate the giving form

Path
tenantIdstringrequired

The tenant

Query
givingProcessIdstring
campaignIdstring
appealIdstring
curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/gifts/{tenantId}/public/givingFormManifest?givingProcessId=string&campaignId=string&appealId=string'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Giving Processes

Giving Processes

Operations

Pledge Levels

Pledge Levels

Operations

Pledge Notices

Pledge Notices

Operations

Pledges

Pledges

Operations

Premiums

Premiums

Operations

Products

Products

Operations

Query Definitions

Query Definitions

Operations

Recurring Gifts

Recurring Gifts

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations