GOgofundme
Transaction

createCampaignTransaction

Changed on

For external requests this creates an “offline” transaction record for the specified campaign. An offline transaction represents funds collected outside of the GoFundMe Pro platform, but accounted for in GoFundMe Pro reporting, activity feeds, etc. Adding an offline transaction record does not charge any credit cards, nor credit any GoFundMe Pro accounts.

An array of TransactionItems must be included along with the basic Transaction information via the items attribute. Please view the Transaction Item documentation for formatting pertaining to this attribute.

NOTE: requests must include one of the following: billing_first_name AND billing_last_name OR member_email_address OR company_name

Requests may contain all three. Please note that if an offline transaction only contains a company_name and is therefore a transaction by a company and not a person then answers will not be created for that transaction.

NOTE: parent_transaction_id and donation_matching_plan_id link a matched gift to its originating donation and matching plan. They are honored only for orchestrator (internal-app) requests; on the member GoFundMe-donation path they are validated for shape but otherwise ignored.

post/campaigns/{campaign}/transactions

Request

  • Base URL
    https://pro.gofundme.com/api/2.0
  • Auth
    OAuth 2
    Password
    Token URL: /oauth2/auth

Path parameters

campaigninteger required
Example:227362

The specified Campaign ID

Request body

billing_address1string nullable

Line one of Billing address

billing_address2string nullable

Line two of Billing address

billing_citystring nullable

Billing city

billing_countrystring nullable

Billing country. Must be a valid ISO 3166-1 alpha-2 country code

billing_first_namestring nullable

Billing first name

billing_last_namestring nullable

Billing last name

billing_postal_codestring nullable

Billing zip/postal code

billing_statestring nullable

Billing state/province

browser_infostring nullable

Browser information

commentstring nullable

Organization comment

company_namestring nullable

Name of company this Transaction has ties to

designation_idinteger nullable

ID of the Designation this Transaction is allocated to

fundraising_page_idinteger nullable

ID of the fundraising page to associate the transaction with

fundraising_team_idinteger nullable

ID of the fundraising team to associate the transaction with

hide_amountboolean nullable

Whether purchaser indicated if Transaction amount should be hidden

is_anonymousboolean nullable

Whether purchaser indicated if transaction should be anonymous

is_gift_aidboolean nullable

Flag whether the donor opted into gift aid used by the UK or not. Can only be set if the organization allows it

is_reprocessboolean nullable

If it is a reprocessed transaction or not

member_countrystring nullable

Country of the Member

member_email_addressstring nullable

Email address of purchaser GoFundMe Pro Member

member_namestring nullable

Name of purchaser GoFundMe Pro Member

member_phonestring nullable

Phone number of purchaser GoFundMe Pro Member

member_cell_phonestring nullable

Cell phone number of purchaser GoFundMe Pro Member. Also forwarded to the supporter record (cell_phone) on supporter creation — the SMS consent target when collected.

metadatastring nullable

An optional set of unstructured metadata to be stored with a Transaction

parent_transaction_idinteger nullable

ID of parent transaction

purchased_atstring date-time nullable

Date and time of purchase

raw_currency_codestring nullable

Currency Code of the Transaction before normalization

refunded_atstring date-time nullable

Date and time of refund

status'test' | 'canceled' | 'incomplete' | 'success' | 'refunded' | 'cb_lost' | 'cb_initiated' | 'voided' | 'pending' | 'failed' nullable

The status of the Transaction

Example request

{
  "answers": [
    {
      "answer": "Example answer test",
      "question_id": 45678
    }
  ],
  "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",
  "comment": "This is a comment",
  "company_name": "GoFundMe Pro",
  "designation_id": 564856,
  "fundraising_page_id": 865125,
  "fundraising_team_id": 256489,
  "is_reprocess": true,
  "items": [
    {
      "product_name": "Tickets",
      "quantity": 1,
      "raw_final_price": 15,
      "raw_overhead_amount": 15,
      "type": "donation"
    }
  ],
  "member_country": "US",
  "member_email_address": "member@gofundme.com",
  "member_name": "GoFundMe Pro Member",
  "member_phone": "555-555-5555",
  "member_cell_phone": "555-555-5555",
  "metadata": "{foo: 'bar'}",
  "offline_payment_info": {
    "check_number": "456",
    "description": "Lorem ipsum whatever",
    "payment_type": "cash"
  },
  "parent_transaction_id": 7133489,
  "purchased_at": "2016-01-01T12:00:00+0000",
  "raw_currency_code": "JPY",
  "refunded_at": "2016-01-01T12:00:00+0000",
  "status": "canceled"
}

