Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Transaction

listCampaignTransactions

List Campaign Transactions

get/campaigns/{campaign}/transactions

Path parameters

campaigninteger required
Example:227362

ID of Campaign

Query parameters

pageinteger
Example:1

Indicator of which page of results to return

per_pageinteger
Example:20

Number of entries to return in each page of results

withstring[]

Request specific relationships to be returned with the Transaction

[
  "items"
]
fields'acknowledgements_count' | 'adjustment_amount' | 'applied_application_fee_percent' | 'applied_processor_fee_percent' | 'applied_raw_processor_fee_flat' | 'applied_flex_rate_percent' | 'applied_fot_percent' | 'billing_address1' | 'billing_address2' | 'billing_city' | 'billing_country' | 'billing_first_name' | 'billing_last_name' | 'billing_postal_code' | 'billing_state' | 'browser_info' | 'campaign_id' | 'card_expiration' | 'card_last_four' | 'card_type' | 'charged_at' | 'charged_classy_fees_amount' | 'charged_currency_code' | 'charged_fees_amount' | 'charged_pp_fees_amount' | 'charged_total_gross_amount' | 'classy_fees_amount' | 'comment' | 'company_name' | 'context' | 'created_at' | 'currency_code' | 'designation_id' | 'donation_gross_amount' | 'donation_matching_plan_id' | 'donation_net_amount' | 'fee_on_top' | 'fees_amount' | 'frequency' | 'fundraising_page_id' | 'fundraising_team_id' | 'hide_amount' | 'id' | 'in_honor_of' | 'is_anonymous' | 'is_donor_covered_fee' | 'is_gift_aid' | 'is_reprocess' | 'member_country' | 'member_email_address' | 'member_id' | 'member_name' | 'member_phone' | 'member_cell_phone' | 'metadata' | 'organization_id' | 'overhead_net_amount' | 'parent_transaction_id' | 'payment_gateway' | 'payment_method' | 'payment_source' | 'payment_type' | 'pp_fees_amount' | 'pp_reference_id' | 'pp_response' | 'pp_transaction_id' | 'processor_decline_code' | 'promo_code_code' | 'purchased_at' | 'raw_currency_code' | 'raw_donation_gross_amount' | 'raw_initial_gross_amount' | 'opted_into_payment_sync' | 'initial_gross_amount' | 'raw_adjustment_amount' | 'raw_overhead_net_amount' | 'raw_total_gross_amount' | 'raw_flex_rate_amount' | 'flex_rate_amount' | 'raw_application_fee_amount' | 'application_fee_amount' | 'raw_processor_fee_amount' | 'processor_fee_amount' | 'receipt_serial' | 'recurring_donation_plan_id' | 'refunded_at' | 'reprocess_attempts' | 'reprocess_attempt_info' | 'status' | 'supporter_id' | 'tax_entity_id' | 'total_gross_amount' | 'updated_at' | 'account_number' | 'account_type' | 'institution'
Example:id

Comma-separated list of fields to be returned

Response

Success

current_pageinteger

Index of current page

first_page_urlstring nullable

URL of first page of results

frominteger nullable

Index of first displayed result within total result set

last_pageinteger

Index of last page in result set

last_page_urlstring nullable

URL of last page of results

next_page_urlstring nullable

URL of next page of results

pathstring nullable

URL of current page of results

per_pageinteger

Maximum number of records returned per page of results

prev_page_urlstring nullable

URL of previous page of results

tointeger nullable

Index of last displayed result within total result set

totalinteger

Total count of records in result set

Example response

