NAV Navigation
Shell HTTP JavaScript Ruby Python PHP Java Go

iDonate API v20181231

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

iDonate logo
Hello there! Welcome to the iDonate developer docs.

What is iDonate

iDonate is the leading fundraising software provider that exists to grow nonprofits. Its digital giving system uses integrated payment applications, performance analytics, and success coaching to ensure immediate and enduring growth. Through a commitment to generosity and innovation, iDonate has become the world’s standard for donation processing technology.

Let's get started.

Transaction Webhook

A transaction webhook can be configured to push updates to an external system. This can be used to keep your organization up to date on donations it has received. The transaction webhook will send one of two possible JSON payloads, create or update, via an HTTP POST request. See below for examples.

create

{"create": [{"transaction": Transaction}]}

update

{"update": [{"transaction": Transaction}]}

Event Webhook

An Event Webhook is more complex than a Transaction Webhook, but allows for different types of information to be monitored. An Event Webhook will have a variable payload that is determined by the Event Type, documented under Event Definitions.

Data API

The API is a set of endpoints that allows organizations to retrieve their transactions. How you use it is up to you! See the available endpoints below, you will need an apikey to be able to access the endpoints.

Where do I get an apikey?

To obtain an apikey used for authentication, contact iDonate Support and supply the user's email you would like to access the system on behalf of.

Event Definitions

Advocacy Page Updated

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_page.updated",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyPage ... */    
    }
}

An Advocate has changed properties on their Advocacy Page

Advocacy Team Updated

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_team.updated",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyTeam ... */    
    }
}

An Advocacy Team has been updated by the Advocacy Team's Captain

Donor Contact Updated

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "donor.contact_updated",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... DonorContactUpdate ... */    
    }
}

A Donor's Contact record has been updated by any means

Advocacy Program Deleted

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.deleted",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

An Advocacy Program has been deleted by an Organization Admin

Advocacy Program Created

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.created",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

An Advocacy Program has been created by an Organization Editor

Advocacy Program Unpublished

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.unpublished",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

An Advocacy Program has been removed from publication by an Organization Editor

Advocacy Team Member Joined

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_team.member_joined",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyTeamMember ... */    
    }
}

An Advocate has joined an existing Advocacy Team

Recurring Donation Schedule Donor Update Requested

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "recurring_donation_schedule.donor_update_requested",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... RecurringDonationSchedule ... */    
    }
}

A Recurring Donation Schedule is in need of manual update from the Donor

Transaction Updated

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.updated",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

Monitored fields on a Donation Transaction have been updated by any means.

Transaction Approved

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.approved",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has reached 'approved' status.

Advocacy Team Member Left

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_team.member_left",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyTeamMember ... */    
    }
}

An Advocate has left an Advocacy Team

Transaction Completed

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.completed",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has reached 'complete' status.

Transaction Transferred

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.transferred",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has reached 'transferred' status.

Advocacy Program Updated

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.updated",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

An Advocacy Program has been updated by an Organization Editor

Transaction Refunded

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.refunded",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has reached 'refunded' status.

Advocacy Team Member Milestone Reached

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_team.member_goal_progress",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyTeamMemberMilestone ... */    
    }
}

An Advocate's page has reached a Membership Goal milestone

Advocacy Program Unarchived

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.unarchived",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

An Advocacy Program has been Unarchived by an Organization Editor

Donor Requested Organization Giving History

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "donor.request_organization_giving_history",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... OrganizationDonor ... */    
    }
}

Donor has requested their Giving History with an Organization

Advocacy Program Expired

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.expired",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

Advocacy Program Expired

Recurring Donation Schedule Updated

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "recurring_donation_schedule.updated",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... RecurringDonationSchedule ... */    
    }
}

A Recurring Donation Schedule has been updated by any means.

Transaction Created

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.created",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has been created by any means.

Recurring Donation Schedule Created

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "recurring_donation_schedule.created",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... RecurringDonationSchedule ... */    
    }
}

Recurring Donation Schedule Created

Donor Cancelled Organization Schedules

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "donor.cancel_organization_schedules",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... OrganizationDonorSchedules ... */    
    }
}

All schedules owned by Donor on the Organization have been cancelled.

Transaction Set Changed

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction_set.changed",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... TransactionSet ... */    
    }
}

A transaction has been added or removed from an existing TransactionSet.

Transaction Set Created

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction_set.created",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... TransactionSet ... */    
    }
}

One or more Transactions have been created as a set.

Donor Payment Method Updated

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "donor.payment_method_updated",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... OrganizationDonorSchedules ... */    
    }
}

Donor Payment Method Updated

Advocacy Program Archived

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.archived",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

An Advocacy Program has been archived, either automatically or at an Organization Editor's request.

Advocacy Program Published

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_program.published",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyProgram ... */    
    }
}

An Advocacy Program has been published by an Organization Editor

Recurring Donation Schedule Cancelled

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "recurring_donation_schedule.cancelled",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... RecurringDonationScheduleCancelled ... */    
    }
}

A Recurring Donation Schedule has been cancelled.

Transaction Cancelled

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.cancelled",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has reached 'cancelled' status.

Transaction Pending

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.pending",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has reached 'pending' status.

Transaction Sold

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "transaction.sold",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... Transaction ... */    
    }
}

A Donation Transaction has reached 'Sold' status.

Donor Contact Update Requested

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "donor.contact_update_requested",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... OrganizationDonor ... */    
    }
}

Manual update on a Donor's Contact Record has been requested.

Advocacy Team Created

{
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "advocacy_team.created",
    "created": "2018-06-11T18:16:15Z",
    "payload": {
        /* ... AdvocacyTeam ... */    
    }
}

An Advocacy Team has been created by an Advocate

Base URLs:

Authentication

Transactions

list_transaction_sets

Code samples

# You can also use wget
curl -X GET https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets \
  -H 'Accept: application/json' \
  -H 'apikey: API_KEY'

GET https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets HTTP/1.1
Host: api.idonate.com

Accept: application/json

var headers = {
  'Accept':'application/json',
  'apikey':'API_KEY'

};

$.ajax({
  url: 'https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'apikey' => 'API_KEY'
}

result = RestClient.get 'https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'apikey': 'API_KEY'
}

r = requests.get('https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets', params={

}, headers = headers)

print r.json()

 'application/json',
    'apikey' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "apikey": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organization/{organization_id}/transaction-sets

Parameters

Parameter In Type Required Description
start_date query string false Start of duration being queried, REQUIRED, ISO8601
page query string false Page Number, Integer
per_page query string false Results Per Page, Integer, 1-100
include_children query string false If true, also return data for child organizations, Boolean
end_date query string false End of duration being queried, REQUIRED, ISO8601
organization_id path string true No description

Example responses

200 undefined

{
  "result": {
    "count": 0,
    "items": [
      {
        "created": "2020-06-30T13:37:51Z",
        "id": "string",
        "organization_id": "string",
        "transactions": [
          {
            "additional_info": "string",
            "address": {
              "city": "string",
              "country": "string",
              "country_code": "string",
              "country_name": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "title": "string",
              "zip": "string"
            },
            "advocacy_program_id": "string",
            "advocacy_program_name": "string",
            "advocacy_team_id": "string",
            "advocacy_team_name": "string",
            "advocate": {
              "address": {
                "city": "string",
                "country": "string",
                "state": "string",
                "street": "string",
                "street2": "string",
                "zip_code": "string"
              },
              "email": "string",
              "first_name": "string",
              "id": "string",
              "join_date": "2020-06-30T13:37:51Z",
              "last_name": "string",
              "phone": "string"
            },
            "advocate_id": "string",
            "advocate_name": "string",
            "campaign_id": "string",
            "campaign_title": "string",
            "card_type": "string",
            "check_number": "string",
            "client_proceeds": 0,
            "company_name": "string",
            "contact": {
              "address": {
                "city": "string",
                "country": "string",
                "country_code": "string",
                "country_name": "string",
                "state": "string",
                "street": "string",
                "street2": "string",
                "title": "string",
                "zip": "string"
              },
              "created": "2020-06-30T13:37:51Z",
              "email": "string",
              "firstname": "string",
              "lastname": "string",
              "middlename": "string",
              "phone": "string",
              "timezone": "string",
              "title": "string",
              "updated": "2020-06-30T13:37:51Z"
            },
            "corporate_matching_record": {
              "company_name": "string",
              "donation_id": 0,
              "matched_transaction_id": "string"
            },
            "created": "2020-06-30T13:37:51Z",
            "custom_note_1": "string",
            "custom_note_2": "string",
            "custom_note_3": "string",
            "custom_note_4": "string",
            "custom_note_5": "string",
            "description": "string",
            "designation": {
              "code": "string",
              "fund_id": "string",
              "id": "string",
              "title": "string"
            },
            "designation_note": "string",
            "donor_id": "string",
            "donor_paid_fee": 0,
            "email_opt_in": true,
            "embed": {
              "id": "string",
              "name": "string"
            },
            "expiration_month": 0,
            "expiration_year": 0,
            "external_tracking_id": "string",
            "final_date": "2020-06-30T13:37:51Z",
            "frequency": "string",
            "gift": {
              "created": "2020-06-30T13:37:51Z",
              "description": "string",
              "extra_placeholder": "string",
              "gift_value": 0,
              "id": "string",
              "image_url": "string",
              "is_disabled": true,
              "sku": "string",
              "updated": "2020-06-30T13:37:51Z"
            },
            "gift_extra": "string",
            "hide_name": true,
            "id": "string",
            "last_four_digits": "string",
            "net_proceeds": 0,
            "organization_id": "string",
            "payment_gateway_id": "string",
            "payment_gateway_name": "string",
            "payment_transaction_id": "string",
            "recurring_count": 0,
            "reference_code": "string",
            "sale_price": 0,
            "schedule_id": "string",
            "sms_keyword": "string",
            "status": "string",
            "subtype": "string",
            "transaction_set_id": "string",
            "tribute": {
              "definition": {
                "description": "string",
                "id": "string",
                "image_key": "string",
                "image_url": "string",
                "is_disabled": true,
                "recipient_address_required": true,
                "recipient_email_required": true
              },
              "from_name": "string",
              "honorees": [
                {
                  "firstname": "string",
                  "lastname": "string",
                  "message": "string"
                }
              ],
              "include_amount": true,
              "recipient": {
                "address": {
                  "city": "string",
                  "country": "string",
                  "country_code": "string",
                  "country_name": "string",
                  "state": "string",
                  "street": "string",
                  "street2": "string",
                  "title": "string",
                  "zip": "string"
                },
                "created": "2020-06-30T13:37:51Z",
                "email": "string",
                "firstname": "string",
                "lastname": "string",
                "middlename": "string",
                "phone": "string",
                "timezone": "string",
                "title": "string",
                "updated": "2020-06-30T13:37:51Z"
              },
              "send_card": true
            },
            "type": "string",
            "utm": {
              "campaign": "string",
              "content": "string",
              "medium": "string",
              "source": "string",
              "term": "string"
            },
            "vendor_id": 0
          }
        ]
      }
    ],
    "more": true,
    "page": 0,
    "total_count": 0
  },
  "status": 200
}

