JustGiving API Documentation

Getting Started

First Steps

Resources

CustomCodes
Donations
PagesCreated
PagesModified
Payment

Using the API

Usage
Getting Access
Terminology
API Keys
Content Types
HTTP Verbs
Status Codes
Errors
Security
What is REST?

API Keys

API Key Portal

getDonationsByDate

Uri/{apiKey}/v1/charity/{charityId}/donations/{date1};{date2}
Verb GET
AuthYes

Retrieves the donations report for the charity between a date interval of maximum 3 months

HTTP Status Codes

  • 200 (OK) - The request succeeded
  • 400 (BadRequest) - The dates are not valid

Response Examples

View as: Json Xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
[
    {
        "FundraiserUserId": "91f4abd7-2319-4562-9e4e-7be7d0dbbb6f",
        "FundraiserFirstName": "Test",
        "FundraiserLastName": "Test",
        "FundraiserEmail": "Test@justgiving.com",
        "FundraisingPageId": "63534",
        "FundraisingPageUrl": "http:\/\/justgiving.com\/myamazingpage",
        "DonorUserId": "234",
        "DonorTitle": "Mr.",
        "DonorFirstName": "Tester",
        "DonorLastName": "Test",
        "DonorAddressLine1": "1 Test Street",
        "DonorAddressLine2": "2 Line of address",
        "DonorTown": "London",
        "DonorCounty": "Southwark",
        "DonorPostCode": "SE156XS",
        "DonorCountry": "United Kingdom",
        "DonorEmail": "test@justgiving.com",
        "DonorFurtherContact": "false",
        "DonationRef": "123213151",
        "DonationDate": "2021-10-11",
        "DonationSource": "Source",
        "ProductSource": "Product source",
        "PaymentFrequency": "Monthly",
        "RecurringMandateCreationDate": "2021-11-10",
        "PaymentType": "Paypal",
        "DonationAuthCurrencyCode": "GBP",
        "DonationAuthAmount": 20,
        "DonorMessage": "Hi!",
        "DonationPaymentReference": "reference",
        "DonationPaymentReferenceDate": "2021-11-10",
        "GiftAidAmount": 2.5,
        "TransitionalReliefAmount": "10",
        "TotalAmountIncludingGiftAidAndTransitionalRelief": 30,
        "SettlementCurrency": "GBP",
        "TransactionStatus": null,
        "AppealName": "appeal name",
        "CustomEventCode1": "Foo",
        "CustomEventCode2": "Bar",
        "CustomEventCode3": "12345",
        "CustomFundraisingCode1": "FundraisingCode1",
        "CustomFundraisingCode2": "FundraisingCode2",
        "CustomFundraisingCode3": "FundraisingCode3",
        "CustomFundraisingCode4": "FundraisingCode4",
        "CustomFundraisingCode5": "FundraisingCode5",
        "CustomFundraisingCode6": "FundraisingCode6",
        "CustomCampaignCode1": "Campaign",
        "CustomCampaignCode2": "Custom",
        "CustomCampaignCode3": "Code",
        "ThirdPartyReference": "third party reference",
        "DonationConsent": "consent",
        "DonationConsentDate": "2021-11-10",
        "DonationPrivacyNoticeVersion": "1.2",
        "DonationConsentStatement": "consent statement",
        "BBMSTransactionId": null
    },
    {
        "FundraiserUserId": "91f4abd7-2319-4562-9e4e-7be7d0dbbb6f",
        "FundraiserFirstName": "Test",
        "FundraiserLastName": "Test",
        "FundraiserEmail": "Test@justgiving.com",
        "FundraisingPageId": "63534",
        "FundraisingPageUrl": "http:\/\/justgiving.com\/myamazingpage",
        "DonorUserId": "234",
        "DonorTitle": "Mr.",
        "DonorFirstName": "Tester",
        "DonorLastName": "Test",
        "DonorAddressLine1": "1 Test Street",
        "DonorAddressLine2": "2 Line of address",
        "DonorTown": "London",
        "DonorCounty": "Southwark",
        "DonorPostCode": "SE156XS",
        "DonorCountry": "United Kingdom",
        "DonorEmail": "test@justgiving.com",
        "DonorFurtherContact": "false",
        "DonationRef": "123213151",
        "DonationDate": "2021-10-11",
        "DonationSource": "Source",
        "ProductSource": "Product source",
        "PaymentFrequency": "Monthly",
        "RecurringMandateCreationDate": "2021-11-10",
        "PaymentType": "Paypal",
        "DonationAuthCurrencyCode": "GBP",
        "DonationAuthAmount": 20,
        "DonorMessage": "Hi!",
        "DonationPaymentReference": "reference",
        "DonationPaymentReferenceDate": "2021-11-10",
        "GiftAidAmount": 2.5,
        "TransitionalReliefAmount": "10",
        "TotalAmountIncludingGiftAidAndTransitionalRelief": 30,
        "SettlementCurrency": "GBP",
        "TransactionStatus": null,
        "AppealName": "appeal name",
        "CustomEventCode1": "Foo",
        "CustomEventCode2": "Bar",
        "CustomEventCode3": "12345",
        "CustomFundraisingCode1": "FundraisingCode1",
        "CustomFundraisingCode2": "FundraisingCode2",
        "CustomFundraisingCode3": "FundraisingCode3",
        "CustomFundraisingCode4": "FundraisingCode4",
        "CustomFundraisingCode5": "FundraisingCode5",
        "CustomFundraisingCode6": "FundraisingCode6",
        "CustomCampaignCode1": "Campaign",
        "CustomCampaignCode2": "Custom",
        "CustomCampaignCode3": "Code",
        "ThirdPartyReference": "third party reference",
        "DonationConsent": "consent",
        "DonationConsentDate": "2021-11-10",
        "DonationPrivacyNoticeVersion": "1.2",
        "DonationConsentStatement": "consent statement",
        "BBMSTransactionId": null
    },
    {
        "FundraiserUserId": "91f4abd7-2319-4562-9e4e-7be7d0dbbb6f",
        "FundraiserFirstName": "Test",
        "FundraiserLastName": "Test",
        "FundraiserEmail": "Test@justgiving.com",
        "FundraisingPageId": "63534",
        "FundraisingPageUrl": "http:\/\/justgiving.com\/myamazingpage",
        "DonorUserId": "234",
        "DonorTitle": "Mr.",
        "DonorFirstName": "Tester",
        "DonorLastName": "Test",
        "DonorAddressLine1": "1 Test Street",
        "DonorAddressLine2": "2 Line of address",
        "DonorTown": "London",
        "DonorCounty": "Southwark",
        "DonorPostCode": "SE156XS",
        "DonorCountry": "United Kingdom",
        "DonorEmail": "test@justgiving.com",
        "DonorFurtherContact": "false",
        "DonationRef": "123213151",
        "DonationDate": "2021-10-11",
        "DonationSource": "Source",
        "ProductSource": "Product source",
        "PaymentFrequency": "Monthly",
        "RecurringMandateCreationDate": "2021-11-10",
        "PaymentType": "Paypal",
        "DonationAuthCurrencyCode": "GBP",
        "DonationAuthAmount": 20,
        "DonorMessage": "Hi!",
        "DonationPaymentReference": "reference",
        "DonationPaymentReferenceDate": "2021-11-10",
        "GiftAidAmount": 2.5,
        "TransitionalReliefAmount": "10",
        "TotalAmountIncludingGiftAidAndTransitionalRelief": 30,
        "SettlementCurrency": "GBP",
        "TransactionStatus": null,
        "AppealName": "appeal name",
        "CustomEventCode1": "Foo",
        "CustomEventCode2": "Bar",
        "CustomEventCode3": "12345",
        "CustomFundraisingCode1": "FundraisingCode1",
        "CustomFundraisingCode2": "FundraisingCode2",
        "CustomFundraisingCode3": "FundraisingCode3",
        "CustomFundraisingCode4": "FundraisingCode4",
        "CustomFundraisingCode5": "FundraisingCode5",
        "CustomFundraisingCode6": "FundraisingCode6",
        "CustomCampaignCode1": "Campaign",
        "CustomCampaignCode2": "Custom",
        "CustomCampaignCode3": "Code",
        "ThirdPartyReference": "third party reference",
        "DonationConsent": "consent",
        "DonationConsentDate": "2021-11-10",
        "DonationPrivacyNoticeVersion": "1.2",
        "DonationConsentStatement": "consent statement",
        "BBMSTransactionId": null
    }
]