Get All

Get All

curl --request GET \
  --url https://api.crowdchange.dev/v2/private/transactions \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.crowdchange.dev/v2/private/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.crowdchange.dev/v2/private/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.crowdchange.dev/v2/private/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/private/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
    "dt_start": "2021-01-01T00:00:00",
    "dt_end": "2021-01-31T00:00:00",
    "count": 1,
    "data": [
{
    "id": 10001,
    "type": "charge",
    "status": "completed",
    "refund_children_ids": [
    10001,
    10002
    ],
    "parent_id": 10001,
    "partner_id": 10,
    "promo_code": "PROMO100",
    "amount": {
    "apparel": 29.95,
    "covered_fees": 5.15,
    "currency": "USD",
    "donation": 50,
    "donation_to_pages": 50,
    "ecards": 0,
    "is_recurring": false,
    "registration": 0,
    "sponsorship": 0,
    "tickets": 10,
    "total_net": 99.95,
    "total_paid": 105.15,
    "custom_fees": 15.95
},
    "billing": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "phone": "1-555-123-4567"
},
    "donated_by": {
    "business_name": "Company Inc",
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "is_foundation": false,
    "user_id": 1,
    "phone": "1-555-123-4567"
},
    "mailing_address": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "phone": "1-555-123-4567"
},
    "card_type": "Visa",
    "payment_processor": "Stripe",
    "processor_transaction_id": "ch_xxxxxxx",
    "ref_source": "newsletter",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "date": "2021-09-26 16:00:03",
    "donation_comment": "Happy to contribute to a worthy cause!",
    "fundraiser": {
    "id": 100,
    "partner_id": 10,
    "fundraiser_template_id": 1,
    "fundraiser_template": {
    "id": 1,
    "name": "Template"
},
    "name": "Donate Now!",
    "dt_start": "2021-01-01 08:00:00",
    "dt_end": "2021-01-01 16:00:00",
    "location": "100 Main Street, Toronto, ON",
    "goal": 100000,
    "campus": "University of Western Ontario",
    "national_office": "Sigma Delta Tau",
    "chapter": "Gamma Psi",
    "chapter_custom_id": "GPI-12345",
    "organization": "Company Inc.",
    "in_support_name": "Cancer Research",
    "in_support_code": "CR-123",
    "appeal_code": "GEN-123",
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "user": {
    "id": 1,
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Snow",
    "title": "Mr.",
    "name": "John Snow"
},
    "tags_list": [
    "tag1",
    "tag2"
    ]
},
    "fundraiser_team": {
    "id": 1001,
    "partner_id": 10,
    "fundraiser_id": 101,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "language": "en",
    "title": "Mr.",
    "name": "John Snow"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
},
    "fundraiser_user_page": {
    "id": 1001,
    "partner_id": 10,
    "name": "Team A",
    "first_name": "John",
    "last_name": "Snow",
    "user_name": "John Snow",
    "title": "Mr.",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
},
    "is_disputed": false,
    "is_refunded": false,
    "is_pending": false,
    "is_tax_receipt_issued": true,
    "tax_receipt": {
    "id": 1001,
    "amount_donation": 100.99,
    "amount_benefit": 10.49,
    "amount_eligible": 90.5,
    "business_name": "Company Inc",
    "name_on_receipt": "John Smith",
    "issued_on": "2021-01-01 19:00:00",
    "receipt_number": "TAX-0012345",
    "status": "valid",
    "title": "Mr.",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "user_id": 1,
    "transaction_id": 1
},
    "recurring": {
    "id": 1001,
    "amount": 100,
    "amount_net": 100,
    "interval": "month",
    "day": 1,
    "month": 6,
    "status": "active"
},
    "payout": {
    "account": "user",
    "date": "2021-01-01"
},
    "purchased_items": {
    "apparel": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "T-shirt",
    "option": "XL - Blue",
    "price": 29.95
}
    ]
},
    "registration": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Bike ride.",
    "option": "200 KM",
    "price": 350,
    "first_name": "John",
    "last_name": "Doe",
    "alias_name": "Family's Friend",
    "comment": "Comment",
    "is_amount_hidden": false,
    "fundraiser_page": {
    "id": 1001,
    "name": "John Smith",
    "goal": 10000,
    "self_donation": {
    "id": 1001,
    "name": "Joe Doe",
    "amount": 100
},
    "url": "https://my.crowdchange.co/abcd1234",
    "team": {
    "id": 1001,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "title": "Mr.",
    "name": "John Snow"
}
},
    "mailing_address": {
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "registrant_id": 10001
}
    ]
},
    "tickets": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "General admission",
    "option": "Section C",
    "price": 19.98
}
    ]
},
    "ecards": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "method": "email",
    "send_on": "2021-01-01",
    "message": "Happy New Year!",
    "is_anonymous": true,
    "delivery_status": "opened",
    "card": {
    "id": 10001,
    "name": "Happy New Year - 1",
    "price": 1.99
},
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "tribute_cards": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "method": "email",
    "type": "In honor of",
    "honoree": "John Snow",
    "message": "Happy New Year!",
    "delivery_status": "opened",
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "custom_fees": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Custom fee",
    "amount": 15.95
}
    ]
}
},
    "refunded_items": {
    "donations": {
    "items": [
{
    "id": 10001,
    "amount": 29.95
}
    ]
},
    "covered_fees": {
    "items": [
{
    "id": 10001,
    "amount": 29.95
}
    ]
},
    "apparel": {
    "items": [
{
    "id": 10001,
    "name": "T-shirt",
    "option": "XL - Blue",
    "price": 29.95
}
    ]
},
    "registration": {
    "items": [
{
    "id": 10001,
    "name": "Bike ride.",
    "option": "200 KM",
    "price": 350,
    "first_name": "John",
    "last_name": "Doe",
    "alias_name": "Family's Friend",
    "comment": "Comment",
    "is_amount_hidden": false,
    "fundraiser_page": {
    "id": 1001,
    "name": "John Smith",
    "goal": 10000,
    "self_donation": {
    "id": 1001,
    "name": "Joe Doe",
    "amount": 100
},
    "url": "https://my.crowdchange.co/abcd1234",
    "team": {
    "id": 1001,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "title": "Mr.",
    "name": "John Snow"
}
},
    "mailing_address": {
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
}
    ]
},
    "tickets": {
    "items": [
{
    "id": 10001,
    "name": "General admission",
    "option": "Section C",
    "price": 19.98
}
    ]
},
    "ecards": {
    "items": [
{
    "id": 10001,
    "method": "email",
    "send_on": "2021-01-01",
    "message": "Happy New Year!",
    "is_anonymous": true,
    "delivery_status": "opened",
    "card": {
    "id": 10001,
    "name": "Happy New Year - 1",
    "price": 1.99
},
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "sponsorship": {
    "items": [
{
    "id": 10001,
    "option_id": 100,
    "source_id": 100,
    "name": "Platinum Package",
    "price": 1000
}
    ]
},
    "custom_fees": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Custom fee",
    "amount": 15.95
}
    ]
},
    "self_donations": {
    "items": [
{
    "id": 10001,
    "amount": 29.95,
    "name": "Joe Doe",
    "fundraiser_page": {
    "id": 1001,
    "partner_id": 10,
    "name": "Team A",
    "first_name": "John",
    "last_name": "Snow",
    "goal": 10000,
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
}
}
    ]
}
},
    "sponsorship": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "option_id": 100,
    "source_id": 100,
    "name": "Platinum Package",
    "price": 1000
}
    ]
},
    "fulfillment_transaction_id": 1,
    "is_pledge_transaction": true,
    "pledge_transaction_id": 1,
    "is_fulfillment_transaction": true,
    "payee": {
    "billing": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "phone": "1-555-123-4567"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "language": "en",
    "title": "Mr.",
    "name": "John Snow"
}
}
}
    ]
}