Responses

Status Meaning Description Schema
200 OK Success TransactionSetsResponse

get_transaction_set

Code samples

# You can also use wget
curl -X GET https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id} \
  -H 'Accept: application/json' \
  -H 'apikey: API_KEY'

GET https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id} HTTP/1.1
Host: api.idonate.com

Accept: application/json

var headers = {
  'Accept':'application/json',
  'apikey':'API_KEY'

};

$.ajax({
  url: 'https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'apikey' => 'API_KEY'
}

result = RestClient.get 'https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'apikey': 'API_KEY'
}

r = requests.get('https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id}', params={

}, headers = headers)

print r.json()

 'application/json',
    'apikey' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "apikey": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.idonate.com/data/20181231/organization/{organization_id}/transaction-sets/{transaction_set_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organization/{organization_id}/transaction-sets/{transaction_set_id}

Parameters

Parameter In Type Required Description
organization_id path string true No description
transaction_set_id path string true No description

Example responses

200 undefined

{
  "result": {
    "created": "2020-06-30T13:37:51Z",
    "id": "string",
    "organization_id": "string",
    "transactions": [
      {
        "additional_info": "string",
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "advocacy_program_id": "string",
        "advocacy_program_name": "string",
        "advocacy_team_id": "string",
        "advocacy_team_name": "string",
        "advocate": {
          "address": {
            "city": "string",
            "country": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "zip_code": "string"
          },
          "email": "string",
          "first_name": "string",
          "id": "string",
          "join_date": "2020-06-30T13:37:51Z",
          "last_name": "string",
          "phone": "string"
        },
        "advocate_id": "string",
        "advocate_name": "string",
        "campaign_id": "string",
        "campaign_title": "string",
        "card_type": "string",
        "check_number": "string",
        "client_proceeds": 0,
        "company_name": "string",
        "contact": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "corporate_matching_record": {
          "company_name": "string",
          "donation_id": 0,
          "matched_transaction_id": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "custom_note_1": "string",
        "custom_note_2": "string",
        "custom_note_3": "string",
        "custom_note_4": "string",
        "custom_note_5": "string",
        "description": "string",
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        },
        "designation_note": "string",
        "donor_id": "string",
        "donor_paid_fee": 0,
        "email_opt_in": true,
        "embed": {
          "id": "string",
          "name": "string"
        },
        "expiration_month": 0,
        "expiration_year": 0,
        "external_tracking_id": "string",
        "final_date": "2020-06-30T13:37:51Z",
        "frequency": "string",
        "gift": {
          "created": "2020-06-30T13:37:51Z",
          "description": "string",
          "extra_placeholder": "string",
          "gift_value": 0,
          "id": "string",
          "image_url": "string",
          "is_disabled": true,
          "sku": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "gift_extra": "string",
        "hide_name": true,
        "id": "string",
        "last_four_digits": "string",
        "net_proceeds": 0,
        "organization_id": "string",
        "payment_gateway_id": "string",
        "payment_gateway_name": "string",
        "payment_transaction_id": "string",
        "recurring_count": 0,
        "reference_code": "string",
        "sale_price": 0,
        "schedule_id": "string",
        "sms_keyword": "string",
        "status": "string",
        "subtype": "string",
        "transaction_set_id": "string",
        "tribute": {
          "definition": {
            "description": "string",
            "id": "string",
            "image_key": "string",
            "image_url": "string",
            "is_disabled": true,
            "recipient_address_required": true,
            "recipient_email_required": true
          },
          "from_name": "string",
          "honorees": [
            {
              "firstname": "string",
              "lastname": "string",
              "message": "string"
            }
          ],
          "include_amount": true,
          "recipient": {
            "address": {
              "city": "string",
              "country": "string",
              "country_code": "string",
              "country_name": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "title": "string",
              "zip": "string"
            },
            "created": "2020-06-30T13:37:51Z",
            "email": "string",
            "firstname": "string",
            "lastname": "string",
            "middlename": "string",
            "phone": "string",
            "timezone": "string",
            "title": "string",
            "updated": "2020-06-30T13:37:51Z"
          },
          "send_card": true
        },
        "type": "string",
        "utm": {
          "campaign": "string",
          "content": "string",
          "medium": "string",
          "source": "string",
          "term": "string"
        },
        "vendor_id": 0
      }
    ]
  },
  "status": 200
}

Responses

Status Meaning Description Schema
200 OK Success TransactionSetResponse

list_transactions

Code samples

# You can also use wget
curl -X GET https://api.idonate.com/data/20181231/organization/{organization_id}/transactions \
  -H 'Accept: application/json' \
  -H 'apikey: API_KEY'

GET https://api.idonate.com/data/20181231/organization/{organization_id}/transactions HTTP/1.1
Host: api.idonate.com

Accept: application/json

var headers = {
  'Accept':'application/json',
  'apikey':'API_KEY'

};

$.ajax({
  url: 'https://api.idonate.com/data/20181231/organization/{organization_id}/transactions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'apikey' => 'API_KEY'
}

result = RestClient.get 'https://api.idonate.com/data/20181231/organization/{organization_id}/transactions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'apikey': 'API_KEY'
}

r = requests.get('https://api.idonate.com/data/20181231/organization/{organization_id}/transactions', params={

}, headers = headers)

print r.json()

 'application/json',
    'apikey' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.idonate.com/data/20181231/organization/{organization_id}/transactions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.idonate.com/data/20181231/organization/{organization_id}/transactions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "apikey": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.idonate.com/data/20181231/organization/{organization_id}/transactions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organization/{organization_id}/transactions

Parameters

Parameter In Type Required Description
start_date query string false Start of duration being queried, REQUIRED, ISO8601
page query string false Page Number, Integer
per_page query string false Results Per Page, Integer, 1-100
include_children query string false If true, also return data for child organizations, Boolean
end_date query string false End of duration being queried, REQUIRED, ISO8601
organization_id path string true No description

Example responses

200 undefined

{
  "result": {
    "count": 0,
    "items": [
      {
        "additional_info": "string",
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "advocacy_program_id": "string",
        "advocacy_program_name": "string",
        "advocacy_team_id": "string",
        "advocacy_team_name": "string",
        "advocate": {
          "address": {
            "city": "string",
            "country": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "zip_code": "string"
          },
          "email": "string",
          "first_name": "string",
          "id": "string",
          "join_date": "2020-06-30T13:37:51Z",
          "last_name": "string",
          "phone": "string"
        },
        "advocate_id": "string",
        "advocate_name": "string",
        "campaign_id": "string",
        "campaign_title": "string",
        "card_type": "string",
        "check_number": "string",
        "client_proceeds": 0,
        "company_name": "string",
        "contact": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "corporate_matching_record": {
          "company_name": "string",
          "donation_id": 0,
          "matched_transaction_id": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "custom_note_1": "string",
        "custom_note_2": "string",
        "custom_note_3": "string",
        "custom_note_4": "string",
        "custom_note_5": "string",
        "description": "string",
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        },
        "designation_note": "string",
        "donor_id": "string",
        "donor_paid_fee": 0,
        "email_opt_in": true,
        "embed": {
          "id": "string",
          "name": "string"
        },
        "expiration_month": 0,
        "expiration_year": 0,
        "external_tracking_id": "string",
        "final_date": "2020-06-30T13:37:51Z",
        "frequency": "string",
        "gift": {
          "created": "2020-06-30T13:37:51Z",
          "description": "string",
          "extra_placeholder": "string",
          "gift_value": 0,
          "id": "string",
          "image_url": "string",
          "is_disabled": true,
          "sku": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "gift_extra": "string",
        "hide_name": true,
        "id": "string",
        "last_four_digits": "string",
        "net_proceeds": 0,
        "organization_id": "string",
        "payment_gateway_id": "string",
        "payment_gateway_name": "string",
        "payment_transaction_id": "string",
        "recurring_count": 0,
        "reference_code": "string",
        "sale_price": 0,
        "schedule_id": "string",
        "sms_keyword": "string",
        "status": "string",
        "subtype": "string",
        "transaction_set_id": "string",
        "tribute": {
          "definition": {
            "description": "string",
            "id": "string",
            "image_key": "string",
            "image_url": "string",
            "is_disabled": true,
            "recipient_address_required": true,
            "recipient_email_required": true
          },
          "from_name": "string",
          "honorees": [
            {
              "firstname": "string",
              "lastname": "string",
              "message": "string"
            }
          ],
          "include_amount": true,
          "recipient": {
            "address": {
              "city": "string",
              "country": "string",
              "country_code": "string",
              "country_name": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "title": "string",
              "zip": "string"
            },
            "created": "2020-06-30T13:37:51Z",
            "email": "string",
            "firstname": "string",
            "lastname": "string",
            "middlename": "string",
            "phone": "string",
            "timezone": "string",
            "title": "string",
            "updated": "2020-06-30T13:37:51Z"
          },
          "send_card": true
        },
        "type": "string",
        "utm": {
          "campaign": "string",
          "content": "string",
          "medium": "string",
          "source": "string",
          "term": "string"
        },
        "vendor_id": 0
      }
    ],
    "more": true,
    "page": 0,
    "total_count": 0
  },
  "status": 200
}

Responses

Status Meaning Description Schema
200 OK Success TransactionsResponse

get_transaction

Code samples

# You can also use wget
curl -X GET https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id} \
  -H 'Accept: application/json' \
  -H 'apikey: API_KEY'

GET https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id} HTTP/1.1
Host: api.idonate.com

Accept: application/json

var headers = {
  'Accept':'application/json',
  'apikey':'API_KEY'

};

$.ajax({
  url: 'https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'apikey' => 'API_KEY'
}

result = RestClient.get 'https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'apikey': 'API_KEY'
}

r = requests.get('https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id}', params={

}, headers = headers)

print r.json()

 'application/json',
    'apikey' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "apikey": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.idonate.com/data/20181231/organization/{organization_id}/transactions/{transaction_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organization/{organization_id}/transactions/{transaction_id}

Parameters

Parameter In Type Required Description
organization_id path string true No description
transaction_id path string true No description

Example responses

200 undefined

{
  "result": {
    "additional_info": "string",
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "country_name": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "title": "string",
      "zip": "string"
    },
    "advocacy_program_id": "string",
    "advocacy_program_name": "string",
    "advocacy_team_id": "string",
    "advocacy_team_name": "string",
    "advocate": {
      "address": {
        "city": "string",
        "country": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "zip_code": "string"
      },
      "email": "string",
      "first_name": "string",
      "id": "string",
      "join_date": "2020-06-30T13:37:51Z",
      "last_name": "string",
      "phone": "string"
    },
    "advocate_id": "string",
    "advocate_name": "string",
    "campaign_id": "string",
    "campaign_title": "string",
    "card_type": "string",
    "check_number": "string",
    "client_proceeds": 0,
    "company_name": "string",
    "contact": {
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "email": "string",
      "firstname": "string",
      "lastname": "string",
      "middlename": "string",
      "phone": "string",
      "timezone": "string",
      "title": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "corporate_matching_record": {
      "company_name": "string",
      "donation_id": 0,
      "matched_transaction_id": "string"
    },
    "created": "2020-06-30T13:37:51Z",
    "custom_note_1": "string",
    "custom_note_2": "string",
    "custom_note_3": "string",
    "custom_note_4": "string",
    "custom_note_5": "string",
    "description": "string",
    "designation": {
      "code": "string",
      "fund_id": "string",
      "id": "string",
      "title": "string"
    },
    "designation_note": "string",
    "donor_id": "string",
    "donor_paid_fee": 0,
    "email_opt_in": true,
    "embed": {
      "id": "string",
      "name": "string"
    },
    "expiration_month": 0,
    "expiration_year": 0,
    "external_tracking_id": "string",
    "final_date": "2020-06-30T13:37:51Z",
    "frequency": "string",
    "gift": {
      "created": "2020-06-30T13:37:51Z",
      "description": "string",
      "extra_placeholder": "string",
      "gift_value": 0,
      "id": "string",
      "image_url": "string",
      "is_disabled": true,
      "sku": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "gift_extra": "string",
    "hide_name": true,
    "id": "string",
    "last_four_digits": "string",
    "net_proceeds": 0,
    "organization_id": "string",
    "payment_gateway_id": "string",
    "payment_gateway_name": "string",
    "payment_transaction_id": "string",
    "recurring_count": 0,
    "reference_code": "string",
    "sale_price": 0,
    "schedule_id": "string",
    "sms_keyword": "string",
    "status": "string",
    "subtype": "string",
    "transaction_set_id": "string",
    "tribute": {
      "definition": {
        "description": "string",
        "id": "string",
        "image_key": "string",
        "image_url": "string",
        "is_disabled": true,
        "recipient_address_required": true,
        "recipient_email_required": true
      },
      "from_name": "string",
      "honorees": [
        {
          "firstname": "string",
          "lastname": "string",
          "message": "string"
        }
      ],
      "include_amount": true,
      "recipient": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "send_card": true
    },
    "type": "string",
    "utm": {
      "campaign": "string",
      "content": "string",
      "medium": "string",
      "source": "string",
      "term": "string"
    },
    "vendor_id": 0
  },
  "status": 200
}

Responses

Status Meaning Description Schema
200 OK Success TransactionResponse

Recurring Schedules

list_recurring_schedules

Code samples

# You can also use wget
curl -X GET https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules \
  -H 'Accept: application/json' \
  -H 'apikey: API_KEY'

GET https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules HTTP/1.1
Host: api.idonate.com

Accept: application/json

var headers = {
  'Accept':'application/json',
  'apikey':'API_KEY'

};

$.ajax({
  url: 'https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'apikey' => 'API_KEY'
}

result = RestClient.get 'https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'apikey': 'API_KEY'
}

r = requests.get('https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules', params={

}, headers = headers)

print r.json()

 'application/json',
    'apikey' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "apikey": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organization/{organization_id}/recurring-schedules

Parameters

Parameter In Type Required Description
schedule_end_date query string false End of duration (from first transaction) being queried, REQUIRED, ISO8601
per_page query string false Results Per Page, Integer, 1-100
include_children query string false If true, also return data for child organizations, Boolean
schedule_start_date query string false Start of duration (from first transaction) being queried, REQUIRED, ISO8601
page query string false Page Number, Integer
creation_start_date query string false Start of duration (from schedule creation) being queried, REQUIRED, ISO8601
creation_end_date query string false End of duration (from schedule creation) being queried, REQUIRED, ISO8601
organization_id path string true No description

Example responses

200 undefined

{
  "result": {
    "count": 0,
    "items": {
      "amount": "string",
      "company_name": "string",
      "designations": [
        {
          "amount": 0,
          "designation": {
            "code": "string",
            "fund_id": "string",
            "id": "string",
            "title": "string"
          }
        }
      ],
      "donor": {
        "contact": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "display_name": "string",
        "id": "string"
      },
      "expires": "2020-06-30T13:37:51Z",
      "history": [
        {
          "attribute": "string",
          "new_value": {},
          "old_value": {},
          "reason": "string",
          "updated_at": "2020-06-30T13:37:51Z",
          "user": "string"
        }
      ],
      "id": "string",
      "next_payment": "2020-06-30T13:37:51Z",
      "organization": {
        "id": "string",
        "name": "string"
      },
      "payment_gateway_id": "string",
      "payment_gateway_name": "string",
      "reference_code": "string",
      "schedule_type": "string",
      "start_date": "2020-06-30T13:37:51Z",
      "updated": "2020-06-30T13:37:51Z"
    },
    "more": true,
    "page": 0,
    "total_count": 0
  },
  "status": 200
}

Responses

Status Meaning Description Schema
200 OK Success RecurringSchedulesResponse

get_recurring_schedule

Code samples

# You can also use wget
curl -X GET https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id} \
  -H 'Accept: application/json' \
  -H 'apikey: API_KEY'

GET https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id} HTTP/1.1
Host: api.idonate.com

Accept: application/json

var headers = {
  'Accept':'application/json',
  'apikey':'API_KEY'

};

$.ajax({
  url: 'https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'apikey' => 'API_KEY'
}

result = RestClient.get 'https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'apikey': 'API_KEY'
}

r = requests.get('https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}', params={

}, headers = headers)

print r.json()

 'application/json',
    'apikey' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "apikey": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.idonate.com/data/20181231/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organization/{organization_id}/recurring-schedules/{recurring_schedule_id}

Parameters

Parameter In Type Required Description
organization_id path string true No description
recurring_schedule_id path string true No description

Example responses

200 undefined

{
  "result": {
    "amount": "string",
    "company_name": "string",
    "designations": [
      {
        "amount": 0,
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        }
      }
    ],
    "donor": {
      "contact": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "display_name": "string",
      "id": "string"
    },
    "expires": "2020-06-30T13:37:51Z",
    "history": [
      {
        "attribute": "string",
        "new_value": {},
        "old_value": {},
        "reason": "string",
        "updated_at": "2020-06-30T13:37:51Z",
        "user": "string"
      }
    ],
    "id": "string",
    "next_payment": "2020-06-30T13:37:51Z",
    "organization": {
      "id": "string",
      "name": "string"
    },
    "payment_gateway_id": "string",
    "payment_gateway_name": "string",
    "reference_code": "string",
    "schedule_type": "string",
    "start_date": "2020-06-30T13:37:51Z",
    "updated": "2020-06-30T13:37:51Z"
  },
  "status": 200
}

