JustGiving API

Uri /{appId}/v1/donation/ref/{thirdPartyReference}
Verb GET
Auth No

Gets the details of a donation by third party reference code.

{thirdPartyReference} - The third party reference code added to the donation when using Simple Donation Integration (SDI).

Http

To request: https://api.justgiving.com/{appId}/v1/donation/ref/{thirdPartyReference}
Perform the following HTTP request:

GET /{appId}/v1/donation/ref/{thirdPartyReference} HTTP/1.1
Host: api.justgiving.com
Content-type: application/json

HTTP Status Codes

  • 200 OK - OK
  • 404 NotFound - Donation not found / doesn't exist

Response Examples

{
    "amount": "2.00",
    "currencyCode": "GBP",
    "donationDate": "\/Date(1493569892807+0000)\/",
    "donationRef": null,
    "donorDisplayName": "Awesome Guy",
    "donorLocalAmount": "2.75",
    "donorLocalCurrencyCode": "EUR",
    "donorRealName": "Peter Queue",
    "estimatedTaxReclaim": 0.56,
    "id": 1234,
    "image": "",
    "message": "Hope you like my donation. Rock on!",
    "source": "SponsorshipDonations",
    "status": "Accepted",
    "thirdPartyReference": "1234-my-sdi-ref"
}
id (Integer (32bit))
The DonationId
donationRef (String)
The DonationReference presented to the user on their donation receipt
image (String)
The image the user selected when leaving a message. Only available if the user has left a message with preferences that allow this information to be shared.
hasImage (Boolean)
Only available if the user has left a message with preferences that allow this information to be shared.
donationDate (DateTime)
donorDisplayName (String)
The name the donor left with their donation message
message (String)
The message the donor left with their donation. Only available if the authenticated user credentials match the page owner or if the donation preferences enable sharing this value on the web.
estimatedTaxReclaim (Decimal)
amount (String)
donorRealName (String)
Only available if the authenticated user credentials match the page owner.
thirdPartyReference (String)
Reference attached to the donation via Simple Donation Integration
status (String)
One of "Accepted", "Rejected", "Cancelled", "Refunded" or "Pending"
source (String)
The origin of the donation, one of "DirectDonations", "SponsorshipDonations", "Ipdd", "Sms"
currencyCode (String)
donorLocalAmount (String)
donorLocalCurrencyCode (String)
errorMessage (String)