curl --request GET \
--url https://api.crowdchange.dev/v2/private/transactions \
--header 'Authorization: <api-key>'{
"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",
"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 All
Retrieve all CrowdChange transactions within a time window or by payout ID, with full payment processor, donor, and campaign attribution details.
curl --request GET \
--url https://api.crowdchange.dev/v2/private/transactions \
--header 'Authorization: <api-key>'{
"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",
"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
yyyy-mm-ddThh:mm:ss (UTC timezone). Retrieves transactions that were made on or
after of provided date (UTC).yyyy-mm-ddThh:mm:ss (UTC timezone). Retrieves transactions that were made on or
before of provided date (UTC).global or user. Returns transactions that were paid out to specified account.
Allowed values: global, userYYYY-MM-DD. Retrieves transactions that were paid out on provided date. When provided,
start and end dates have no effect.1100id, date
Default: idasc, desc Default: asc00Response
Show properties
Show properties
charge, refundcompleted, refunded, pendingShow properties
Show properties
CAD, USD, AUD, EURShow properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
YYYY-MM-DD HH:MM:SS.Show properties
Show properties
In support of field associated with campaign.In support of field.en, frShow properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
en, frShow properties
Show properties
Show properties
Show properties
valid, cancelledShow properties
Show properties
month, yearactive, cancelled, pausedShow properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
email, sms, mailna, pending, sent, delivered, opened, errorShow properties
Show properties
Show properties
Show properties
email, sms, mailna, pending, sent, delivered, opened, errorShow properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
email, sms, mailna, pending, sent, delivered, opened, errorShow properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
en, frShow properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
Show properties
| 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",
"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"
}
}
}
]
}
Was this page helpful?