Responses

Status Meaning Description Schema
200 OK Success RecurringScheduleResponse

Schemas

Address

{
  "city": "string",
  "country": "string",
  "country_code": "string",
  "country_name": "string",
  "state": "string",
  "street": "string",
  "street2": "string",
  "title": "string",
  "zip": "string"
}

Properties

Name Type Required Description
city string false No description
country string false No description
country_code string false No description
country_name string false No description
state string false No description
street string false No description
street2 string false No description
title string false No description
zip string false No description

AdvocacyPage

{
  "advocate": {
    "address": {
      "city": "string",
      "country": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "zip_code": "string"
    },
    "email": "string",
    "first_name": "string",
    "id": "string",
    "join_date": "2020-06-30T13:37:51Z",
    "last_name": "string",
    "phone": "string"
  },
  "team": {
    "captain": {
      "address": {
        "city": "string",
        "country": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "zip_code": "string"
      },
      "email": "string",
      "first_name": "string",
      "id": "string",
      "join_date": "2020-06-30T13:37:51Z",
      "last_name": "string",
      "phone": "string"
    },
    "id": "string",
    "is_public": true,
    "name": "string",
    "program": {
      "description": "string",
      "end_date": "2020-06-30T13:37:51Z",
      "goal": 0,
      "id": "string",
      "name": "string",
      "organization": {
        "id": "string",
        "name": "string"
      },
      "start_date": "2020-06-30T13:37:51Z",
      "status": "string"
    }
  }
}

