Transactions

Every donation or ticket purchase made on your campaigns are called Transactions. Every Transaction is made up of several Line Items that represent the contents of that transaction.

The Transaction Object

Attribute

Description

id

The ID of the transaction.

campaign_id

The ID of the campaign this transaction is credited to.

plan_id

The ID of a recurring plan this transaction is made under.

team_id

The ID of the team this transaction is credited to.

member_id

The ID of the member this transaction is credited to.

first_name

The supporter's first name.

last_name

The supporter's last name.

email

The supporter's email address.

phone

The supporter's phone number.

address

And object representing the supporter's billing address.

status

The status of the transaction. Possible values: succeeded, authorized, failed, cancelled.

method

The method this transaction was paid with. Possible values: card, paypal, venmo, check, cash

amount

The amount the transaction was for.

fee

The full fee charged.

fee_covered

The portion of the fee the supporter covered.

charged

The final amount charged to the payment method.

donated

The final amount donated to the campaign after fees.

payout

The amount Givebutter will payout to your account after fees. Note for offline donations this will be 0.

currency

The currency the donation was made in.

created_at

A UTC datetime string indicating when the transaction was created.

captured

A boolean value letting you know if the transaction has been captured.

captured_at

A UTC datetime string indicating when the transaction was captured. For non-pledge transactions this will be the same as created_at.

refunded

A boolean value letting you know if the transaction was refunded.

refunded_at

A UTC datetime string indicating when the transaction was refunded.

line_items

An array containing the Line Items associated with this transaction.

giving_space

An object representing the Giving Space for this transaction.

get
Get Transactions

https://api.givebutter.com/v1/transactions/:id
Retrieve a list of your transactions. Include an id to retrieve a specific transaction.
Request
Response
Request
Path Parameters
id
optional
string
The ID of the transaction.
Query Parameters
scope
optional
string
The scope of transactions to retrieve: null to retrieve only your account's transactions. benefiting to retrieve transactions of which you are the beneficiary. chapters to retrieve transactions made to chapters under your account. all to retrieve all transactions related to your account.
Response
200: OK
Transaction successfully retrieved with ID.
{
"id": "OR2Q93LZhKm1PL66",
"campaign_id": 71,
"team_id": null,
"member_id": null,
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.net",
"phone": "(271) 555-1212",
"address": {
"address_1": "4 Privet Drive",
"address_2": null,
"city": "Newark",
"state": "NJ",
"zipcode": "07104",
"country": "USA"
},
"status": "succeeded",
"method": "card",
"amount": 49,
"fee": 3.29,
"fee_covered": 3.29,
"donated": 49,
"payout": 49,
"currency": "USD",
"created_at": "2020-05-15 19:50:02",
"giving_space": {
"id": 263,
"name": "John Doe",
"amount": 49,
"message": null
},
"transactions": [
{
"id": "7535510393",
"plan_id": null,
"amount": 49,
"fee": 3.29,
"fee_covered": 3.29,
"donated": 49,
"payout": 49,
"captured": true,
"captured_at": "2020-05-15 19:50:03",
"refunded": false,
"line_items": [
{
"type": "item",
"subtype": "ticket",
"description": "General Admission",
"quantity": 1,
"price": 49,
"discount": 0,
"total": 49
},
{
"type": "donation",
"subtype": "fee",
"description": "Processing fee",
"quantity": 1,
"price": 3.29,
"discount": 0,
"total": 3.29
}
]
}
]
}

This endpoint returns only transactions made under your account by default. If your account has campaigns of which you are the beneficiary, or campaigns owned by chapter accounts, you'll need to change the scope parameter to the appropriate value.