Contributions

Actions available on contributions.


List

Retrieve a list of matching contributions.

Request

  • url: /admin/api/v2/contributions
  • method: GET
  • parameters:

    • id: optional, string, exact match
    • number: optional, string, partial match

Response

contributions.json
{
  "data": [
    {
      "data": {
        "id": "KJLEMLD8",
        "contribution_number": "3B765B3D5B",
        "currency": "USD",
        "customer_comments": null,
        "notes": null,
        "is_paid": false,
        "referral_source": null,
        "created_at": null,
        "ordered_at": null,
        "cover_costs_enabled": false,
        "cover_costs_amount": 0,
        "discounts_amount": 0,
        "downloadable_item_count": 0,
        "recurring_item_count": 0,
        "shippable_item_count": 0,
        "payment_type": null,
        "shipping_amount": 0,
        "subtotal_amount": 9,
        "tax_amount": 0,
        "total_amount": 9,
        "refunded_amount": null,
        "refunded_at": null,
        "balance_amount": 9,
        "supporter": {
          "id": "KJLEMLD8",
          "display_name": "Hilma Hill",
          "title": "Ms.",
          "first_name": "Hilma",
          "last_name": "Hill",
          "email": "hilma.hill@example.com",
          "access": null,
          "addresses": {
            "billing": {
              "title": "Ms.",
              "first_name": "Hilma",
              "last_name": "Hill",
              "organization_name": "0",
              "email": "hilma.hill@example.com",
              "address_01": "31 Douglas Blvd #950",
              "address_02": null,
              "city": "Clovis",
              "state": "NM",
              "zip": "88101",
              "country": "US",
              "display_address": "31 Douglas Blvd #950\nClovis, NM, 88101, US",
              "phone": "815-262-7380 x53749",
              "display_phone": "815-262-7380x53749"
            },
            "shipping": {
              "title": "Ms.",
              "first_name": "Hilma",
              "last_name": "Hill",
              "organization_name": "0",
              "email": "hilma.hill@example.com",
              "address_01": "31 Douglas Blvd #950",
              "address_02": null,
              "city": "Clovis",
              "state": "NM",
              "zip": "88101",
              "country": "US",
              "phone": "815-262-7380 x53749"
            }
          },
          "sms_verified": false,
          "email_opt_in": false,
          "is_active": true,
          "supporter_type": "Individual",
          "created_at": "2021-03-29T23:12:35.000000Z",
          "updated_at": "2021-03-29T23:12:35.000000Z",
          "created_by": "",
          "sign_up_method": "checkout",
          "referral_source": null,
          "referral_code": "KJLEMLD8",
          "nps": null,
          "lifetime_donation_amount": "0.0000",
          "lifetime_donation_count": 0,
          "lifetime_purchase_amount": "0.0000",
          "lifetime_purchase_count": 0,
          "lifetime_fundraising_amount": "0.0000",
          "lifetime_fundraising_count": 0,
          "is_membership_expired": false,
          "membership": null,
          "membership_expires_on": null,
          "groups": []
        },
        "discounts": [
          {
            "code": "CmgDcfN_QbLN",
            "description": "sit veniam blanditiis explicabo vel omnis commodi minus eligendi doloremque",
            "amount": 46,
            "free_shipping": false,
            "formatted": "$46.00 OFF"
          }
        ],
        "line_items": [
          {
            "description": null,
            "image_thumb": null,
            "is_locked": false,
            "is_recurring": false,
            "is_price_reduced": false,
            "undiscounted_price": 0,
            "locked_original_price": null,
            "locked_variants_original_price": 0,
            "locked_variants_price": 3,
            "locked_variants_total": 9,
            "payment_string": "$3.00 USD one-time",
            "public_url": null,
            "recurring_description": null,
            "reference": null,
            "total": 9,
            "dpo_tribute_id": null,
            "gift_aid": false,
            "is_tribute": false,
            "price": 3,
            "qty": 3,
            "recurring_amount": 0,
            "recurring_day": null,
            "recurring_day_of_week": null,
            "recurring_with_dpo": false,
            "recurring_with_initial_charge": false,
            "recurring_cycles": null,
            "recurring_starts_on": null,
            "recurring_ends_on": null,
            "sponsorship_is_expired": false,
            "total_tax_amt": null
          }
        ],
        "payments": [
          {
            "id": 1,
            "type": "card",
            "status": "succeeded",
            "amount": 0,
            "amount_refunded": 0,
            "currency": {
              "name": "US Dollar",
              "code": "USD",
              "iso_code": "USD",
              "symbol": "$",
              "rate": 1
            },
            "paid": false,
            "captured": true,
            "captured_at": "2020-03-17T23:12:35.000000Z",
            "created_at": "2021-03-29T23:12:35.000000Z",
            "refunded": false,
            "reference_number": null,
            "description": "",
            "failure_code": null,
            "failure_message": null,
            "outcome": "authorized",
            "card": {
              "brand": "Maestro",
              "last4": null,
              "exp_month": 12,
              "exp_year": 2024,
              "cvc_check": null,
              "address_line1_check": null,
              "address_zip_check": null
            }
          }
        ],
        "tax_lines": [
          {
            "title": "BL Tax",
            "price": null,
            "rate": 0.064,
            "rate_percentage": 6.4
          }
        ],
        "email": "hilma.hill@example.com",
        "billing_address": {
          "title": "Ms.",
          "name": "Hilma Hill",
          "first_name": "Hilma",
          "last_name": "Hill",
          "email": "hilma.hill@example.com",
          "address1": "31 Douglas Blvd #950",
          "address2": null,
          "company": null,
          "city": "Clovis",
          "province_code": "NM",
          "zip": "88101",
          "country_code": "US",
          "phone": "815-262-7380 x53749"
        },
        "shipping_method": null,
        "shipping_address": {
          "title": "Ms.",
          "name": "Hilma Hill",
          "first_name": "Hilma",
          "last_name": "Hill",
          "email": "hilma.hill@example.com",
          "phone": "815-262-7380 x53749",
          "address1": "31 Douglas Blvd #950",
          "address2": null,
          "company": null,
          "city": "Clovis",
          "province_code": "NM",
          "zip": "88101",
          "country_code": "US"
        }
      }
    }
  ],
  "links": {
    "first": "https://your-domain.givecloud.co/admin/api/v2/contributions?page=1",
    "last": "https://your-domain.givecloud.co/admin/api/v2/contributions?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://your-domain.givecloud.co/admin/api/v2/contributions?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://your-domain.givecloud.co/admin/api/v2/contributions",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Get

Retrieve the first matching contribution. This returns a 404 if there is no matching contribution found.

Request

  • url: /admin/api/v2/contributions/{id}
  • method: GET
  • parameters:

    • id: optional, string, exact match
    • number: optional, string, partial match

Response

contribution.json
{
  "data": {
    "id": "KJLEMLD8",
    "contribution_number": "3B765B3D5B",
    "currency": "USD",
    "customer_comments": null,
    "notes": null,
    "is_paid": false,
    "referral_source": null,
    "created_at": null,
    "ordered_at": null,
    "cover_costs_enabled": false,
    "cover_costs_amount": 0,
    "discounts_amount": 0,
    "downloadable_item_count": 0,
    "recurring_item_count": 0,
    "shippable_item_count": 0,
    "payment_type": null,
    "shipping_amount": 0,
    "subtotal_amount": 9,
    "tax_amount": 0,
    "total_amount": 9,
    "refunded_amount": null,
    "refunded_at": null,
    "balance_amount": 9,
    "supporter": {
      "id": "KJLEMLD8",
      "display_name": "Hilma Hill",
      "title": "Ms.",
      "first_name": "Hilma",
      "last_name": "Hill",
      "email": "hilma.hill@example.com",
      "access": null,
      "addresses": {
        "billing": {
          "title": "Ms.",
          "first_name": "Hilma",
          "last_name": "Hill",
          "organization_name": "0",
          "email": "hilma.hill@example.com",
          "address_01": "31 Douglas Blvd #950",
          "address_02": null,
          "city": "Clovis",
          "state": "NM",
          "zip": "88101",
          "country": "US",
          "display_address": "31 Douglas Blvd #950\nClovis, NM, 88101, US",
          "phone": "815-262-7380 x53749",
          "display_phone": "815-262-7380x53749"
        },
        "shipping": {
          "title": "Ms.",
          "first_name": "Hilma",
          "last_name": "Hill",
          "organization_name": "0",
          "email": "hilma.hill@example.com",
          "address_01": "31 Douglas Blvd #950",
          "address_02": null,
          "city": "Clovis",
          "state": "NM",
          "zip": "88101",
          "country": "US",
          "phone": "815-262-7380 x53749"
        }
      },
      "sms_verified": false,
      "email_opt_in": false,
      "is_active": true,
      "supporter_type": "Individual",
      "created_at": "2021-03-29T23:12:35.000000Z",
      "updated_at": "2021-03-29T23:12:35.000000Z",
      "created_by": "",
      "sign_up_method": "checkout",
      "referral_source": null,
      "referral_code": "KJLEMLD8",
      "nps": null,
      "lifetime_donation_amount": "0.0000",
      "lifetime_donation_count": 0,
      "lifetime_purchase_amount": "0.0000",
      "lifetime_purchase_count": 0,
      "lifetime_fundraising_amount": "0.0000",
      "lifetime_fundraising_count": 0,
      "is_membership_expired": false,
      "membership": null,
      "membership_expires_on": null,
      "groups": []
    },
    "discounts": [
      {
        "code": "CmgDcfN_QbLN",
        "description": "sit veniam blanditiis explicabo vel omnis commodi minus eligendi doloremque",
        "amount": 46,
        "free_shipping": false,
        "formatted": "$46.00 OFF"
      }
    ],
    "line_items": [
      {
        "description": null,
        "image_thumb": null,
        "is_locked": false,
        "is_recurring": false,
        "is_price_reduced": false,
        "undiscounted_price": 0,
        "locked_original_price": null,
        "locked_variants_original_price": 0,
        "locked_variants_price": 3,
        "locked_variants_total": 9,
        "payment_string": "$3.00 USD one-time",
        "public_url": null,
        "recurring_description": null,
        "reference": null,
        "total": 9,
        "dpo_tribute_id": null,
        "gift_aid": false,
        "is_tribute": false,
        "price": 3,
        "qty": 3,
        "recurring_amount": 0,
        "recurring_day": null,
        "recurring_day_of_week": null,
        "recurring_with_dpo": false,
        "recurring_with_initial_charge": false,
        "recurring_cycles": null,
        "recurring_starts_on": null,
        "recurring_ends_on": null,
        "sponsorship_is_expired": false,
        "total_tax_amt": null
      }
    ],
    "payments": [
      {
        "id": 1,
        "type": "card",
        "status": "succeeded",
        "amount": 0,
        "amount_refunded": 0,
        "currency": {
          "name": "US Dollar",
          "code": "USD",
          "iso_code": "USD",
          "symbol": "$",
          "rate": 1
        },
        "paid": false,
        "captured": true,
        "captured_at": "2020-03-17T23:12:35.000000Z",
        "created_at": "2021-03-29T23:12:35.000000Z",
        "refunded": false,
        "reference_number": null,
        "description": "",
        "failure_code": null,
        "failure_message": null,
        "outcome": "authorized",
        "card": {
          "brand": "Maestro",
          "last4": null,
          "exp_month": 12,
          "exp_year": 2024,
          "cvc_check": null,
          "address_line1_check": null,
          "address_zip_check": null
        }
      }
    ],
    "tax_lines": [
      {
        "title": "BL Tax",
        "price": null,
        "rate": 0.064,
        "rate_percentage": 6.4
      }
    ],
    "email": "hilma.hill@example.com",
    "billing_address": {
      "title": "Ms.",
      "name": "Hilma Hill",
      "first_name": "Hilma",
      "last_name": "Hill",
      "email": "hilma.hill@example.com",
      "address1": "31 Douglas Blvd #950",
      "address2": null,
      "company": null,
      "city": "Clovis",
      "province_code": "NM",
      "zip": "88101",
      "country_code": "US",
      "phone": "815-262-7380 x53749"
    },
    "shipping_method": null,
    "shipping_address": {
      "title": "Ms.",
      "name": "Hilma Hill",
      "first_name": "Hilma",
      "last_name": "Hill",
      "email": "hilma.hill@example.com",
      "phone": "815-262-7380 x53749",
      "address1": "31 Douglas Blvd #950",
      "address2": null,
      "company": null,
      "city": "Clovis",
      "province_code": "NM",
      "zip": "88101",
      "country_code": "US"
    }
  }
}