GET

private

transactions

Get All

curl --request GET \
  --url https://api.crowdchange.dev/v2/private/transactions \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.crowdchange.dev/v2/private/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.crowdchange.dev/v2/private/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.crowdchange.dev/v2/private/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/private/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
    "dt_start": "2021-01-01T00:00:00",
    "dt_end": "2021-01-31T00:00:00",
    "count": 1,
    "data": [
{
    "id": 10001,
    "type": "charge",
    "status": "completed",
    "refund_children_ids": [
    10001,
    10002
    ],
    "parent_id": 10001,
    "partner_id": 10,
    "promo_code": "PROMO100",
    "amount": {
    "apparel": 29.95,
    "covered_fees": 5.15,
    "currency": "USD",
    "donation": 50,
    "donation_to_pages": 50,
    "ecards": 0,
    "is_recurring": false,
    "registration": 0,
    "sponsorship": 0,
    "tickets": 10,
    "total_net": 99.95,
    "total_paid": 105.15,
    "custom_fees": 15.95
},
    "billing": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "phone": "1-555-123-4567"
},
    "donated_by": {
    "business_name": "Company Inc",
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "is_foundation": false,
    "user_id": 1,
    "phone": "1-555-123-4567"
},
    "mailing_address": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "phone": "1-555-123-4567"
},
    "card_type": "Visa",
    "payment_processor": "Stripe",
    "processor_transaction_id": "ch_xxxxxxx",
    "ref_source": "newsletter",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "date": "2021-09-26 16:00:03",
    "donation_comment": "Happy to contribute to a worthy cause!",
    "fundraiser": {
    "id": 100,
    "partner_id": 10,
    "fundraiser_template_id": 1,
    "fundraiser_template": {
    "id": 1,
    "name": "Template"
},
    "name": "Donate Now!",
    "dt_start": "2021-01-01 08:00:00",
    "dt_end": "2021-01-01 16:00:00",
    "location": "100 Main Street, Toronto, ON",
    "goal": 100000,
    "campus": "University of Western Ontario",
    "national_office": "Sigma Delta Tau",
    "chapter": "Gamma Psi",
    "chapter_custom_id": "GPI-12345",
    "organization": "Company Inc.",
    "in_support_name": "Cancer Research",
    "in_support_code": "CR-123",
    "appeal_code": "GEN-123",
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "user": {
    "id": 1,
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Snow",
    "title": "Mr.",
    "name": "John Snow"
},
    "tags_list": [
    "tag1",
    "tag2"
    ]
},
    "fundraiser_team": {
    "id": 1001,
    "partner_id": 10,
    "fundraiser_id": 101,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "language": "en",
    "title": "Mr.",
    "name": "John Snow"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
},
    "fundraiser_user_page": {
    "id": 1001,
    "partner_id": 10,
    "name": "Team A",
    "first_name": "John",
    "last_name": "Snow",
    "user_name": "John Snow",
    "title": "Mr.",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
},
    "is_disputed": false,
    "is_refunded": false,
    "is_pending": false,
    "is_tax_receipt_issued": true,
    "tax_receipt": {
    "id": 1001,
    "amount_donation": 100.99,
    "amount_benefit": 10.49,
    "amount_eligible": 90.5,
    "business_name": "Company Inc",
    "name_on_receipt": "John Smith",
    "issued_on": "2021-01-01 19:00:00",
    "receipt_number": "TAX-0012345",
    "status": "valid",
    "title": "Mr.",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "user_id": 1,
    "transaction_id": 1
},
    "recurring": {
    "id": 1001,
    "amount": 100,
    "amount_net": 100,
    "interval": "month",
    "day": 1,
    "month": 6,
    "status": "active"
},
    "payout": {
    "account": "user",
    "date": "2021-01-01"
},
    "purchased_items": {
    "apparel": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "T-shirt",
    "option": "XL - Blue",
    "price": 29.95
}
    ]
},
    "registration": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Bike ride.",
    "option": "200 KM",
    "price": 350,
    "first_name": "John",
    "last_name": "Doe",
    "alias_name": "Family's Friend",
    "comment": "Comment",
    "is_amount_hidden": false,
    "fundraiser_page": {
    "id": 1001,
    "name": "John Smith",
    "goal": 10000,
    "self_donation": {
    "id": 1001,
    "name": "Joe Doe",
    "amount": 100
},
    "url": "https://my.crowdchange.co/abcd1234",
    "team": {
    "id": 1001,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "title": "Mr.",
    "name": "John Snow"
}
},
    "mailing_address": {
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "registrant_id": 10001
}
    ]
},
    "tickets": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "General admission",
    "option": "Section C",
    "price": 19.98
}
    ]
},
    "ecards": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "method": "email",
    "send_on": "2021-01-01",
    "message": "Happy New Year!",
    "is_anonymous": true,
    "delivery_status": "opened",
    "card": {
    "id": 10001,
    "name": "Happy New Year - 1",
    "price": 1.99
},
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "tribute_cards": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "method": "email",
    "type": "In honor of",
    "honoree": "John Snow",
    "message": "Happy New Year!",
    "delivery_status": "opened",
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "custom_fees": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Custom fee",
    "amount": 15.95
}
    ]
}
},
    "refunded_items": {
    "donations": {
    "items": [
{
    "id": 10001,
    "amount": 29.95
}
    ]
},
    "covered_fees": {
    "items": [
{
    "id": 10001,
    "amount": 29.95
}
    ]
},
    "apparel": {
    "items": [
{
    "id": 10001,
    "name": "T-shirt",
    "option": "XL - Blue",
    "price": 29.95
}
    ]
},
    "registration": {
    "items": [
{
    "id": 10001,
    "name": "Bike ride.",
    "option": "200 KM",
    "price": 350,
    "first_name": "John",
    "last_name": "Doe",
    "alias_name": "Family's Friend",
    "comment": "Comment",
    "is_amount_hidden": false,
    "fundraiser_page": {
    "id": 1001,
    "name": "John Smith",
    "goal": 10000,
    "self_donation": {
    "id": 1001,
    "name": "Joe Doe",
    "amount": 100
},
    "url": "https://my.crowdchange.co/abcd1234",
    "team": {
    "id": 1001,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "title": "Mr.",
    "name": "John Snow"
}
},
    "mailing_address": {
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
}
    ]
},
    "tickets": {
    "items": [
{
    "id": 10001,
    "name": "General admission",
    "option": "Section C",
    "price": 19.98
}
    ]
},
    "ecards": {
    "items": [
{
    "id": 10001,
    "method": "email",
    "send_on": "2021-01-01",
    "message": "Happy New Year!",
    "is_anonymous": true,
    "delivery_status": "opened",
    "card": {
    "id": 10001,
    "name": "Happy New Year - 1",
    "price": 1.99
},
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "sponsorship": {
    "items": [
{
    "id": 10001,
    "option_id": 100,
    "source_id": 100,
    "name": "Platinum Package",
    "price": 1000
}
    ]
},
    "custom_fees": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Custom fee",
    "amount": 15.95
}
    ]
},
    "self_donations": {
    "items": [
{
    "id": 10001,
    "amount": 29.95,
    "name": "Joe Doe",
    "fundraiser_page": {
    "id": 1001,
    "partner_id": 10,
    "name": "Team A",
    "first_name": "John",
    "last_name": "Snow",
    "goal": 10000,
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
}
}
    ]
}
},
    "sponsorship": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "option_id": 100,
    "source_id": 100,
    "name": "Platinum Package",
    "price": 1000
}
    ]
},
    "fulfillment_transaction_id": 1,
    "is_pledge_transaction": true,
    "pledge_transaction_id": 1,
    "is_fulfillment_transaction": true,
    "payee": {
    "billing": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "phone": "1-555-123-4567"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "language": "en",
    "title": "Mr.",
    "name": "John Snow"
}
}
}
    ]
}