Response

Success

account_numberstring nullable

For ACH, the last digits of the account funds were drawn from

account_type'savings' | 'checking' nullable

For ACH, what type of account funds were drawn from (savings, checking)

acknowledgements_countinteger

Number of times Transaction was acknowledged by staff

adjustment_amountnumber float nullable

The total value the transaction's total_gross_amount has been adjusted

application_fee_amountnumber float nullable

Flat amount associated with the application fee (normalized value)

applied_application_fee_percentnumber float nullable

Percent taken by GoFundMe Pro

applied_flex_rate_percentnumber float nullable

Add on rate set by organization

applied_fot_percentnumber float nullable

Percentage added to Fee on Top (aka Classy Mode) Transactions to cover fees. Null if the Transaction is not fee on top

applied_processor_fee_percentnumber float nullable

Percent taken by card processor

applied_raw_processor_fee_flatnumber float nullable

Flat rate taken by card processor

billing_address1string nullable

Billing address

billing_address2string nullable

Billing address 2

billing_citystring nullable

Billing city

billing_countrystring nullable

Billing country. Must be a valid ISO 3166-1 alpha-2 country code

billing_first_namestring nullable

Billing first name

billing_last_namestring nullable

Billing last name

billing_postal_codestring nullable

Billing zip/postal code

billing_statestring nullable

Billing state/province

browser_infostring nullable

Browser information

campaign_idinteger

ID of Campaign Transaction is associated with

card_expirationstring nullable

The expiration of credit card used (when applicable) in MMYY format

card_last_fourinteger nullable

The last four digits of the credit card (when applicable)

card_typestring nullable

Type of credit card used (when applicable)

charged_atstring date-time nullable

Date and time Transaction was charged

charged_classy_fees_amountnumber float nullable

Total fees applied by GoFundMe Pro

charged_currency_codestring nullable

Currency code of final charge. Required if charged_pp_fees_amount, charged_total_gross_amount or charged_classy_fees_amount are present.

charged_fees_amountnumber float nullable

Total fees applied to Transaction (GoFundMe Pro and payment processor)

charged_pp_fees_amountnumber float nullable

Total fees applied to by payment processor

charged_total_gross_amountnumber float nullable

Gross total charged to purchaser

classy_fees_amountnumber float nullable

Amount of fees applied by GoFundMe Pro

commentstring nullable

Organization comment

company_namestring nullable

Name of company this Transaction has ties to

created_atstring date-time

Date Transaction record was created

currency_codestring nullable

Currency code

designation_idinteger nullable

ID of the Designation this Transaction is allocated to

donation_gross_amountnumber float nullable

Gross total applied to purchaser in the raw currency

donation_matching_plan_idinteger nullable

ID of the Donation Matching Plan this Transaction is associated with

donation_net_amountnumber float nullable

Total gross amount - Overhead net amount - Fees amount

fees_amountnumber float nullable

Payment for professional service

fee_on_topboolean

Flag if the transaction is a fee on top (classymode) or not

flex_rate_amountnumber float nullable

Flat amount associated with the flex rate percent (normalized value)

frequency'bi-weekly' | 'bi-monthly' | 'daily' | 'monthly' | 'one-time' | 'quarterly' | 'semi-annual' | 'weekly' | 'yearly' nullable

Frequency of transaction: one-time or recurring

fundraising_page_idinteger nullable

ID of the Fundraising Page Transaction is associated with

fundraising_team_idinteger nullable

ID of Fundraising Team Transaction is associated with

hide_amountboolean

Whether purchaser indicated if Transaction amount should be hidden

idinteger

Unique ID of the Transaction

initial_gross_amountnumber float nullable

Amount before any fee adjustments where added (Normalization value)

institutionstring nullable

For ACH, the name of the banking institution funds were drawn from

in_honor_ofstring nullable

A person this donation is in honor or memory of. Deprecated, this field was replaced for the dedication object. When fetching the transaction, use the with query parameter with the dedication value to include it in the response.

is_anonymousboolean

Whether purchaser indicated if transaction should be anonymous

is_donor_covered_feeboolean

Flag if the transaction is a donor covered fee or not

is_gift_aidboolean

Flag whether the donor opted into gift aid used by the UK or not. Can only be set if the organization allows it

is_reprocessboolean nullable