Properties

Name Type Required Description
advocate Advocate false No description
team AdvocacyTeam false No description

AdvocacyProgram

{
  "description": "string",
  "end_date": "2020-06-30T13:37:51Z",
  "goal": 0,
  "id": "string",
  "name": "string",
  "organization": {
    "id": "string",
    "name": "string"
  },
  "start_date": "2020-06-30T13:37:51Z",
  "status": "string"
}

Properties

Name Type Required Description
description string false No description
end_date string(date-time) false No description
goal number false No description
id string false No description
name string false No description
organization OrganizationIDAndName false No description
start_date string(date-time) false No description
status string false No description

AdvocacyTeam

{
  "captain": {
    "address": {
      "city": "string",
      "country": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "zip_code": "string"
    },
    "email": "string",
    "first_name": "string",
    "id": "string",
    "join_date": "2020-06-30T13:37:51Z",
    "last_name": "string",
    "phone": "string"
  },
  "id": "string",
  "is_public": true,
  "name": "string",
  "program": {
    "description": "string",
    "end_date": "2020-06-30T13:37:51Z",
    "goal": 0,
    "id": "string",
    "name": "string",
    "organization": {
      "id": "string",
      "name": "string"
    },
    "start_date": "2020-06-30T13:37:51Z",
    "status": "string"
  }
}

Properties

Name Type Required Description
captain Advocate false No description
id string false No description
is_public boolean false No description
name string false No description
program AdvocacyProgram false No description

AdvocacyTeamMember

{
  "advocate": {
    "address": {
      "city": "string",
      "country": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "zip_code": "string"
    },
    "email": "string",
    "first_name": "string",
    "id": "string",
    "join_date": "2020-06-30T13:37:51Z",
    "last_name": "string",
    "phone": "string"
  },
  "team": {
    "captain": {
      "address": {
        "city": "string",
        "country": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "zip_code": "string"
      },
      "email": "string",
      "first_name": "string",
      "id": "string",
      "join_date": "2020-06-30T13:37:51Z",
      "last_name": "string",
      "phone": "string"
    },
    "id": "string",
    "is_public": true,
    "name": "string",
    "program": {
      "description": "string",
      "end_date": "2020-06-30T13:37:51Z",
      "goal": 0,
      "id": "string",
      "name": "string",
      "organization": {
        "id": "string",
        "name": "string"
      },
      "start_date": "2020-06-30T13:37:51Z",
      "status": "string"
    }
  }
}

Properties

Name Type Required Description
advocate Advocate false No description
team AdvocacyTeam false No description

AdvocacyTeamMemberMilestone

{
  "membership": {
    "advocate": {
      "address": {
        "city": "string",
        "country": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "zip_code": "string"
      },
      "email": "string",
      "first_name": "string",
      "id": "string",
      "join_date": "2020-06-30T13:37:51Z",
      "last_name": "string",
      "phone": "string"
    },
    "team": {
      "captain": {
        "address": {
          "city": "string",
          "country": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "zip_code": "string"
        },
        "email": "string",
        "first_name": "string",
        "id": "string",
        "join_date": "2020-06-30T13:37:51Z",
        "last_name": "string",
        "phone": "string"
      },
      "id": "string",
      "is_public": true,
      "name": "string",
      "program": {
        "description": "string",
        "end_date": "2020-06-30T13:37:51Z",
        "goal": 0,
        "id": "string",
        "name": "string",
        "organization": {
          "id": "string",
          "name": "string"
        },
        "start_date": "2020-06-30T13:37:51Z",
        "status": "string"
      }
    }
  },
  "milestone": 0
}

Properties

Name Type Required Description
membership AdvocacyTeamMember false No description
milestone integer false No description

Advocate

{
  "address": {
    "city": "string",
    "country": "string",
    "state": "string",
    "street": "string",
    "street2": "string",
    "zip_code": "string"
  },
  "email": "string",
  "first_name": "string",
  "id": "string",
  "join_date": "2020-06-30T13:37:51Z",
  "last_name": "string",
  "phone": "string"
}

Properties

Name Type Required Description
address AdvocateAddress false No description
email string false No description
first_name string false No description
id string false No description
join_date string(date-time) false No description
last_name string false No description
phone string false No description

AdvocateAddress

{
  "city": "string",
  "country": "string",
  "state": "string",
  "street": "string",
  "street2": "string",
  "zip_code": "string"
}

Properties

Name Type Required Description
city string false No description
country string false No description
state string false No description
street string false No description
street2 string false No description
zip_code string false No description

Contact

{
  "address": {
    "city": "string",
    "country": "string",
    "country_code": "string",
    "country_name": "string",
    "state": "string",
    "street": "string",
    "street2": "string",
    "title": "string",
    "zip": "string"
  },
  "created": "2020-06-30T13:37:51Z",
  "email": "string",
  "firstname": "string",
  "lastname": "string",
  "middlename": "string",
  "phone": "string",
  "timezone": "string",
  "title": "string",
  "updated": "2020-06-30T13:37:51Z"
}

Properties

Name Type Required Description
address Address false No description
created string(date-time) false No description
email string false No description
firstname string false No description
lastname string false No description
middlename string false No description
phone string false No description
timezone string false No description
title string false No description
updated string(date-time) false No description

CorporateMatchingRecord

{
  "company_name": "string",
  "donation_id": 0,
  "matched_transaction_id": "string"
}

Properties

Name Type Required Description
company_name string false No description
donation_id integer false No description
matched_transaction_id string false No description

DesignatedAmount

{
  "amount": 0,
  "designation": {
    "code": "string",
    "fund_id": "string",
    "id": "string",
    "title": "string"
  }
}

Properties

Name Type Required Description
amount number false No description
designation Designation false No description

Designation

{
  "code": "string",
  "fund_id": "string",
  "id": "string",
  "title": "string"
}

Properties

Name Type Required Description
code string false No description
fund_id string false No description
id string false No description
title string false No description

Donor

{
  "contact": {
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "country_name": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "title": "string",
      "zip": "string"
    },
    "created": "2020-06-30T13:37:51Z",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "phone": "string",
    "timezone": "string",
    "title": "string",
    "updated": "2020-06-30T13:37:51Z"
  },
  "display_name": "string",
  "id": "string"
}

Properties

Name Type Required Description
contact Contact false No description
display_name string false No description
id string false No description

DonorContactUpdate

{
  "contact": {
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "country_name": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "title": "string",
      "zip": "string"
    },
    "created": "2020-06-30T13:37:51Z",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "phone": "string",
    "timezone": "string",
    "title": "string",
    "updated": "2020-06-30T13:37:51Z"
  },
  "contact_old": {
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "country_name": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "title": "string",
      "zip": "string"
    },
    "created": "2020-06-30T13:37:51Z",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "phone": "string",
    "timezone": "string",
    "title": "string",
    "updated": "2020-06-30T13:37:51Z"
  },
  "id": "string"
}

Properties

Name Type Required Description
contact Contact false No description
contact_old Contact false No description
id string false No description

Embed

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Description
id string false No description
name string false No description

Gift

{
  "created": "2020-06-30T13:37:51Z",
  "description": "string",
  "extra_placeholder": "string",
  "gift_value": 0,
  "id": "string",
  "image_url": "string",
  "is_disabled": true,
  "sku": "string",
  "updated": "2020-06-30T13:37:51Z"
}

Properties

Name Type Required Description
created string(date-time) false No description
description string false No description
extra_placeholder string false No description
gift_value number false No description
id string false No description
image_url string false No description
is_disabled boolean false No description
sku string false No description
updated string(date-time) false No description

HistoryItem

{
  "attribute": "string",
  "new_value": {},
  "old_value": {},
  "reason": "string",
  "updated_at": "2020-06-30T13:37:51Z",
  "user": "string"
}

Properties

Name Type Required Description
attribute string false No description
new_value object false No description
old_value object false No description
reason string false No description
updated_at string(date-time) false No description
user string false No description

OrganizationDonor