Query parameters

integer

Retrieve transactions after this ID.

string

End date in the ISO 8601 format yyyy-mm-ddThh:mm:ss (UTC timezone). Retrieves transactions that were made on or after of provided date (UTC).

string

End date in the ISO 8601 format yyyy-mm-ddThh:mm:ss (UTC timezone). Retrieves transactions that were made on or before of provided date (UTC).

string

Payout account - can either be global or user. Returns transactions that were paid out to specified account. Allowed values: global, user

string

Payout date in the format YYYY-MM-DD. Retrieves transactions that were paid out on provided date. When provided, start and end dates have no effect.

string

Comma separated list of fundraiser ids.

integer

Page number. Default: 1

integer

Number of results to return. Default: 100

string

default:"id"

Sort key. Allowed values: id, date Default: id

string

default:"asc"

Sort direction. Allowed values: asc, desc Default: asc

integer

Exclude subsite transactions. Default: 0

integer

Include pending transactions. Default: 0

string[]

List of fundraiser tags.

Response

string

Start date.

string

End date.

integer

Number of transactions returned.

object[]

List of transactions.

Show properties

integer

Transaction ID.

string

Transaction Type. Allowed values: charge, refund

string

Transaction Status. Allowed values: completed, refunded, pending

any[]

List of transaction refund IDs of current transaction. Presented if transaction has refunds.

