Donations

List donation appeals

/selfservice/v2/$FLOCK/donations/

Collecting donations through the self-service app.

http GET https://sls-api.sheepcrm.com/selfservice/v2/$FLOCK/donations/

{
    "appeals": [
        {
            "accepting_donations": null,
            "active": true,
            "description": null,
            "featured": null,
            "id": "5eb3c921b4d5a2118ba7a6d3",
            "office_only": null,
            "photo": null,
            "secondary_photos": null,
            "short_description": null,
            "target_amount": null,
            "thank_text": null,
            "title": "Covid-19 Appeal",
            "uid": "5eb3c921b4d5a2118ba7a6d3",
            "uri": "/example/donation_appeal/5eb3c921b4d5a2118ba7a6d3/",
            "url": "/selfservice/v2/example/donations/5eb3c921b4d5a2118ba7a6d3/"
        }
    ]
}

Donation single

/selfservice/v2/$FLOCK/donation/{appeal_id}/

http GET https://sls-api.sheepcrm.com/selfservice/v2/$FLOCK/donation/{appeal_id}/

{
    "accepting_donations": null,
    "active": true,
    "description": null,
    "featured": null,
    "id": "5eb3c914b4d5a20fc4a7a6d8",
    "office_only": null,
    "photo": null,
    "secondary_photos": null,
    "short_description": null,
    "target_amount": null,
    "thank_text": null,
    "title": "Global Fund",
    "uid": "5eb3c914b4d5a20fc4a7a6d8",
    "uri": "/example/donation_appeal/5eb3c914b4d5a20fc4a7a6d8/",
    "url": "/selfservice/v2/example/donation/5eb3c914b4d5a20fc4a7a6d8/"
}

Record a donation against an appeal

/api/v1/$FLOCK/user/donations/{appeal_id}/

Note

This is a V1 API call using a different path; the earlier donation calls use V2.

Parameter	Required	Description
amount	Yes	Donation amount
currency	Yes	Donation currency (three letter ISO code e.g. GBP, EUR, USD)
gift_aid	Yes	Y or N
donation_method	Yes	Donation method

http POST https://api.sheepcrm.com/api/v1/$FLOCK/user/donations/{appeal_id}/ "Authorization: Bearer $APP_API_TOKEN" amount=12.34 currency=gbp gift_aid=true donation_method=cash

{
    "status": "ok",
    "url": "/example/pledge/5f07330c80859ee28a8c5657/"
}