v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Transaction

reprocessRecurringDonationPlanTransaction

Reprocess a Transactions for a Recurring Donation Plan

post/recurring-donation-plans/{id}/transactions/{transaction_id}/reprocess

Path parameters

idinteger required
Example:85456

The specified Recurring Donation Plan ID

transaction_idinteger required
Example:8734

The specified Transaction 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

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

raw_currency_codestring nullable

Currency Code of the Transaction before normalization

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

The status of the Transaction

fundraising_tracking_codestring

Fundraising Tracking Code to improve accuracy and efficiency in fundraising reporting

Example request

{
  "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",
  "is_reprocess": true,
  "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'}",
  "raw_currency_code": "JPY",
  "status": "canceled",
  "reprocess_attempt_info": {
    "original_transaction_id": 8734,
    "reprocess_transaction_id": 7623371,
    "initiated_by_id": 2012,
    "pp_transaction_id": "922337203687624342",
    "state": "completed"
  },
  "fundraising_tracking_code": "JD0146"
}

Response

Success

created_atstring date-time

Date/Time ReprocessAttemptInfo was created

initiated_by_idinteger

The ID of the member initiating the reprocess

original_transaction_idinteger

ID of the original Transaction

reprocess_transaction_idinteger

ID of Reprocess Transaction

state'completed' | 'pending' | 'failed'

Reprocess status

updated_atstring date-time

Date/Time ReprocessAttemptInfo was updated

Example response

{
  "created_at": "2021-01-01T12:00:00+0000",
  "initiated_by_id": 2012,
  "original_transaction_id": 8734,
  "reprocess_transaction_id": 7623371,
  "state": "completed",
  "updated_at": "2021-01-01T12:00:00+0000"
}