integer

Parent Transaction ID. Presented if current transaction is refund transaction.

integer

Site ID.

Promo Code.

object

Summary of collected funds for transaction.

Show properties

number

Total amount paid for apparel / merchandise.

number

Amount that user paid to help cover transaction fees.

string

Currency code. Allowed values: CAD, USD, AUD, EUR

number

Donation amount.

number

Donation amount to personal pages (multi-registration).

number

Total amount paid for ecards.

boolean

Is this a recurring transaction?

number

Total amount paid for registration.

number

Total amount paid for sponsorship.

number

Total amount paid for tickets.

number

Total net amount for transaction (after all fees).

number

Total amount paid by user.

number

Total amount paid for custom fees.

object

User’s billing information.

Show properties

string

Business name.

boolean

Is this transaction made by foundation?

string

Honorific (i.e. Mr / Miss / etc).

string

Full user name including honorific.

string

User’s first name.

string

User’s last name.

string

Street name and number.

string

City name.

string

Country code.

string

State or province..

string

ZIP or Postal Code.

string

User’s email address.

string

Phone number.

object

Donor’s information.

Show properties

string

Business name.

string

Honorific (i.e. Mr / Miss / etc).

string

Full user name including honorific.

string

User’s first name.

string

User’s last name.

string

Street name and number.

string

City name.

string

Country code.

string

State or province..

string

ZIP or Postal Code.

string

User’s email address.

boolean

Is this transaction made by foundation?

integer

User’s ID.

string

Phone number.

object

User’s mailing information.

Show properties

string

Business name.

boolean

Is this transaction made by foundation?

string

Honorific (i.e. Mr / Miss / etc).

string

Full user name including honorific.

string

User’s first name.

string

User’s last name.

string

Street name and number.

string

City name.

string

Country code.

string

State or province..

string

ZIP or Postal Code.

string

Phone number.

string

Debit or credit card type used for transaction.

string

Payment processor used for transaction.

string

Payment processor’s ID.

string | null

Reference source associated with the transaction, when one was provided.

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

string

Date of transaction in format YYYY-MM-DD HH:MM:SS.

string

Public comment left by user.

object

Campaign for which transaction was made.

Show properties

integer

Fundraiser ID.

integer

Site ID.

integer

Template ID.

object

Template associated with the campaign.

