Contributions (V2) (Deprecated)
Actions available on contributions.
List
Retrieve a list of matching contributions.
Note: This endpoint returns one-time contributions. To retrieve recurring transactions, see Recurring Transactions.
Request
- url:
/admin/api/v2/contributions
- method:
GET
-
filters: (how?)
number
: optional, string, partial matchordered_before
: optional, date or datetime, will only return contributions that were placed before that date (non-inclusive)ordered_after
: optional, date or datetime, will only return contributions that were placed after that date (non-inclusive)updated_before
: optional, date or datetime, will only return contributions that were last updated before that date (non-inclusive)updated_after
: optional, date or datetime, will only return contributions that were last updated after that date (non-inclusive)
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,
"http_referer": "https://our-awesome-site.example",
"tracking_source": "newsletter",
"tracking_medium": "email",
"tracking_campaign": "spring_sale",
"tracking_term": "donate",
"tracking_content": "action2",
"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,
"fields": [
{
"field_id": "Z84E3ZDW",
"name": "My Awesome Custom",
"value": "Custom Value 1"
},
{
"field_id": "347E45DG",
"name": "My Awesome Hidden One",
"value": "Custom Value 2"
}
],
"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,
"accounting": {
"code": "DON-3"
},
"fundraiser": {
"id": "YGNE52D8",
"title": "Phil's Annual Fundraiser",
"url": "https://your-domain.givecloud.co/fundraisers/phil-s-annual-fundraiser",
"category": "Birthday",
"goal_deadline": null,
"supporter": {...}
}
}
],
"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,
"gateway": "givecloudtest",
"reference_number": "fciHNvvZCSO8EMF2rMg9A0Oq",
"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 or recurring transaction.
This returns a 404
if there is no matching contribution found.
Request
- url:
/admin/api/v2/contributions/{id}
- method:
GET
-
parameters:
id
: required, string, exact match
Contribution 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,
"http_referer": "https://our-awesome-site.example",
"tracking_source": "newsletter",
"tracking_medium": "email",
"tracking_campaign": "spring_sale",
"tracking_term": "donate",
"tracking_content": "action2",
"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,
"fields": [
{
"field_id": "Z84E3ZDW",
"name": "My Awesome Custom",
"value": "Custom Value 1"
},
{
"field_id": "347E45DG",
"name": "My Awesome Hidden One",
"value": "Custom Value 2"
}
],
"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,
"fundraiser": {
"id": "YGNE52D8",
"title": "Phil's Annual Fundraiser",
"url": "https://your-domain.givecloud.co/fundraisers/phil-s-annual-fundraiser",
"category": "Birthday",
"goal_deadline": null,
"supporter": {...}
}
}
],
"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,
"gateway": "givecloudtest",
"reference_number": "fciHNvvZCSO8EMF2rMg9A0Oq",
"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"
}
}
}
Transaction Response
transaction.json
{
"data": {
"id": "txn_7GZEJPE2",
"contribution_number": "ch_UONrzHupydUV",
"currency": "CAD",
"customer_comments": null,
"notes": null,
"is_paid": true,
"referral_source": "Website",
"ordered_at": "2021-05-18T18:32:13Z",
"updated_at": "2021-05-18T18:32:13Z",
"cover_costs_enabled": false,
"cover_costs_amount": 0,
"discounts_amount": null,
"downloadable_item_count": 0,
"recurring_item_count": 1,
"shippable_item_count": 0,
"payment_type": "givecloudtest",
"shipping_amount": 0,
"subtotal_amount": 100,
"tax_amount": 0,
"total_amount": 100,
"refunded_amount": null,
"refunded_at": "",
"balance_amount": 100,
"http_referer": "https://our-awesome-site.example",
"tracking_source": "newsletter",
"tracking_medium": "email",
"tracking_campaign": "spring_sale",
"tracking_term": "donate",
"tracking_content": "action2",
"supporter": {
"id": "P59EKZDK",
"active": true,
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"type": "Individual",
"email_opt_in": false,
"vendor_contact_id": 2966,
"billing_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"created_at": "2021-04-28T13:38:44Z",
"updated_at": "2021-12-21T18:18:50Z",
"membership": {
"id": "MKYEL8EW",
"name": "Our best donors",
"description": null,
"sequence": null,
"default_url": null,
"days_to_expire": null,
"show_in_profile": true,
"public_name": null,
"public_description": null,
"members_can_manage_optin": false,
"members_can_manage_optout": false,
"members_can_view_directory": false,
"double_optin_required": false,
"should_display_badge": false,
"dp_id": null,
"created_by": 2,
"created_at": "2021-05-07T18:40:08Z",
"updated_by": 2,
"updated_at": "2021-05-07T20:20:24Z",
"deleted_at": "",
"deleted_by": null,
"starts_at": ""
},
"groups": [
{
"id": "7GZEJPE2",
"name": "Sample Annual Membership",
"description": null,
"sequence": null,
"default_url": null,
"days_to_expire": 365,
"show_in_profile": true,
"public_name": "General Annual Membership",
"public_description": null,
"members_can_manage_optin": false,
"members_can_manage_optout": false,
"members_can_view_directory": false,
"double_optin_required": false,
"should_display_badge": true,
"dp_id": null,
"created_by": 1,
"created_at": "2019-09-17T04:49:13Z",
"updated_by": 2,
"updated_at": "2021-05-06T15:42:52Z",
"deleted_at": "",
"deleted_by": null,
"starts_at": ""
}
]
},
"discounts": [],
"line_items": [
{
"id": "KJLEMLD8",
"description": "General Annual Membership - General",
"image_thumb": "",
"is_locked": false,
"is_recurring": true,
"is_price_reduced": false,
"undiscounted_price": 100,
"locked_original_price": "100.0000",
"locked_variants_original_price": 100,
"locked_variants_price": 100,
"locked_variants_total": 100,
"payment_string": "$100.00 CAD/yr starting May 17th, 2021",
"public_url": "https://your-domain.givecloud.co/product/M001/general-annual-membership",
"recurring_description": "$100.00/yr (18th) starting May 17th, 2021",
"reference": "M001",
"total": 100,
"dpo_tribute_id": null,
"fields": [],
"gift_aid": false,
"is_tribute": false,
"price": 100,
"qty": 1,
"recurring_amount": 100,
"recurring_day": 12,
"recurring_day_of_week": null,
"recurring_with_dpo": false,
"recurring_with_initial_charge": true,
"recurring_cycles": null,
"recurring_starts_on": "",
"recurring_ends_on": "",
"sponsorship_is_expired": false,
"total_tax_amt": null,
"fundraiser": {
"id": "YGNE52D8",
"title": "Phil's Annual Fundraiser",
"url": "https://your-domain.givecloud.co/fundraisers/phil-s-annual-fundraiser",
"category": "Birthday",
"goal_deadline": null,
"supporter": {...}
}
}
],
"payments": [
{
"id": "Z8NER6EK",
"type": "card",
"status": "succeeded",
"amount": 100,
"amount_refunded": 0,
"currency": {
"name": "US Dollar",
"code": "USD",
"iso_code": "USD",
"symbol": "$",
"rate": 1
},
"paid": true,
"captured": true,
"captured_at": "2021-05-18T18:32:13.000000Z",
"created_at": "2021-05-18T18:32:13.000000Z",
"refunded": false,
"gateway": "givecloudtest",
"reference_number": "fciHNvvZCSO8EMF2rMg9A0Oq",
"description": "Payment for Recurring Payment Profile #P59EKZDK",
"failure_code": null,
"failure_message": null,
"outcome": "authorized",
"card": {
"brand": "Visa",
"last4": "4242",
"exp_month": 2,
"exp_year": 2030,
"cvc_check": "unchecked",
"address_line1_check": "pass",
"address_zip_check": "pass"
}
}
],
"tax_lines": [],
"email": "hilma.hill@example.com",
"billing_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_method": null,
"shipping_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
}
}
}
Recurring Transactions
To retrieve recurring transactions, add the recurring=1
parameter to the contributions
endpoint.
Request
- url:
/admin/api/v2/contributions?recurring=1
- method:
GET
-
filters: (how?)
id
: optional, string, exact matchcontribution_number
: optional, string, partial matchordered_before
: optional, date or datetime, will only return contributions that were placed before that date (non-inclusive)ordered_after
: optional, date or datetime, will only return contributions that were placed after that date (non-inclusive)
Response
transactions.json
{
"data": [
{
"id": "txn_7GZEJPE2",
"contribution_number": "ch_UONrzHupydUV",
"currency": "CAD",
"customer_comments": null,
"notes": null,
"is_paid": true,
"referral_source": "Website",
"ordered_at": "2021-05-18T18:32:13Z",
"updated_at": "2021-05-18T18:32:13Z",
"cover_costs_enabled": false,
"cover_costs_amount": 0,
"discounts_amount": null,
"downloadable_item_count": 0,
"recurring_item_count": 1,
"shippable_item_count": 0,
"payment_type": "givecloudtest",
"shipping_amount": 0,
"subtotal_amount": 100,
"tax_amount": 0,
"total_amount": 100,
"refunded_amount": null,
"refunded_at": "",
"balance_amount": 100,
"http_referer": "https://our-awesome-site.example",
"tracking_source": "newsletter",
"tracking_medium": "email",
"tracking_campaign": "spring_sale",
"tracking_term": "donate",
"tracking_content": "action2",
"supporter": {
"id": "P59EKZDK",
"active": true,
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"type": "Individual",
"email_opt_in": false,
"vendor_contact_id": 2966,
"billing_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"created_at": "2021-04-28T13:38:44Z",
"updated_at": "2021-12-21T18:18:50Z",
"membership": {
"id": "MKYEL8EW",
"name": "Our best donors",
"description": null,
"sequence": null,
"default_url": null,
"days_to_expire": null,
"show_in_profile": true,
"public_name": null,
"public_description": null,
"members_can_manage_optin": false,
"members_can_manage_optout": false,
"members_can_view_directory": false,
"double_optin_required": false,
"should_display_badge": false,
"dp_id": null,
"created_by": 2,
"created_at": "2021-05-07T18:40:08Z",
"updated_by": 2,
"updated_at": "2021-05-07T20:20:24Z",
"deleted_at": "",
"deleted_by": null,
"starts_at": ""
},
"groups": [
{
"id": "7GZEJPE2",
"name": "Sample Annual Membership",
"description": null,
"sequence": null,
"default_url": null,
"days_to_expire": 365,
"show_in_profile": true,
"public_name": "General Annual Membership",
"public_description": null,
"members_can_manage_optin": false,
"members_can_manage_optout": false,
"members_can_view_directory": false,
"double_optin_required": false,
"should_display_badge": true,
"dp_id": null,
"created_by": 1,
"created_at": "2019-09-17T04:49:13Z",
"updated_by": 2,
"updated_at": "2021-05-06T15:42:52Z",
"deleted_at": "",
"deleted_by": null,
"starts_at": ""
}
]
},
"discounts": [],
"line_items": [
{
"id": "KJLEMLD8",
"description": "General Annual Membership - General",
"image_thumb": "",
"is_locked": false,
"is_recurring": true,
"is_price_reduced": false,
"undiscounted_price": 100,
"locked_original_price": "100.0000",
"locked_variants_original_price": 100,
"locked_variants_price": 100,
"locked_variants_total": 100,
"payment_string": "$100.00 CAD/yr starting May 17th, 2021",
"public_url": "https://your-domain.givecloud.co/product/M001/general-annual-membership",
"recurring_description": "$100.00/yr (18th) starting May 17th, 2021",
"reference": "M001",
"total": 100,
"dpo_tribute_id": null,
"fields": [],
"gift_aid": false,
"is_tribute": false,
"price": 100,
"qty": 1,
"recurring_amount": 100,
"recurring_day": 12,
"recurring_day_of_week": null,
"recurring_with_dpo": false,
"recurring_with_initial_charge": true,
"recurring_cycles": null,
"recurring_starts_on": "",
"recurring_ends_on": "",
"sponsorship_is_expired": false,
"total_tax_amt": null,
"fundraiser": {
"id": "YGNE52D8",
"title": "Phil's Annual Fundraiser",
"url": "https://your-domain.givecloud.co/fundraisers/phil-s-annual-fundraiser",
"category": "Birthday",
"goal_deadline": null,
"supporter": {...}
}
}
],
"payments": [
{
"id": "Z8NER6EK",
"type": "card",
"status": "succeeded",
"amount": 100,
"amount_refunded": 0,
"currency": {
"name": "US Dollar",
"code": "USD",
"iso_code": "USD",
"symbol": "$",
"rate": 1
},
"paid": true,
"captured": true,
"captured_at": "2021-05-18T18:32:13.000000Z",
"created_at": "2021-05-18T18:32:13.000000Z",
"refunded": false,
"gateway": "givecloudtest",
"reference_number": "fciHNvvZCSO8EMF2rMg9A0Oq",
"description": "Payment for Recurring Payment Profile #P59EKZDK",
"failure_code": null,
"failure_message": null,
"outcome": "authorized",
"card": {
"brand": "Visa",
"last4": "4242",
"exp_month": 2,
"exp_year": 2030,
"cvc_check": "unchecked",
"address_line1_check": "pass",
"address_zip_check": "pass"
}
}
],
"tax_lines": [],
"email": "hilma.hill@example.com",
"billing_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_method": null,
"shipping_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
}
}
],
"links": {
"first": "https://your-domain.givecloud.co/admin/api/v2/contributions?recurring=1&page=1",
"last": "https://your-domain.givecloud.co/admin/api/v2/contributions?recurring=1&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?recurring=1&page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://your-domain.givecloud.co/admin/api/v2/contributions?recurring=1",
"per_page": 15,
"to": 1,
"total": 1
}
}