Get All
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"
}
}
}
]
}
Transactions
Get All
Récupérez toutes les transactions CrowdChange dans une période donnée ou par identifiant de versement, avec attribution complète au donateur et campagne.
GET
/
v2
/
private
/
transactions
Get All
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
Retrieve transactions after this ID.
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).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).Payout account - can either be
global or user. Returns transactions that were paid out to specified account. Allowed values: global, userPayout 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.Comma separated list of fundraiser ids.
Page number. Default:
1Number of results to return. Default:
100Sort key. Allowed values:
id, date Default: idSort direction. Allowed values:
asc, desc Default: ascExclude subsite transactions. Default:
0Include pending transactions. Default:
0List of fundraiser tags.
Response
Start date.
End date.
Number of transactions returned.
List of transactions.
Afficher properties
Afficher properties
Transaction ID.
Transaction Type. Allowed values:
charge, refundTransaction Status. Allowed values:
completed, refunded, pendingList of transaction refund IDs of current transaction. Presented if transaction has refunds.
Parent Transaction ID. Presented if current transaction is refund transaction.
Site ID.
Promo Code.
Summary of collected funds for transaction.
Afficher properties
Afficher properties
Total amount paid for apparel / merchandise.
Amount that user paid to help cover transaction fees.
Currency code. Allowed values:
CAD, USD, AUD, EURDonation amount.
Donation amount to personal pages (multi-registration).
Total amount paid for ecards.
Is this a recurring transaction?
Total amount paid for registration.
Total amount paid for sponsorship.
Total amount paid for tickets.
Total net amount for transaction (after all fees).
Total amount paid by user.
Total amount paid for custom fees.
User’s billing information.
Afficher properties
Afficher properties
Business name.
Is this transaction made by foundation?
Honorific (i.e. Mr / Miss / etc).
Full user name including honorific.
User’s first name.
User’s last name.
Street name and number.
City name.
Country code.
State or province..
ZIP or Postal Code.
User’s email address.
Phone number.
Donor’s information.
Afficher properties
Afficher properties
Business name.
Honorific (i.e. Mr / Miss / etc).
Full user name including honorific.
User’s first name.
User’s last name.
Street name and number.
City name.
Country code.
State or province..
ZIP or Postal Code.
User’s email address.
Is this transaction made by foundation?
User’s ID.
Phone number.
User’s mailing information.
Afficher properties
Afficher properties
Business name.
Is this transaction made by foundation?
Honorific (i.e. Mr / Miss / etc).
Full user name including honorific.
User’s first name.
User’s last name.
Street name and number.
City name.
Country code.
State or province..
ZIP or Postal Code.
Phone number.
Debit or credit card type used for transaction.
Payment processor used for transaction.
Payment processor’s ID.
List of custom questions and responses.
Afficher properties
Afficher properties
Custom field id.
If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).
Custom field label.
User’s answer to custom field.
Custom ID.
Custom ID for the response (multiple choice questions).
Date of transaction in format
YYYY-MM-DD HH:MM:SS.Public comment left by user.
Campaign for which transaction was made.
Afficher properties
Afficher properties
Fundraiser ID.
Site ID.
Template ID.
Name of campaign.
Date and time when campaign starts.
Date and time when campaign ends.
Campaign location.
Fundraiser goal. This can be either dollars or number of participants.
Campus associated with campaign.
National Office associated with campaign.
Chapter associated with campaign.
Custom ID provided for chapter.
Organization associated with campaign.
Value of
In support of field associated with campaign.Code provided for
In support of field.Appeal code.
Campaign language. Allowed values:
en, frList of custom questions and responses.
Afficher properties
Afficher properties
Custom field id.
If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).
Custom field label.
User’s answer to custom field.
Custom ID.
Custom ID for the response (multiple choice questions).
Campaign tags.
Team through which transaction was made.
Afficher properties
Afficher properties
Team ID.
Site ID.
Fundraiser ID. When cross-fundraiser teams are enabled, this maybe different from transaction’s fundraiser id.
Team name.
Team goal.
Team url.
List of custom questions and responses.
Afficher properties
Afficher properties
Custom field id.
If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).
Custom field label.
User’s answer to custom field.
Custom ID.
Custom ID for the response (multiple choice questions).
Personal page through which transaction was made.
Afficher properties
Afficher properties
Personal page ID.
Site ID.
Personal page name.
First name of personal page’s owner.
Last name of personal page’s owner.
Full name of personal page’s owner.
Honorific of personal page’s owner (i.e. Mr / Miss / etc).
Personal page goal.
Personal page url.
Personal page language. Allowed values:
en, frList of custom questions and responses.
Afficher properties
Afficher properties
Custom field id.
If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).
Custom field label.
User’s answer to custom field.
Custom ID.
Custom ID for the response (multiple choice questions).
True if transaction was disputed, otherwise false.
True if transaction was refunded, otherwise false.
True if transaction is pending.
True if tax receipt was issued for this transaction.
Tax receipt information.
Afficher properties
Afficher properties
Unique id.
Total donation amount.
Benefit amount.
Eligible amount.
Business name.
Name on receipt.
Date when the tax receipt was issued.
Tax receipt number
Status of tax receipt. Allowed values:
valid, cancelledHonorific (i.e. Mr / Miss / etc).
First name.
Last name.
Street name and number.
City name.
Country code.
State or province..
ZIP or Postal Code.
Email address.
User’s ID.
Transaction’s ID.
Information about recurring donation.
Afficher properties
Afficher properties
Unique id.
Recurring amount to be charged.
Expected net amount.
Frequency. Allowed values:
month, yearDay of the month when the charge will be processed.
Month of the year when the charge will be processed (for annual donations).
Subscription status. Allowed values:
active, cancelled, pausedBreakdown of any items within the transaction, except donation.
Afficher properties
Afficher properties
List of purchased merchandise.
List of purchase registrations.
Afficher properties
Afficher properties
Total number of items in the transaction.
List of items.
Afficher properties
Afficher properties
Unique id assigned to item within transaction.
Item name.
Variation of the item.
Original price of the item.
Registrant’s first name.
Registrant’s last name.
Registrant’s alias name.
Registrant’s comment.
Is registrant’s donation hidden?
Personal page that was created during registration.
Afficher properties
Afficher properties
Personal page ID.
Personal page name.
Personal page goal.
Personal page url.
List of custom questions and responses.
Afficher properties
Afficher properties
Custom field id.
If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).
Custom field label.
User’s answer to custom field.
Custom ID.
Custom ID for the response (multiple choice questions).
Original unique id assigned to the previous registration.
List of purchased eCards.
Afficher properties
Afficher properties
Total number of items in the transaction.
List of items.
Afficher properties
Afficher properties
Unique id assigned to item within transaction.
Method used to send the eCard. Allowed values:
email, sms, mailDate when the eCard is to be sent out.
Message on the eCard.
True if user sent the card anonymously; otherwise, false.
Allowed values:
na, pending, sent, delivered, opened, errorList of tribute cards.
Afficher properties
Afficher properties
Total number of items in the transaction.
List of items.
Afficher properties
Afficher properties
Unique id assigned to item within transaction.
Method used to send the eCard. Allowed values:
email, sms, mailType of tribute card.
Name of honoree.
Message on the eCard.
Allowed values:
na, pending, sent, delivered, opened, errorBreakdown of any refunded items within the refund transaction. Presented if current transaction is refund transaction.
Afficher properties
Afficher properties
List of refunded registrations.
Afficher properties
Afficher properties
List of items.
Afficher properties
Afficher properties
Unique id assigned to item within transaction.
Item name.
Variation of the item.
Original price of the item.
Registrant’s first name.
Registrant’s last name.
Registrant’s alias name.
Registrant’s comment.
Is registrant’s donation hidden?
Personal page that was created during registration.
Afficher properties
Afficher properties
Personal page ID.
Personal page name.
Personal page goal.
Personal page url.
List of custom questions and responses.
Afficher properties
Afficher properties
Custom field id.
If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).
Custom field label.
User’s answer to custom field.
Custom ID.
Custom ID for the response (multiple choice questions).
List of refunded eCards.
Afficher properties
Afficher properties
List of items.
Afficher properties
Afficher properties
Unique id assigned to item within transaction.
Method used to send the eCard. Allowed values:
email, sms, mailDate when the eCard is to be sent out.
Message on the eCard.
True if user sent the card anonymously; otherwise, false.
Allowed values:
na, pending, sent, delivered, opened, errorList of refunded sponsorship.
Afficher properties
Afficher properties
List of items.
Afficher properties
Afficher properties
List of self donations associated with personal pages.
Afficher properties
Afficher properties
List of items.
Afficher properties
Afficher properties
Unique id assigned to item within transaction.
Refunded amount
Donor’s name
Personal page that was created during registration.
Afficher properties
Afficher properties
Personal page ID.
Site ID.
Personal page name.
First name of personal page’s owner.
Last name of personal page’s owner.
Personal page goal.
Personal page language. Allowed values:
en, frList of custom questions and responses.
Afficher properties
Afficher properties
Custom field id.
If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).
Custom field label.
User’s answer to custom field.
Custom ID.
Custom ID for the response (multiple choice questions).
List of purchased sponsorships.
Afficher properties
Afficher properties
Total number of purchased sponsorships in the transaction.
List of items.
Afficher properties
Afficher properties
Fulfillment transaction ID. Presented if transaction is a pledge transaction.
Is this transaction a pledge? Presented if transaction is a pledge transaction.
Pledge transaction ID. Presented if transaction is a fulfillment transaction.
Is this transaction a fulfillment? Presented if transaction is a fulfillment transaction.
Information about person who actually paid for the transaction. Property is presented if transaction has pledge or fulfillment transaction
Afficher properties
Afficher properties
User’s billing information.
Afficher properties
Afficher properties
Business name.
Is this transaction made by foundation?
Honorific (i.e. Mr / Miss / etc).
Full user name including honorific.
User’s first name.
User’s last name.
Street name and number.
City name.
Country code.
State or province..
ZIP or Postal Code.
User’s email address.
Phone number.
| 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"
}
}
}
]
}
Cette page vous a-t-elle été utile ?
⌘I