Show properties

integer

Template ID.

string

Template name.

string

Name of campaign.

string

Date and time when campaign starts.

string

Date and time when campaign ends.

string | null

Campaign location type. Allowed values: venue, online, other.

string | null

Display location. Uses the legacy event address when no display value exists.

string | null

Location instructions or free-form text stored on the campaign.

object | null

Structured location data. For venue, contains address and/or geo; for online, contains link; otherwise null. Missing nested fields are omitted.

number

Fundraiser goal. This can be either dollars or number of participants.

string

Campus associated with campaign.

string

National Office associated with campaign.

string

Chapter associated with campaign.

string

Custom ID provided for chapter.

string

Organization associated with campaign.

string

Value of In support of field associated with campaign.

string

Code provided for In support of field.

string

Appeal code.

string

Campaign language. Allowed values: en, fr

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

object

Show properties

integer

Fundraiser owner’s ID

string

Fundraiser owner’s email

string

Fundraiser owner’s first name

string

Fundraiser owner’s last name

string

Fundraiser owner’s title

string

Fundraiser owner’s name

any[]

Campaign tags.

object

Team through which transaction was made.

Show properties

integer

Team ID.

integer

Site ID.

integer

Fundraiser ID. When cross-fundraiser teams are enabled, this maybe different from transaction’s fundraiser id.

string

Team name.

number

Team goal.

string

Team url.

object

User that created the team (team captain).

Show properties

integer

User ID.

string

User’s first name.

string

User’s last name.

string

User’s email address.

string

User’s preferred language. Allowed values: en, fr

string

User’s title

string

User’s name

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

object

Personal page through which transaction was made.

Show properties

integer

Personal page ID.

integer

Site ID.

string

Personal page name.

string

First name of personal page’s owner.

string

Last name of personal page’s owner.

string

Full name of personal page’s owner.

string

Honorific of personal page’s owner (i.e. Mr / Miss / etc).

number

Personal page goal.

string

Personal page url.

string

Personal page language. Allowed values: en, fr

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

boolean

True if transaction was disputed, otherwise false.

boolean

True if transaction was refunded, otherwise false.

boolean

True if transaction is pending.

boolean

True if tax receipt was issued for this transaction.

object

Tax receipt information.

Show properties

integer

Unique id.

number

Total donation amount.

number

Benefit amount.

number

Eligible amount.

string

Business name.

string

Name on receipt.

string

Date when the tax receipt was issued.

string

Tax receipt number

string

Status of tax receipt. Allowed values: valid, cancelled

string

Honorific (i.e. Mr / Miss / etc).

string

First name.

string

Last name.

string

Street name and number.

string

City name.

string

Country code.

string

State or province..

string

ZIP or Postal Code.

string

Email address.

integer

User’s ID.

integer

Transaction’s ID.

object

Information about recurring donation.

Show properties

integer

Unique id.

integer

Recurring amount to be charged.

integer

Expected net amount.

string

Frequency. Allowed values: month, year

integer

Day of the month when the charge will be processed.

integer

Month of the year when the charge will be processed (for annual donations).

string

Subscription status. Allowed values: active, cancelled, paused

object

Payout information. Only available for specific payment processors.

Show properties

string

Destination account of the payout - either global or user. Allowed values: user, global

string

Date when the payout was made.

object

Breakdown of any items within the transaction, except donation.

Show properties

object

List of purchased merchandise.

Show properties

integer

Total number of items in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Variation of the item.

number

Original price of the item.

string

Custom ID or code (i.e. SKU).

object

List of purchase registrations.

Show properties

integer

Total number of items in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Variation of the item.

number

Original price of the item.

string

Custom ID or code (i.e. SKU).

string

Registrant’s first name.

string

Registrant’s last name.

string

Registrant’s alias name.

string

Registrant’s comment.

boolean

Is registrant’s donation hidden?

object

Personal page that was created during registration.

Show properties

integer

Personal page ID.

string

Personal page name.

number

Personal page goal.

object

Self donation that was made to the page during registration.

Show properties

integer

Self donation reference id.

string

Donor’s name

number

Amount that was donated.

string

Personal page url.

object

Team that was created or joined.

Show properties

integer

Team ID.

string

Team name

number

Team goal.

string

Team url.

string

Team language. Allowed values: en, fr

object

User that created the team (team captain).

Show properties

integer

User ID.

string

User’s first name.

string

User’s last name.

string

User’s email address.

string

User’s title

string

User’s name

object

Registrant’s mailing information.

Show properties

string

Street name and number.

string

City name.

string

Country code.

string

State or province..

string

ZIP or Postal Code.

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

integer

Original unique id assigned to the previous registration.

object

List of purchased tickets.

Show properties

integer

Total number of items in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Variation of the item.

number

Original price of the item.

string

Custom ID or code (i.e. SKU).

object

List of purchased eCards.

Show properties