{
  "current_page": 1,
  "data": [
    {
      "account_number": "1234",
      "account_type": "savings",
      "acknowledgements_count": 3,
      "adjustment_amount": 0.5,
      "application_fee_amount": 42,
      "applied_application_fee_percent": 3,
      "applied_flex_rate_percent": 50,
      "applied_fot_percent": 50,
      "applied_processor_fee_percent": 2.2,
      "applied_raw_processor_fee_flat": 0.2,
      "billing_address1": "533 F Street",
      "billing_address2": "533 F Street",
      "billing_city": "San Diego",
      "billing_country": "US",
      "billing_first_name": "GoFundMe Pro",
      "billing_last_name": "Member",
      "billing_postal_code": "92101",
      "billing_state": "CA",
      "browser_info": "information",
      "campaign_id": 227362,
      "card_expiration": "1017",
      "card_last_four": 1234,
      "card_type": "Visa",
      "charged_at": "2017-01-01T12:02:01+0000",
      "charged_classy_fees_amount": 0.15,
      "charged_currency_code": "USD",
      "charged_fees_amount": 0.35,
      "charged_pp_fees_amount": 0.15,
      "charged_total_gross_amount": 1,
      "classy_fees_amount": 0.34,
      "comment": "This is a comment",
      "company_name": "GoFundMe Pro",
      "context": {
        "application_fee_campaign_category": "main_donate_button",
        "application_fee_platform_fee_type": "non_migrated_recurring",
        "commerce_order_id": "or_01HFSN0GJZ6656RM8602Z37DY1",
        "customizations_metadata": {
          "theme": "dark",
          "custom_fields": {
            "field1": "value1"
          }
        },
        "created_by": "My App",
        "commerce_confirmation_id": "C9UE75VB2",
        "is_passport": true,
        "source_campaign_id": 227362,
        "source_campaign_type": "peer_to_peer",
        "vendor_name": "Vendor XYZ",
        "vendor_batch_number": "BATCH123456",
        "vendor_batch_sequence": "001",
        "vendor_batch_date": "2024-01-15"
      },
      "created_at": "2016-01-01T12:00:00+0000",
      "currency_code": "USD",
      "designation_id": 34672,
      "donation_gross_amount": 1.25,
      "donation_matching_plan_id": 4237,
      "donation_net_amount": 1.25,
      "fees_amount": 1.25,
      "fee_on_top": true,
      "flex_rate_amount": 42,
      "frequency": "one-time",
      "fundraising_page_id": 2173528,
      "fundraising_team_id": 209745,
      "id": 8734,
      "initial_gross_amount": 1.25,
      "institution": "ABC Bank",
      "in_honor_of": "GoFundMe Pro Relation",
      "is_donor_covered_fee": true,
      "is_reprocess": true,
      "member_country": "US",
      "member_email_address": "member@gofundme.com",
      "member_id": 2012,
      "member_name": "GoFundMe Pro Member",
      "member_phone": "555-555-5555",
      "member_cell_phone": "555-555-5555",
      "consent": {
        "sms_consent_decision_date": "2016-01-01T12:05:42+0000",
        "email_consent_decision_date": "2016-01-01T12:05:42+0000"
      },
      "metadata": "{foo: 'bar'}",
      "organization_id": 82364,
      "overhead_net_amount": 25,
      "parent_transaction_id": 8734,
      "payment_gateway": "BrainTree",
      "payment_method": "WPP",
      "payment_source": "WALLET",
      "payment_type": "Credit Card",
      "pp_fees_amount": 0.15,
      "pp_reference_id": "12345",
      "pp_response": "1023",
      "pp_transaction_id": "12345",
      "processor_decline_code": "64",
      "processor_fee_amount": 42,
      "promo_code_code": "PROMO",
      "purchased_at": "2016-01-01T12:00:00+0000",
      "raw_adjustment_amount": 0.25,
      "raw_application_fee_amount": 42,
      "raw_currency_code": "JPY",
      "raw_donation_gross_amount": 1.25,
      "raw_flex_rate_amount": 1.25,
      "raw_initial_gross_amount": 1.25,
      "raw_overhead_net_amount": 0.25,
      "raw_processor_fee_amount": 42,
      "raw_total_gross_amount": 1,
      "recurring_donation_plan_id": 23847,
      "refunded_at": "2016-01-01T12:00:00+0000",
      "reprocess_attempts": 2,
      "status": "canceled",
      "supporter_id": 5827,
      "tax_entity_id": 331,
      "total_gross_amount": 1.25,
      "updated_at": "2016-01-01T12:00:00+0000",
      "utm": {
        "campaign": "year_end_2025",
        "content": "top_banner",
        "medium": "email",
        "source": "mailchimp",
        "term": "donate now"
      }
    }
  ],
  "first_page_url": "{host}/campaigns/227362/transactions?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/campaigns/227362/transactions?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/campaigns/227362/transactions",
  "per_page": 20,
  "prev_page_url": "https://pro.gofundme.com/api/2.0/resource?page=1",
  "links": [
    {
      "label": "1",
      "url": "{host}/{resource}?page=1",
      "active": true
    }
  ],
  "to": 1,
  "total": 1
}