{
  "donor": {
    "contact": {
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "email": "string",
      "firstname": "string",
      "lastname": "string",
      "middlename": "string",
      "phone": "string",
      "timezone": "string",
      "title": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "display_name": "string",
    "id": "string"
  },
  "organization": {
    "id": "string",
    "name": "string"
  }
}

Properties

Name Type Required Description
donor Donor false No description
organization OrganizationIDAndName false No description

OrganizationDonorSchedules

{
  "donor": {
    "contact": {
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "email": "string",
      "firstname": "string",
      "lastname": "string",
      "middlename": "string",
      "phone": "string",
      "timezone": "string",
      "title": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "display_name": "string",
    "id": "string"
  },
  "organization": {
    "id": "string",
    "name": "string"
  },
  "schedules": [
    {
      "amount": "string",
      "company_name": "string",
      "designations": [
        {
          "amount": 0,
          "designation": {
            "code": "string",
            "fund_id": "string",
            "id": "string",
            "title": "string"
          }
        }
      ],
      "donor": {
        "contact": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "display_name": "string",
        "id": "string"
      },
      "expires": "2020-06-30T13:37:51Z",
      "history": [
        {
          "attribute": "string",
          "new_value": {},
          "old_value": {},
          "reason": "string",
          "updated_at": "2020-06-30T13:37:51Z",
          "user": "string"
        }
      ],
      "id": "string",
      "next_payment": "2020-06-30T13:37:51Z",
      "organization": {
        "id": "string",
        "name": "string"
      },
      "payment_gateway_id": "string",
      "payment_gateway_name": "string",
      "reference_code": "string",
      "schedule_type": "string",
      "start_date": "2020-06-30T13:37:51Z",
      "updated": "2020-06-30T13:37:51Z"
    }
  ]
}

Properties

Name Type Required Description
donor Donor false No description
organization OrganizationIDAndName false No description
schedules [RecurringDonationSchedule] false No description

OrganizationIDAndName

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Description
id string false No description
name string false No description

RecurringDonationSchedule

{
  "amount": "string",
  "company_name": "string",
  "designations": [
    {
      "amount": 0,
      "designation": {
        "code": "string",
        "fund_id": "string",
        "id": "string",
        "title": "string"
      }
    }
  ],
  "donor": {
    "contact": {
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "email": "string",
      "firstname": "string",
      "lastname": "string",
      "middlename": "string",
      "phone": "string",
      "timezone": "string",
      "title": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "display_name": "string",
    "id": "string"
  },
  "expires": "2020-06-30T13:37:51Z",
  "history": [
    {
      "attribute": "string",
      "new_value": {},
      "old_value": {},
      "reason": "string",
      "updated_at": "2020-06-30T13:37:51Z",
      "user": "string"
    }
  ],
  "id": "string",
  "next_payment": "2020-06-30T13:37:51Z",
  "organization": {
    "id": "string",
    "name": "string"
  },
  "payment_gateway_id": "string",
  "payment_gateway_name": "string",
  "reference_code": "string",
  "schedule_type": "string",
  "start_date": "2020-06-30T13:37:51Z",
  "updated": "2020-06-30T13:37:51Z"
}

Properties

Name Type Required Description
amount string false No description
company_name string false No description
designations [DesignatedAmount] false No description
donor Donor false No description
expires string(date-time) false No description
history [HistoryItem] false No description
id string false No description
next_payment string(date-time) false No description
organization OrganizationIDAndName false No description
payment_gateway_id string false No description
payment_gateway_name string false No description
reference_code string false No description
schedule_type string false No description
start_date string(date-time) false No description
updated string(date-time) false No description

RecurringDonationScheduleCancelled

{
  "reason": "string",
  "schedule": {
    "amount": "string",
    "company_name": "string",
    "designations": [
      {
        "amount": 0,
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        }
      }
    ],
    "donor": {
      "contact": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "display_name": "string",
      "id": "string"
    },
    "expires": "2020-06-30T13:37:51Z",
    "history": [
      {
        "attribute": "string",
        "new_value": {},
        "old_value": {},
        "reason": "string",
        "updated_at": "2020-06-30T13:37:51Z",
        "user": "string"
      }
    ],
    "id": "string",
    "next_payment": "2020-06-30T13:37:51Z",
    "organization": {
      "id": "string",
      "name": "string"
    },
    "payment_gateway_id": "string",
    "payment_gateway_name": "string",
    "reference_code": "string",
    "schedule_type": "string",
    "start_date": "2020-06-30T13:37:51Z",
    "updated": "2020-06-30T13:37:51Z"
  }
}

Properties

Name Type Required Description
reason string false No description
schedule RecurringDonationSchedule false No description

RecurringScheduleResponse

{
  "result": {
    "amount": "string",
    "company_name": "string",
    "designations": [
      {
        "amount": 0,
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        }
      }
    ],
    "donor": {
      "contact": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "display_name": "string",
      "id": "string"
    },
    "expires": "2020-06-30T13:37:51Z",
    "history": [
      {
        "attribute": "string",
        "new_value": {},
        "old_value": {},
        "reason": "string",
        "updated_at": "2020-06-30T13:37:51Z",
        "user": "string"
      }
    ],
    "id": "string",
    "next_payment": "2020-06-30T13:37:51Z",
    "organization": {
      "id": "string",
      "name": "string"
    },
    "payment_gateway_id": "string",
    "payment_gateway_name": "string",
    "reference_code": "string",
    "schedule_type": "string",
    "start_date": "2020-06-30T13:37:51Z",
    "updated": "2020-06-30T13:37:51Z"
  },
  "status": 200
}

Properties

Name Type Required Description
result RecurringDonationSchedule false No description
status integer false No description

RecurringSchedulesResponse

{
  "result": {
    "count": 0,
    "items": {
      "amount": "string",
      "company_name": "string",
      "designations": [
        {
          "amount": 0,
          "designation": {
            "code": "string",
            "fund_id": "string",
            "id": "string",
            "title": "string"
          }
        }
      ],
      "donor": {
        "contact": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "display_name": "string",
        "id": "string"
      },
      "expires": "2020-06-30T13:37:51Z",
      "history": [
        {
          "attribute": "string",
          "new_value": {},
          "old_value": {},
          "reason": "string",
          "updated_at": "2020-06-30T13:37:51Z",
          "user": "string"
        }
      ],
      "id": "string",
      "next_payment": "2020-06-30T13:37:51Z",
      "organization": {
        "id": "string",
        "name": "string"
      },
      "payment_gateway_id": "string",
      "payment_gateway_name": "string",
      "reference_code": "string",
      "schedule_type": "string",
      "start_date": "2020-06-30T13:37:51Z",
      "updated": "2020-06-30T13:37:51Z"
    },
    "more": true,
    "page": 0,
    "total_count": 0
  },
  "status": 200
}

Properties

Name Type Required Description
result RecurringSchedulesResult false No description
status integer false No description

RecurringSchedulesResult

{
  "count": 0,
  "items": {
    "amount": "string",
    "company_name": "string",
    "designations": [
      {
        "amount": 0,
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        }
      }
    ],
    "donor": {
      "contact": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "display_name": "string",
      "id": "string"
    },
    "expires": "2020-06-30T13:37:51Z",
    "history": [
      {
        "attribute": "string",
        "new_value": {},
        "old_value": {},
        "reason": "string",
        "updated_at": "2020-06-30T13:37:51Z",
        "user": "string"
      }
    ],
    "id": "string",
    "next_payment": "2020-06-30T13:37:51Z",
    "organization": {
      "id": "string",
      "name": "string"
    },
    "payment_gateway_id": "string",
    "payment_gateway_name": "string",
    "reference_code": "string",
    "schedule_type": "string",
    "start_date": "2020-06-30T13:37:51Z",
    "updated": "2020-06-30T13:37:51Z"
  },
  "more": true,
  "page": 0,
  "total_count": 0
}

Properties

Name Type Required Description
count integer false No description
items RecurringDonationSchedule false No description
more boolean false No description
page integer false No description
total_count integer false No description

Transaction

{
  "additional_info": "string",
  "address": {
    "city": "string",
    "country": "string",
    "country_code": "string",
    "country_name": "string",
    "state": "string",
    "street": "string",
    "street2": "string",
    "title": "string",
    "zip": "string"
  },
  "advocacy_program_id": "string",
  "advocacy_program_name": "string",
  "advocacy_team_id": "string",
  "advocacy_team_name": "string",
  "advocate": {
    "address": {
      "city": "string",
      "country": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "zip_code": "string"
    },
    "email": "string",
    "first_name": "string",
    "id": "string",
    "join_date": "2020-06-30T13:37:51Z",
    "last_name": "string",
    "phone": "string"
  },
  "advocate_id": "string",
  "advocate_name": "string",
  "campaign_id": "string",
  "campaign_title": "string",
  "card_type": "string",
  "check_number": "string",
  "client_proceeds": 0,
  "company_name": "string",
  "contact": {
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "country_name": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "title": "string",
      "zip": "string"
    },
    "created": "2020-06-30T13:37:51Z",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "phone": "string",
    "timezone": "string",
    "title": "string",
    "updated": "2020-06-30T13:37:51Z"
  },
  "corporate_matching_record": {
    "company_name": "string",
    "donation_id": 0,
    "matched_transaction_id": "string"
  },
  "created": "2020-06-30T13:37:51Z",
  "custom_note_1": "string",
  "custom_note_2": "string",
  "custom_note_3": "string",
  "custom_note_4": "string",
  "custom_note_5": "string",
  "description": "string",
  "designation": {
    "code": "string",
    "fund_id": "string",
    "id": "string",
    "title": "string"
  },
  "designation_note": "string",
  "donor_id": "string",
  "donor_paid_fee": 0,
  "email_opt_in": true,
  "embed": {
    "id": "string",
    "name": "string"
  },
  "expiration_month": 0,
  "expiration_year": 0,
  "external_tracking_id": "string",
  "final_date": "2020-06-30T13:37:51Z",
  "frequency": "string",
  "gift": {
    "created": "2020-06-30T13:37:51Z",
    "description": "string",
    "extra_placeholder": "string",
    "gift_value": 0,
    "id": "string",
    "image_url": "string",
    "is_disabled": true,
    "sku": "string",
    "updated": "2020-06-30T13:37:51Z"
  },
  "gift_extra": "string",
  "hide_name": true,
  "id": "string",
  "last_four_digits": "string",
  "net_proceeds": 0,
  "organization_id": "string",
  "payment_gateway_id": "string",
  "payment_gateway_name": "string",
  "payment_transaction_id": "string",
  "recurring_count": 0,
  "reference_code": "string",
  "sale_price": 0,
  "schedule_id": "string",
  "sms_keyword": "string",
  "status": "string",
  "subtype": "string",
  "transaction_set_id": "string",
  "tribute": {
    "definition": {
      "description": "string",
      "id": "string",
      "image_key": "string",
      "image_url": "string",
      "is_disabled": true,
      "recipient_address_required": true,
      "recipient_email_required": true
    },
    "from_name": "string",
    "honorees": [
      {
        "firstname": "string",
        "lastname": "string",
        "message": "string"
      }
    ],
    "include_amount": true,
    "recipient": {
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "email": "string",
      "firstname": "string",
      "lastname": "string",
      "middlename": "string",
      "phone": "string",
      "timezone": "string",
      "title": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "send_card": true
  },
  "type": "string",
  "utm": {
    "campaign": "string",
    "content": "string",
    "medium": "string",
    "source": "string",
    "term": "string"
  },
  "vendor_id": 0
}