integer

Total number of items in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Method used to send the eCard. Allowed values: email, sms, mail

string

Date when the eCard is to be sent out.

string

Message on the eCard.

boolean

True if user sent the card anonymously; otherwise, false.

string

Allowed values: na, pending, sent, delivered, opened, error

object

The eCard that was sent.

Show properties

integer

ID of the eCard.

string

Name of the eCard.

number

Price of the eCard.

object

Recipient of the card.

Show properties

string

Name of the recipient.

string

Email (if the card was sent by email).

string

Phone number (if the card was sent by sms).

string

Mailing address (if the card was sent by mail).

object

List of tribute cards.

Show properties

integer

Total number of items in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Method used to send the eCard. Allowed values: email, sms, mail

string

Type of tribute card.

string

Name of honoree.

string

Message on the eCard.

string

Allowed values: na, pending, sent, delivered, opened, error

object

Recipient of the card.

Show properties

string

Name of the recipient.

string

Email (if the card was sent by email).

string

Phone number (if the card was sent by sms).

string

Mailing address (if the card was sent by mail).

object

List of custom fees.

Show properties

integer

Total number of items in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Custom fee amount.

object

Breakdown of any refunded items within the refund transaction. Presented if current transaction is refund transaction.

Show properties

object

List of refunded donations.

Show properties

object[]

List of items.

Show properties

integer

ID of the initial transaction.

number

Refunded amount

object

List of covered fees.

Show properties

object[]

List of items.

Show properties

integer

ID of the initial transaction.

number

Refunded amount

object

List of refunded merchandise.

Show properties

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Variation of the item.

number

Original price of the item.

string

Custom ID or code (i.e. SKU).

object

List of refunded registrations.

Show properties

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Variation of the item.

number

Original price of the item.

string

Custom ID or code (i.e. SKU).

string

Registrant’s first name.

string

Registrant’s last name.

string

Registrant’s alias name.

string

Registrant’s comment.

boolean

Is registrant’s donation hidden?

object

Personal page that was created during registration.

Show properties

integer

Personal page ID.

string

Personal page name.

number

Personal page goal.

object

Self donation that was made to the page during registration.

Show properties

integer

Self donation reference id.

string

Donor’s name

number

Amount that was donated.

string

Personal page url.

object

Team that was created or joined.

Show properties

integer

Team ID.

string

Team name

number

Team goal.

string

Team url.

string

Team language. Allowed values: en, fr

object

User that created the team (team captain).

Show properties

integer

User ID.

string

User’s first name.

string

User’s last name.

string

User’s email address.

string

User’s title

string

User’s name

object

Registrant’s mailing information.

Show properties

string

Street name and number.

string

City name.

string

Country code.

string

State or province..

string

ZIP or Postal Code.

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

object

List of refunded tickets.

Show properties

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Variation of the item.

number

Original price of the item.

string

Custom ID or code (i.e. SKU).

object

List of refunded eCards.

Show properties

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Method used to send the eCard. Allowed values: email, sms, mail

string

Date when the eCard is to be sent out.

string

Message on the eCard.

boolean

True if user sent the card anonymously; otherwise, false.

string

Allowed values: na, pending, sent, delivered, opened, error

object

The eCard that was sent.

Show properties

integer

ID of the eCard.

string

Name of the eCard.

number

Price of the eCard.

object

Recipient of the card.

Show properties

string

Name of the recipient.

string

Email (if the card was sent by email).

string

Phone number (if the card was sent by sms).

string

Mailing address (if the card was sent by mail).

object

List of refunded sponsorship.

Show properties

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

integer

Sponsorship tier id.

integer

If the option was copied from Blueprint, this will reference the source option id from blueprint (similar to group id).

string

Sponsorship tier name.

number

Sponsorship tier price.

object

List of custom fees.

Show properties

integer

Total number of items in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

string

Item name.

string

Custom fee amount.

object

List of self donations associated with personal pages.

Show properties

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

number

Refunded amount

string

Donor’s name

object

Personal page that was created during registration.

Show properties

integer

Personal page ID.

integer

Site ID.

string

Personal page name.

string

First name of personal page’s owner.

string

Last name of personal page’s owner.

number

Personal page goal.

string

Personal page language. Allowed values: en, fr

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

object

List of purchased sponsorships.

Show properties

integer

Total number of purchased sponsorships in the transaction.

object[]

List of items.

Show properties

integer

Unique id assigned to item within transaction.

integer

Sponsorship tier id.

integer

If the option was copied from Blueprint, this will reference the source option id from blueprint (similar to group id).

string

Sponsorship tier name.

number

Sponsorship tier price.

integer

Fulfillment transaction ID. Presented if transaction is a pledge transaction.

boolean

Is this transaction a pledge? Presented if transaction is a pledge transaction.

integer

Pledge transaction ID. Presented if transaction is a fulfillment transaction.

boolean

