Skip to main content
GET
/
v1
/
transactions
List all transactions
curl --request GET \
  --url https://api.givebutter.com/v1/transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "plan_id": "<string>",
      "pledge_id": "<string>",
      "amount": 123,
      "fee": 123,
      "fee_covered": 123,
      "donated": 123,
      "payout": 123,
      "captured": "<string>",
      "captured_at": "<string>",
      "timezone": "<string>",
      "refunded": "<string>",
      "refunded_at": "<string>",
      "line_items": [
        {
          "type": "<string>",
          "subtype": "<string>",
          "description": "<string>",
          "quantity": 123,
          "price": 123,
          "discount": 123,
          "total": 123,
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ],
      "fair_market_value_amount": "<string>",
      "tax_deductible_amount": "<string>",
      "is_recurring": "<string>"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1,
    "unfiltered_total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
transactedAfter
string<date-time> | null
​
transactedBefore
string<date-time> | null
​
createdAfter
string<date-time> | null
​
createdBefore
string<date-time> | null
​
updatedAfter
string<date-time> | null
​
updatedBefore
string<date-time> | null
​
checkDepositedAfter
string<date-time> | null
​
checkDepositedBefore
string<date-time> | null
​
contacts
string | null
​
method
string | null
​
scope
enum<string> | null
Available options:
all,
benefiting,
chapters
​
sortBy
enum<string> | null
Available options:
amount,
transacted_at,
created_at,
contact_name
​
sortByDesc
enum<string> | null
Available options:
amount,
transacted_at,
created_at,
contact_name

Response

Paginated set of TransactionResource

​
data
TransactionResource · object[]
required
​
links
object
required
​
meta
object
required