If it is a reprocessed transaction or not. On an existing (persisted) reprocess row, when payment_type is 'ACH' or 'Credit Card' and the asserted method's own identifying field (account_number for ACH, card_last_four for Credit Card) already holds a value, writing any of payment_type/card_last_four/card_type/card_expiration/account_number/account_type/institution nulls the group NOT matching payment_type (PRO-7938). Setting is_reprocess=true in the same write does not itself arm this -- only an already-persisted reprocess row does. On an update, fields supplied in the same write are never cleared; on create, the group not matching payment_type is always cleared, even if supplied in the same request. Both groups can be transiently populated across a multi-step patch (e.g. instrument fields written in one save, payment_type flipped in a later one) until a save observes the mismatch.

member_countrystring nullable

Country of the Member. Must be a valid ISO 3166-1 alpha-2 country code

member_email_addressstring nullable

Email address of purchaser GoFundMe Pro Member

member_idinteger nullable

Primary ID of the purchaser GoFundMe Pro Member

member_namestring nullable

Name of purchaser GoFundMe Pro Member

member_phonestring nullable

Phone number of purchaser GoFundMe Pro Member

member_cell_phonestring nullable

Cell phone number of purchaser GoFundMe Pro Member — the SMS consent target when collected

metadatastring nullable

An optional set of unstructured metadata to be stored with a Transaction

organization_idinteger

ID of Organization Transaction is associated with

overhead_net_amountnumber float nullable

Amount of event/host fees

parent_transaction_idinteger nullable

Parent Transaction identifier

payment_gateway'' | 'StayClassy PayPal' | 'Authorize.net' | 'PayPal' | 'NetworkForGood' | 'WePay' | 'PayPalExternal' | 'BrainTree' | 'Classy Pay' | 'Dwolla' | 'Stripe' | 'PayPalCommerce' | 'Coinbase' | 'Double the Donation Pay' | 'Facebook Pay' nullable

Payment processor

payment_methodstring nullable

Service for processing payment

payment_source'APPLE_PAY' | 'GOOGLE_PAY' | 'STRIPE_LINK' | 'MANUAL' | 'PAYPAL' | 'PLAID' | 'WALLET' | 'VENMO' | 'COINBASE' nullable

How payment information was captured

payment_type'Credit Card' | 'ACH' | 'PayPal' | 'Venmo' | 'Crypto' nullable

How payment was made

pp_fees_amountnumber float nullable

Total fees applied by payment processor

pp_reference_idstring nullable

Reference ID for underlying transaction processing.

pp_responsestring nullable

Paypal response

pp_transaction_idstring nullable

Reference ID for underlying Transaction processing

processor_decline_codestring nullable

Code of processor decline

processor_fee_amountnumber float nullable

Flat amount associated with the processor fee (normalized value)

promo_code_codestring nullable

The code of the promo code applied to the Transaction

purchased_atstring date-time nullable

Date and time of Transaction

raw_adjustment_amountnumber float nullable

Total fee amount assessed

raw_application_fee_amountnumber float nullable

Raw Flat amount associated with the application fee

raw_currency_codestring nullable

Currency Code of the Transaction before normalization

raw_donation_gross_amountnumber float nullable

Gross total applied to purchaser in the raw currency

raw_flex_rate_amountnumber float nullable

Raw Flat amount associated with the flex rate percent

raw_initial_gross_amountnumber float nullable

Amount before any fee adjustments where added

raw_overhead_net_amountnumber float nullable

Net Amount of event/host fees in the raw currency

raw_processor_fee_amountnumber float nullable

Raw Flat amount associated with the processor fee

raw_total_gross_amountnumber float nullable

Gross amount charged to purchaser if raw currency code is set

recurring_donation_plan_idinteger nullable

ID of recurring Donation plan the Transaction belongs to. If there is no recurring Donation plan then this is null

refunded_atstring date-time nullable

Date and time of Refund, if applies

reprocess_attemptsinteger

Number of reprocess attempts for the transaction

status'test' | 'canceled' | 'incomplete' | 'success' | 'refunded' | 'cb_lost' | 'cb_initiated' | 'voided' | 'pending' | 'failed'

The status of the Transaction

supporter_idinteger nullable

Supporter ID associated with the Member

tax_entity_idinteger nullable

Tax entity that satisfies tax compliance for the Transaction

total_gross_amountnumber float nullable

Total value of Transaction

updated_atstring date-time nullable

Date and time of last update

opted_into_payment_syncboolean

Registrant has opted into storing their payment info for future Live Events purchases.

Example response

{
  "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": "classy_manager",
    "created_by_source": "live_events",
    "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"
  }
}

Changes

  • 59289a48dd28Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the optional property // to the response with the status