Is this transaction a fulfillment? Presented if transaction is a fulfillment transaction.

object

Information about person who actually paid for the transaction. Property is presented if transaction has pledge or fulfillment transaction

Show properties

object

User’s billing information.

Show properties

string

Business name.

boolean

Is this transaction made by foundation?

string

Honorific (i.e. Mr / Miss / etc).

string

Full user name including honorific.

string

User’s first name.

string

User’s last name.

string

Street name and number.

string

City name.

string

Country code.

string

State or province..

string

ZIP or Postal Code.

string

User’s email address.

string

Phone number.

object

User who actually paid for the transaction.

Show properties

integer

User ID.

string

User’s first name.

string

User’s last name.

string

User’s email address.

string

User’s preferred language. Allowed values: en, fr

string

User’s title

string

User’s name

Other responses

Status	Description
`400`	Bad Request
`403`	Forbidden

{
    "dt_start": "2021-01-01T00:00:00",
    "dt_end": "2021-01-31T00:00:00",
    "count": 1,
    "data": [
{
    "id": 10001,
    "type": "charge",
    "status": "completed",
    "refund_children_ids": [
    10001,
    10002
    ],
    "parent_id": 10001,
    "partner_id": 10,
    "promo_code": "PROMO100",
    "amount": {
    "apparel": 29.95,
    "covered_fees": 5.15,
    "currency": "USD",
    "donation": 50,
    "donation_to_pages": 50,
    "ecards": 0,
    "is_recurring": false,
    "registration": 0,
    "sponsorship": 0,
    "tickets": 10,
    "total_net": 99.95,
    "total_paid": 105.15,
    "custom_fees": 15.95
},
    "billing": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "phone": "1-555-123-4567"
},
    "donated_by": {
    "business_name": "Company Inc",
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "is_foundation": false,
    "user_id": 1,
    "phone": "1-555-123-4567"
},
    "mailing_address": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "phone": "1-555-123-4567"
},
    "card_type": "Visa",
    "payment_processor": "Stripe",
    "processor_transaction_id": "ch_xxxxxxx",
    "ref_source": "newsletter",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "date": "2021-09-26 16:00:03",
    "donation_comment": "Happy to contribute to a worthy cause!",
    "fundraiser": {
    "id": 100,
    "partner_id": 10,
    "fundraiser_template_id": 1,
    "fundraiser_template": {
    "id": 1,
    "name": "Template"
},
    "name": "Donate Now!",
    "dt_start": "2021-01-01 08:00:00",
    "dt_end": "2021-01-01 16:00:00",
    "location": "100 Main Street, Toronto, ON",
    "goal": 100000,
    "campus": "University of Western Ontario",
    "national_office": "Sigma Delta Tau",
    "chapter": "Gamma Psi",
    "chapter_custom_id": "GPI-12345",
    "organization": "Company Inc.",
    "in_support_name": "Cancer Research",
    "in_support_code": "CR-123",
    "appeal_code": "GEN-123",
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "user": {
    "id": 1,
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Snow",
    "title": "Mr.",
    "name": "John Snow"
},
    "tags_list": [
    "tag1",
    "tag2"
    ]
},
    "fundraiser_team": {
    "id": 1001,
    "partner_id": 10,
    "fundraiser_id": 101,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "language": "en",
    "title": "Mr.",
    "name": "John Snow"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
},
    "fundraiser_user_page": {
    "id": 1001,
    "partner_id": 10,
    "name": "Team A",
    "first_name": "John",
    "last_name": "Snow",
    "user_name": "John Snow",
    "title": "Mr.",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
},
    "is_disputed": false,
    "is_refunded": false,
    "is_pending": false,
    "is_tax_receipt_issued": true,
    "tax_receipt": {
    "id": 1001,
    "amount_donation": 100.99,
    "amount_benefit": 10.49,
    "amount_eligible": 90.5,
    "business_name": "Company Inc",
    "name_on_receipt": "John Smith",
    "issued_on": "2021-01-01 19:00:00",
    "receipt_number": "TAX-0012345",
    "status": "valid",
    "title": "Mr.",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "user_id": 1,
    "transaction_id": 1
},
    "recurring": {
    "id": 1001,
    "amount": 100,
    "amount_net": 100,
    "interval": "month",
    "day": 1,
    "month": 6,
    "status": "active"
},
    "payout": {
    "account": "user",
    "date": "2021-01-01"
},
    "purchased_items": {
    "apparel": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "T-shirt",
    "option": "XL - Blue",
    "price": 29.95
}
    ]
},
    "registration": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Bike ride.",
    "option": "200 KM",
    "price": 350,
    "first_name": "John",
    "last_name": "Doe",
    "alias_name": "Family's Friend",
    "comment": "Comment",
    "is_amount_hidden": false,
    "fundraiser_page": {
    "id": 1001,
    "name": "John Smith",
    "goal": 10000,
    "self_donation": {
    "id": 1001,
    "name": "Joe Doe",
    "amount": 100
},
    "url": "https://my.crowdchange.co/abcd1234",
    "team": {
    "id": 1001,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "title": "Mr.",
    "name": "John Snow"
}
},
    "mailing_address": {
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ],
    "registrant_id": 10001
}
    ]
},
    "tickets": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "General admission",
    "option": "Section C",
    "price": 19.98
}
    ]
},
    "ecards": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "method": "email",
    "send_on": "2021-01-01",
    "message": "Happy New Year!",
    "is_anonymous": true,
    "delivery_status": "opened",
    "card": {
    "id": 10001,
    "name": "Happy New Year - 1",
    "price": 1.99
},
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "tribute_cards": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "method": "email",
    "type": "In honor of",
    "honoree": "John Snow",
    "message": "Happy New Year!",
    "delivery_status": "opened",
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "custom_fees": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Custom fee",
    "amount": 15.95
}
    ]
}
},
    "refunded_items": {
    "donations": {
    "items": [
{
    "id": 10001,
    "amount": 29.95
}
    ]
},
    "covered_fees": {
    "items": [
{
    "id": 10001,
    "amount": 29.95
}
    ]
},
    "apparel": {
    "items": [
{
    "id": 10001,
    "name": "T-shirt",
    "option": "XL - Blue",
    "price": 29.95
}
    ]
},
    "registration": {
    "items": [
{
    "id": 10001,
    "name": "Bike ride.",
    "option": "200 KM",
    "price": 350,
    "first_name": "John",
    "last_name": "Doe",
    "alias_name": "Family's Friend",
    "comment": "Comment",
    "is_amount_hidden": false,
    "fundraiser_page": {
    "id": 1001,
    "name": "John Smith",
    "goal": 10000,
    "self_donation": {
    "id": 1001,
    "name": "Joe Doe",
    "amount": 100
},
    "url": "https://my.crowdchange.co/abcd1234",
    "team": {
    "id": 1001,
    "name": "Team A",
    "goal": 10000,
    "url": "https://my.crowdchange.co/abcd1234",
    "language": "en"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "title": "Mr.",
    "name": "John Snow"
}
},
    "mailing_address": {
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1"
},
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
}
    ]
},
    "tickets": {
    "items": [
{
    "id": 10001,
    "name": "General admission",
    "option": "Section C",
    "price": 19.98
}
    ]
},
    "ecards": {
    "items": [
{
    "id": 10001,
    "method": "email",
    "send_on": "2021-01-01",
    "message": "Happy New Year!",
    "is_anonymous": true,
    "delivery_status": "opened",
    "card": {
    "id": 10001,
    "name": "Happy New Year - 1",
    "price": 1.99
},
    "recipient": {
    "name": "John Snow",
    "email": "john@example.com",
    "phone": "1-555-123-4567",
    "address": "100 Main Str, Toronto, ON"
}
}
    ]
},
    "sponsorship": {
    "items": [
{
    "id": 10001,
    "option_id": 100,
    "source_id": 100,
    "name": "Platinum Package",
    "price": 1000
}
    ]
},
    "custom_fees": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "name": "Custom fee",
    "amount": 15.95
}
    ]
},
    "self_donations": {
    "items": [
{
    "id": 10001,
    "amount": 29.95,
    "name": "Joe Doe",
    "fundraiser_page": {
    "id": 1001,
    "partner_id": 10,
    "name": "Team A",
    "first_name": "John",
    "last_name": "Snow",
    "goal": 10000,
    "language": "en",
    "custom_data": [
{
    "field_id": 1001,
    "source_id": 11,
    "name": "Phone Number",
    "content": "555-123-4567",
    "field_custom_id": "ABC-123",
    "response_custom_id": "ABC-123"
}
    ]
}
}
    ]
}
},
    "sponsorship": {
    "count": 0,
    "items": [
{
    "id": 10001,
    "option_id": 100,
    "source_id": 100,
    "name": "Platinum Package",
    "price": 1000
}
    ]
},
    "fulfillment_transaction_id": 1,
    "is_pledge_transaction": true,
    "pledge_transaction_id": 1,
    "is_fulfillment_transaction": true,
    "payee": {
    "billing": {
    "business_name": "Company Inc",
    "is_foundation": false,
    "title": "Mr.",
    "name": "Mr. John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "street_address": "100 Main Street",
    "city": "Toronto",
    "country": "CA",
    "state": "ON",
    "postal": "A1A 1A1",
    "email": "john@example.com",
    "phone": "1-555-123-4567"
},
    "user": {
    "id": 1001,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "language": "en",
    "title": "Mr.",
    "name": "John Snow"
}
}
}
    ]
}

Last modified on October 11, 2026

Introduction

Server Side APIs

Client Side APIs

Query parameters

Response

​Query parameters

​Response

Query parameters

Response