Properties

Name Type Required Description
additional_info string false No description
address Address false No description
advocacy_program_id string false No description
advocacy_program_name string false No description
advocacy_team_id string false No description
advocacy_team_name string false No description
advocate Advocate false No description
advocate_id string false No description
advocate_name string false No description
campaign_id string false No description
campaign_title string false No description
card_type string false No description
check_number string false No description
client_proceeds number false No description
company_name string false No description
contact Contact false No description
corporate_matching_record CorporateMatchingRecord false No description
created string(date-time) false No description
custom_note_1 string false No description
custom_note_2 string false No description
custom_note_3 string false No description
custom_note_4 string false No description
custom_note_5 string false No description
description string false No description
designation Designation false No description
designation_note string false No description
donor_id string false No description
donor_paid_fee number false No description
email_opt_in boolean false No description
embed Embed false No description
expiration_month integer false No description
expiration_year integer false No description
external_tracking_id string false No description
final_date string(date-time) false No description
frequency string false No description
gift Gift false No description
gift_extra string false No description
hide_name boolean false No description
id string false No description
last_four_digits string false No description
net_proceeds number false No description
organization_id string false No description
payment_gateway_id string false No description
payment_gateway_name string false No description
payment_transaction_id string false No description
recurring_count integer false No description
reference_code string false No description
sale_price number false No description
schedule_id string false No description
sms_keyword string false No description
status string false No description
subtype string false No description
transaction_set_id string false No description
tribute Tribute false No description
type string false No description
utm TransactionUtm false No description
vendor_id integer false No description

TransactionHonoree

{
  "firstname": "string",
  "lastname": "string",
  "message": "string"
}

Properties

Name Type Required Description
firstname string false No description
lastname string false No description
message string false No description

TransactionResponse

{
  "result": {
    "additional_info": "string",
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "country_name": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "title": "string",
      "zip": "string"
    },
    "advocacy_program_id": "string",
    "advocacy_program_name": "string",
    "advocacy_team_id": "string",
    "advocacy_team_name": "string",
    "advocate": {
      "address": {
        "city": "string",
        "country": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "zip_code": "string"
      },
      "email": "string",
      "first_name": "string",
      "id": "string",
      "join_date": "2020-06-30T13:37:51Z",
      "last_name": "string",
      "phone": "string"
    },
    "advocate_id": "string",
    "advocate_name": "string",
    "campaign_id": "string",
    "campaign_title": "string",
    "card_type": "string",
    "check_number": "string",
    "client_proceeds": 0,
    "company_name": "string",
    "contact": {
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "email": "string",
      "firstname": "string",
      "lastname": "string",
      "middlename": "string",
      "phone": "string",
      "timezone": "string",
      "title": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "corporate_matching_record": {
      "company_name": "string",
      "donation_id": 0,
      "matched_transaction_id": "string"
    },
    "created": "2020-06-30T13:37:51Z",
    "custom_note_1": "string",
    "custom_note_2": "string",
    "custom_note_3": "string",
    "custom_note_4": "string",
    "custom_note_5": "string",
    "description": "string",
    "designation": {
      "code": "string",
      "fund_id": "string",
      "id": "string",
      "title": "string"
    },
    "designation_note": "string",
    "donor_id": "string",
    "donor_paid_fee": 0,
    "email_opt_in": true,
    "embed": {
      "id": "string",
      "name": "string"
    },
    "expiration_month": 0,
    "expiration_year": 0,
    "external_tracking_id": "string",
    "final_date": "2020-06-30T13:37:51Z",
    "frequency": "string",
    "gift": {
      "created": "2020-06-30T13:37:51Z",
      "description": "string",
      "extra_placeholder": "string",
      "gift_value": 0,
      "id": "string",
      "image_url": "string",
      "is_disabled": true,
      "sku": "string",
      "updated": "2020-06-30T13:37:51Z"
    },
    "gift_extra": "string",
    "hide_name": true,
    "id": "string",
    "last_four_digits": "string",
    "net_proceeds": 0,
    "organization_id": "string",
    "payment_gateway_id": "string",
    "payment_gateway_name": "string",
    "payment_transaction_id": "string",
    "recurring_count": 0,
    "reference_code": "string",
    "sale_price": 0,
    "schedule_id": "string",
    "sms_keyword": "string",
    "status": "string",
    "subtype": "string",
    "transaction_set_id": "string",
    "tribute": {
      "definition": {
        "description": "string",
        "id": "string",
        "image_key": "string",
        "image_url": "string",
        "is_disabled": true,
        "recipient_address_required": true,
        "recipient_email_required": true
      },
      "from_name": "string",
      "honorees": [
        {
          "firstname": "string",
          "lastname": "string",
          "message": "string"
        }
      ],
      "include_amount": true,
      "recipient": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "send_card": true
    },
    "type": "string",
    "utm": {
      "campaign": "string",
      "content": "string",
      "medium": "string",
      "source": "string",
      "term": "string"
    },
    "vendor_id": 0
  },
  "status": 200
}

Properties

Name Type Required Description
result Transaction false No description
status integer false No description

TransactionSet

{
  "created": "2020-06-30T13:37:51Z",
  "id": "string",
  "organization_id": "string",
  "transactions": [
    {
      "additional_info": "string",
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "advocacy_program_id": "string",
      "advocacy_program_name": "string",
      "advocacy_team_id": "string",
      "advocacy_team_name": "string",
      "advocate": {
        "address": {
          "city": "string",
          "country": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "zip_code": "string"
        },
        "email": "string",
        "first_name": "string",
        "id": "string",
        "join_date": "2020-06-30T13:37:51Z",
        "last_name": "string",
        "phone": "string"
      },
      "advocate_id": "string",
      "advocate_name": "string",
      "campaign_id": "string",
      "campaign_title": "string",
      "card_type": "string",
      "check_number": "string",
      "client_proceeds": 0,
      "company_name": "string",
      "contact": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "corporate_matching_record": {
        "company_name": "string",
        "donation_id": 0,
        "matched_transaction_id": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "custom_note_1": "string",
      "custom_note_2": "string",
      "custom_note_3": "string",
      "custom_note_4": "string",
      "custom_note_5": "string",
      "description": "string",
      "designation": {
        "code": "string",
        "fund_id": "string",
        "id": "string",
        "title": "string"
      },
      "designation_note": "string",
      "donor_id": "string",
      "donor_paid_fee": 0,
      "email_opt_in": true,
      "embed": {
        "id": "string",
        "name": "string"
      },
      "expiration_month": 0,
      "expiration_year": 0,
      "external_tracking_id": "string",
      "final_date": "2020-06-30T13:37:51Z",
      "frequency": "string",
      "gift": {
        "created": "2020-06-30T13:37:51Z",
        "description": "string",
        "extra_placeholder": "string",
        "gift_value": 0,
        "id": "string",
        "image_url": "string",
        "is_disabled": true,
        "sku": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "gift_extra": "string",
      "hide_name": true,
      "id": "string",
      "last_four_digits": "string",
      "net_proceeds": 0,
      "organization_id": "string",
      "payment_gateway_id": "string",
      "payment_gateway_name": "string",
      "payment_transaction_id": "string",
      "recurring_count": 0,
      "reference_code": "string",
      "sale_price": 0,
      "schedule_id": "string",
      "sms_keyword": "string",
      "status": "string",
      "subtype": "string",
      "transaction_set_id": "string",
      "tribute": {
        "definition": {
          "description": "string",
          "id": "string",
          "image_key": "string",
          "image_url": "string",
          "is_disabled": true,
          "recipient_address_required": true,
          "recipient_email_required": true
        },
        "from_name": "string",
        "honorees": [
          {
            "firstname": "string",
            "lastname": "string",
            "message": "string"
          }
        ],
        "include_amount": true,
        "recipient": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "send_card": true
      },
      "type": "string",
      "utm": {
        "campaign": "string",
        "content": "string",
        "medium": "string",
        "source": "string",
        "term": "string"
      },
      "vendor_id": 0
    }
  ]
}

Properties

Name Type Required Description
created string(date-time) false No description
id string false No description
organization_id string false No description
transactions [Transaction] false No description

TransactionSetResponse

{
  "result": {
    "created": "2020-06-30T13:37:51Z",
    "id": "string",
    "organization_id": "string",
    "transactions": [
      {
        "additional_info": "string",
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "advocacy_program_id": "string",
        "advocacy_program_name": "string",
        "advocacy_team_id": "string",
        "advocacy_team_name": "string",
        "advocate": {
          "address": {
            "city": "string",
            "country": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "zip_code": "string"
          },
          "email": "string",
          "first_name": "string",
          "id": "string",
          "join_date": "2020-06-30T13:37:51Z",
          "last_name": "string",
          "phone": "string"
        },
        "advocate_id": "string",
        "advocate_name": "string",
        "campaign_id": "string",
        "campaign_title": "string",
        "card_type": "string",
        "check_number": "string",
        "client_proceeds": 0,
        "company_name": "string",
        "contact": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "corporate_matching_record": {
          "company_name": "string",
          "donation_id": 0,
          "matched_transaction_id": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "custom_note_1": "string",
        "custom_note_2": "string",
        "custom_note_3": "string",
        "custom_note_4": "string",
        "custom_note_5": "string",
        "description": "string",
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        },
        "designation_note": "string",
        "donor_id": "string",
        "donor_paid_fee": 0,
        "email_opt_in": true,
        "embed": {
          "id": "string",
          "name": "string"
        },
        "expiration_month": 0,
        "expiration_year": 0,
        "external_tracking_id": "string",
        "final_date": "2020-06-30T13:37:51Z",
        "frequency": "string",
        "gift": {
          "created": "2020-06-30T13:37:51Z",
          "description": "string",
          "extra_placeholder": "string",
          "gift_value": 0,
          "id": "string",
          "image_url": "string",
          "is_disabled": true,
          "sku": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "gift_extra": "string",
        "hide_name": true,
        "id": "string",
        "last_four_digits": "string",
        "net_proceeds": 0,
        "organization_id": "string",
        "payment_gateway_id": "string",
        "payment_gateway_name": "string",
        "payment_transaction_id": "string",
        "recurring_count": 0,
        "reference_code": "string",
        "sale_price": 0,
        "schedule_id": "string",
        "sms_keyword": "string",
        "status": "string",
        "subtype": "string",
        "transaction_set_id": "string",
        "tribute": {
          "definition": {
            "description": "string",
            "id": "string",
            "image_key": "string",
            "image_url": "string",
            "is_disabled": true,
            "recipient_address_required": true,
            "recipient_email_required": true
          },
          "from_name": "string",
          "honorees": [
            {
              "firstname": "string",
              "lastname": "string",
              "message": "string"
            }
          ],
          "include_amount": true,
          "recipient": {
            "address": {
              "city": "string",
              "country": "string",
              "country_code": "string",
              "country_name": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "title": "string",
              "zip": "string"
            },
            "created": "2020-06-30T13:37:51Z",
            "email": "string",
            "firstname": "string",
            "lastname": "string",
            "middlename": "string",
            "phone": "string",
            "timezone": "string",
            "title": "string",
            "updated": "2020-06-30T13:37:51Z"
          },
          "send_card": true
        },
        "type": "string",
        "utm": {
          "campaign": "string",
          "content": "string",
          "medium": "string",
          "source": "string",
          "term": "string"
        },
        "vendor_id": 0
      }
    ]
  },
  "status": 200
}

Properties

Name Type Required Description
result TransactionSet false No description
status integer false No description

TransactionSetsResponse

{
  "result": {
    "count": 0,
    "items": [
      {
        "created": "2020-06-30T13:37:51Z",
        "id": "string",
        "organization_id": "string",
        "transactions": [
          {
            "additional_info": "string",
            "address": {
              "city": "string",
              "country": "string",
              "country_code": "string",
              "country_name": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "title": "string",
              "zip": "string"
            },
            "advocacy_program_id": "string",
            "advocacy_program_name": "string",
            "advocacy_team_id": "string",
            "advocacy_team_name": "string",
            "advocate": {
              "address": {
                "city": "string",
                "country": "string",
                "state": "string",
                "street": "string",
                "street2": "string",
                "zip_code": "string"
              },
              "email": "string",
              "first_name": "string",
              "id": "string",
              "join_date": "2020-06-30T13:37:51Z",
              "last_name": "string",
              "phone": "string"
            },
            "advocate_id": "string",
            "advocate_name": "string",
            "campaign_id": "string",
            "campaign_title": "string",
            "card_type": "string",
            "check_number": "string",
            "client_proceeds": 0,
            "company_name": "string",
            "contact": {
              "address": {
                "city": "string",
                "country": "string",
                "country_code": "string",
                "country_name": "string",
                "state": "string",
                "street": "string",
                "street2": "string",
                "title": "string",
                "zip": "string"
              },
              "created": "2020-06-30T13:37:51Z",
              "email": "string",
              "firstname": "string",
              "lastname": "string",
              "middlename": "string",
              "phone": "string",
              "timezone": "string",
              "title": "string",
              "updated": "2020-06-30T13:37:51Z"
            },
            "corporate_matching_record": {
              "company_name": "string",
              "donation_id": 0,
              "matched_transaction_id": "string"
            },
            "created": "2020-06-30T13:37:51Z",
            "custom_note_1": "string",
            "custom_note_2": "string",
            "custom_note_3": "string",
            "custom_note_4": "string",
            "custom_note_5": "string",
            "description": "string",
            "designation": {
              "code": "string",
              "fund_id": "string",
              "id": "string",
              "title": "string"
            },
            "designation_note": "string",
            "donor_id": "string",
            "donor_paid_fee": 0,
            "email_opt_in": true,
            "embed": {
              "id": "string",
              "name": "string"
            },
            "expiration_month": 0,
            "expiration_year": 0,
            "external_tracking_id": "string",
            "final_date": "2020-06-30T13:37:51Z",
            "frequency": "string",
            "gift": {
              "created": "2020-06-30T13:37:51Z",
              "description": "string",
              "extra_placeholder": "string",
              "gift_value": 0,
              "id": "string",
              "image_url": "string",
              "is_disabled": true,
              "sku": "string",
              "updated": "2020-06-30T13:37:51Z"
            },
            "gift_extra": "string",
            "hide_name": true,
            "id": "string",
            "last_four_digits": "string",
            "net_proceeds": 0,
            "organization_id": "string",
            "payment_gateway_id": "string",
            "payment_gateway_name": "string",
            "payment_transaction_id": "string",
            "recurring_count": 0,
            "reference_code": "string",
            "sale_price": 0,
            "schedule_id": "string",
            "sms_keyword": "string",
            "status": "string",
            "subtype": "string",
            "transaction_set_id": "string",
            "tribute": {
              "definition": {
                "description": "string",
                "id": "string",
                "image_key": "string",
                "image_url": "string",
                "is_disabled": true,
                "recipient_address_required": true,
                "recipient_email_required": true
              },
              "from_name": "string",
              "honorees": [
                {
                  "firstname": "string",
                  "lastname": "string",
                  "message": "string"
                }
              ],
              "include_amount": true,
              "recipient": {
                "address": {
                  "city": "string",
                  "country": "string",
                  "country_code": "string",
                  "country_name": "string",
                  "state": "string",
                  "street": "string",
                  "street2": "string",
                  "title": "string",
                  "zip": "string"
                },
                "created": "2020-06-30T13:37:51Z",
                "email": "string",
                "firstname": "string",
                "lastname": "string",
                "middlename": "string",
                "phone": "string",
                "timezone": "string",
                "title": "string",
                "updated": "2020-06-30T13:37:51Z"
              },
              "send_card": true
            },
            "type": "string",
            "utm": {
              "campaign": "string",
              "content": "string",
              "medium": "string",
              "source": "string",
              "term": "string"
            },
            "vendor_id": 0
          }
        ]
      }
    ],
    "more": true,
    "page": 0,
    "total_count": 0
  },
  "status": 200
}

Properties

Name Type Required Description
result TransactionSetsResult false No description
status integer false No description

TransactionSetsResult

{
  "count": 0,
  "items": [
    {
      "created": "2020-06-30T13:37:51Z",
      "id": "string",
      "organization_id": "string",
      "transactions": [
        {
          "additional_info": "string",
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "advocacy_program_id": "string",
          "advocacy_program_name": "string",
          "advocacy_team_id": "string",
          "advocacy_team_name": "string",
          "advocate": {
            "address": {
              "city": "string",
              "country": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "zip_code": "string"
            },
            "email": "string",
            "first_name": "string",
            "id": "string",
            "join_date": "2020-06-30T13:37:51Z",
            "last_name": "string",
            "phone": "string"
          },
          "advocate_id": "string",
          "advocate_name": "string",
          "campaign_id": "string",
          "campaign_title": "string",
          "card_type": "string",
          "check_number": "string",
          "client_proceeds": 0,
          "company_name": "string",
          "contact": {
            "address": {
              "city": "string",
              "country": "string",
              "country_code": "string",
              "country_name": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "title": "string",
              "zip": "string"
            },
            "created": "2020-06-30T13:37:51Z",
            "email": "string",
            "firstname": "string",
            "lastname": "string",
            "middlename": "string",
            "phone": "string",
            "timezone": "string",
            "title": "string",
            "updated": "2020-06-30T13:37:51Z"
          },
          "corporate_matching_record": {
            "company_name": "string",
            "donation_id": 0,
            "matched_transaction_id": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "custom_note_1": "string",
          "custom_note_2": "string",
          "custom_note_3": "string",
          "custom_note_4": "string",
          "custom_note_5": "string",
          "description": "string",
          "designation": {
            "code": "string",
            "fund_id": "string",
            "id": "string",
            "title": "string"
          },
          "designation_note": "string",
          "donor_id": "string",
          "donor_paid_fee": 0,
          "email_opt_in": true,
          "embed": {
            "id": "string",
            "name": "string"
          },
          "expiration_month": 0,
          "expiration_year": 0,
          "external_tracking_id": "string",
          "final_date": "2020-06-30T13:37:51Z",
          "frequency": "string",
          "gift": {
            "created": "2020-06-30T13:37:51Z",
            "description": "string",
            "extra_placeholder": "string",
            "gift_value": 0,
            "id": "string",
            "image_url": "string",
            "is_disabled": true,
            "sku": "string",
            "updated": "2020-06-30T13:37:51Z"
          },
          "gift_extra": "string",
          "hide_name": true,
          "id": "string",
          "last_four_digits": "string",
          "net_proceeds": 0,
          "organization_id": "string",
          "payment_gateway_id": "string",
          "payment_gateway_name": "string",
          "payment_transaction_id": "string",
          "recurring_count": 0,
          "reference_code": "string",
          "sale_price": 0,
          "schedule_id": "string",
          "sms_keyword": "string",
          "status": "string",
          "subtype": "string",
          "transaction_set_id": "string",
          "tribute": {
            "definition": {
              "description": "string",
              "id": "string",
              "image_key": "string",
              "image_url": "string",
              "is_disabled": true,
              "recipient_address_required": true,
              "recipient_email_required": true
            },
            "from_name": "string",
            "honorees": [
              {
                "firstname": "string",
                "lastname": "string",
                "message": "string"
              }
            ],
            "include_amount": true,
            "recipient": {
              "address": {
                "city": "string",
                "country": "string",
                "country_code": "string",
                "country_name": "string",
                "state": "string",
                "street": "string",
                "street2": "string",
                "title": "string",
                "zip": "string"
              },
              "created": "2020-06-30T13:37:51Z",
              "email": "string",
              "firstname": "string",
              "lastname": "string",
              "middlename": "string",
              "phone": "string",
              "timezone": "string",
              "title": "string",
              "updated": "2020-06-30T13:37:51Z"
            },
            "send_card": true
          },
          "type": "string",
          "utm": {
            "campaign": "string",
            "content": "string",
            "medium": "string",
            "source": "string",
            "term": "string"
          },
          "vendor_id": 0
        }
      ]
    }
  ],
  "more": true,
  "page": 0,
  "total_count": 0
}

Properties

Name Type Required Description
count integer false No description
items [TransactionSet] false No description
more boolean false No description
page integer false No description
total_count integer false No description

TransactionUtm

{
  "campaign": "string",
  "content": "string",
  "medium": "string",
  "source": "string",
  "term": "string"
}

Properties

Name Type Required Description
campaign string false No description
content string false No description
medium string false No description
source string false No description
term string false No description

TransactionsResponse

{
  "result": {
    "count": 0,
    "items": [
      {
        "additional_info": "string",
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "advocacy_program_id": "string",
        "advocacy_program_name": "string",
        "advocacy_team_id": "string",
        "advocacy_team_name": "string",
        "advocate": {
          "address": {
            "city": "string",
            "country": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "zip_code": "string"
          },
          "email": "string",
          "first_name": "string",
          "id": "string",
          "join_date": "2020-06-30T13:37:51Z",
          "last_name": "string",
          "phone": "string"
        },
        "advocate_id": "string",
        "advocate_name": "string",
        "campaign_id": "string",
        "campaign_title": "string",
        "card_type": "string",
        "check_number": "string",
        "client_proceeds": 0,
        "company_name": "string",
        "contact": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "corporate_matching_record": {
          "company_name": "string",
          "donation_id": 0,
          "matched_transaction_id": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "custom_note_1": "string",
        "custom_note_2": "string",
        "custom_note_3": "string",
        "custom_note_4": "string",
        "custom_note_5": "string",
        "description": "string",
        "designation": {
          "code": "string",
          "fund_id": "string",
          "id": "string",
          "title": "string"
        },
        "designation_note": "string",
        "donor_id": "string",
        "donor_paid_fee": 0,
        "email_opt_in": true,
        "embed": {
          "id": "string",
          "name": "string"
        },
        "expiration_month": 0,
        "expiration_year": 0,
        "external_tracking_id": "string",
        "final_date": "2020-06-30T13:37:51Z",
        "frequency": "string",
        "gift": {
          "created": "2020-06-30T13:37:51Z",
          "description": "string",
          "extra_placeholder": "string",
          "gift_value": 0,
          "id": "string",
          "image_url": "string",
          "is_disabled": true,
          "sku": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "gift_extra": "string",
        "hide_name": true,
        "id": "string",
        "last_four_digits": "string",
        "net_proceeds": 0,
        "organization_id": "string",
        "payment_gateway_id": "string",
        "payment_gateway_name": "string",
        "payment_transaction_id": "string",
        "recurring_count": 0,
        "reference_code": "string",
        "sale_price": 0,
        "schedule_id": "string",
        "sms_keyword": "string",
        "status": "string",
        "subtype": "string",
        "transaction_set_id": "string",
        "tribute": {
          "definition": {
            "description": "string",
            "id": "string",
            "image_key": "string",
            "image_url": "string",
            "is_disabled": true,
            "recipient_address_required": true,
            "recipient_email_required": true
          },
          "from_name": "string",
          "honorees": [
            {
              "firstname": "string",
              "lastname": "string",
              "message": "string"
            }
          ],
          "include_amount": true,
          "recipient": {
            "address": {
              "city": "string",
              "country": "string",
              "country_code": "string",
              "country_name": "string",
              "state": "string",
              "street": "string",
              "street2": "string",
              "title": "string",
              "zip": "string"
            },
            "created": "2020-06-30T13:37:51Z",
            "email": "string",
            "firstname": "string",
            "lastname": "string",
            "middlename": "string",
            "phone": "string",
            "timezone": "string",
            "title": "string",
            "updated": "2020-06-30T13:37:51Z"
          },
          "send_card": true
        },
        "type": "string",
        "utm": {
          "campaign": "string",
          "content": "string",
          "medium": "string",
          "source": "string",
          "term": "string"
        },
        "vendor_id": 0
      }
    ],
    "more": true,
    "page": 0,
    "total_count": 0
  },
  "status": 200
}

Properties

Name Type Required Description
result TransactionsResult false No description
status integer false No description

TransactionsResult

{
  "count": 0,
  "items": [
    {
      "additional_info": "string",
      "address": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "state": "string",
        "street": "string",
        "street2": "string",
        "title": "string",
        "zip": "string"
      },
      "advocacy_program_id": "string",
      "advocacy_program_name": "string",
      "advocacy_team_id": "string",
      "advocacy_team_name": "string",
      "advocate": {
        "address": {
          "city": "string",
          "country": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "zip_code": "string"
        },
        "email": "string",
        "first_name": "string",
        "id": "string",
        "join_date": "2020-06-30T13:37:51Z",
        "last_name": "string",
        "phone": "string"
      },
      "advocate_id": "string",
      "advocate_name": "string",
      "campaign_id": "string",
      "campaign_title": "string",
      "card_type": "string",
      "check_number": "string",
      "client_proceeds": 0,
      "company_name": "string",
      "contact": {
        "address": {
          "city": "string",
          "country": "string",
          "country_code": "string",
          "country_name": "string",
          "state": "string",
          "street": "string",
          "street2": "string",
          "title": "string",
          "zip": "string"
        },
        "created": "2020-06-30T13:37:51Z",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "phone": "string",
        "timezone": "string",
        "title": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "corporate_matching_record": {
        "company_name": "string",
        "donation_id": 0,
        "matched_transaction_id": "string"
      },
      "created": "2020-06-30T13:37:51Z",
      "custom_note_1": "string",
      "custom_note_2": "string",
      "custom_note_3": "string",
      "custom_note_4": "string",
      "custom_note_5": "string",
      "description": "string",
      "designation": {
        "code": "string",
        "fund_id": "string",
        "id": "string",
        "title": "string"
      },
      "designation_note": "string",
      "donor_id": "string",
      "donor_paid_fee": 0,
      "email_opt_in": true,
      "embed": {
        "id": "string",
        "name": "string"
      },
      "expiration_month": 0,
      "expiration_year": 0,
      "external_tracking_id": "string",
      "final_date": "2020-06-30T13:37:51Z",
      "frequency": "string",
      "gift": {
        "created": "2020-06-30T13:37:51Z",
        "description": "string",
        "extra_placeholder": "string",
        "gift_value": 0,
        "id": "string",
        "image_url": "string",
        "is_disabled": true,
        "sku": "string",
        "updated": "2020-06-30T13:37:51Z"
      },
      "gift_extra": "string",
      "hide_name": true,
      "id": "string",
      "last_four_digits": "string",
      "net_proceeds": 0,
      "organization_id": "string",
      "payment_gateway_id": "string",
      "payment_gateway_name": "string",
      "payment_transaction_id": "string",
      "recurring_count": 0,
      "reference_code": "string",
      "sale_price": 0,
      "schedule_id": "string",
      "sms_keyword": "string",
      "status": "string",
      "subtype": "string",
      "transaction_set_id": "string",
      "tribute": {
        "definition": {
          "description": "string",
          "id": "string",
          "image_key": "string",
          "image_url": "string",
          "is_disabled": true,
          "recipient_address_required": true,
          "recipient_email_required": true
        },
        "from_name": "string",
        "honorees": [
          {
            "firstname": "string",
            "lastname": "string",
            "message": "string"
          }
        ],
        "include_amount": true,
        "recipient": {
          "address": {
            "city": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "state": "string",
            "street": "string",
            "street2": "string",
            "title": "string",
            "zip": "string"
          },
          "created": "2020-06-30T13:37:51Z",
          "email": "string",
          "firstname": "string",
          "lastname": "string",
          "middlename": "string",
          "phone": "string",
          "timezone": "string",
          "title": "string",
          "updated": "2020-06-30T13:37:51Z"
        },
        "send_card": true
      },
      "type": "string",
      "utm": {
        "campaign": "string",
        "content": "string",
        "medium": "string",
        "source": "string",
        "term": "string"
      },
      "vendor_id": 0
    }
  ],
  "more": true,
  "page": 0,
  "total_count": 0
}

Properties

Name Type Required Description
count integer false No description
items [Transaction] false No description
more boolean false No description
page integer false No description
total_count integer false No description

Tribute

{
  "definition": {
    "description": "string",
    "id": "string",
    "image_key": "string",
    "image_url": "string",
    "is_disabled": true,
    "recipient_address_required": true,
    "recipient_email_required": true
  },
  "from_name": "string",
  "honorees": [
    {
      "firstname": "string",
      "lastname": "string",
      "message": "string"
    }
  ],
  "include_amount": true,
  "recipient": {
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "country_name": "string",
      "state": "string",
      "street": "string",
      "street2": "string",
      "title": "string",
      "zip": "string"
    },
    "created": "2020-06-30T13:37:51Z",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "phone": "string",
    "timezone": "string",
    "title": "string",
    "updated": "2020-06-30T13:37:51Z"
  },
  "send_card": true
}

Properties

Name Type Required Description
definition TributeDefinition false No description
from_name string false No description
honorees [TransactionHonoree] false No description
include_amount boolean false No description
recipient Contact false No description
send_card boolean false No description

TributeDefinition

{
  "description": "string",
  "id": "string",
  "image_key": "string",
  "image_url": "string",
  "is_disabled": true,
  "recipient_address_required": true,
  "recipient_email_required": true
}

Properties

Name Type Required Description
description string false No description
id string false No description
image_key string false No description
image_url string false No description
is_disabled boolean false No description
recipient_address_required boolean false No description
recipient_email_required boolean false No description