List donations

get

https://api.joyful.org/platforms/{platformId}/donations

Returns a list of donations. If there are no donations, the list will be empty.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

platformId

string

required

Query Params

created_before

date-time

Filter donations by the date they were created within the payment provider. Returns donations created before this date. The value should be an ISO 8601 formatted string: yyyy-MM-ddTHH:mm:ssZ

created_since

date-time

Filter donations by the date they were created within the payment provider. Returns donations created since this date. The value should be an ISO 8601 formatted string: yyyy-MM-ddTHH:mm:ssZ

inserted_since

date-time

Filter donations by the date they were inserted into the website reports. This can differ from the created date because of payment provider processing times. Returns donations inserted since this date. The value should be an ISO 8601 formatted string: yyyy-MM-ddTHH:mm:ssZ

offline

boolean

Set to true to retrieve offline payments added manually to the platform manager. By default, only online payments taken through the platform payment gateways will be returned

member_id

uuid

Filter donations by the member who made the donation. The value should be the unique GUID of the member's Id

appeal_id

uuid

Filter donations by the appeal id. The value should be the unique GUID of the appeal's Id

tax_relief

string

enum

Filter donations by tax relief. The value must be the name of the tax relief

Allowed:

subscription_id

string

Filter donations by subscription id. Used for retrieving all payments associated with a recurring payment subscription

transaction_id

string

Filter single donations by the transaction id. Returns single payments which match the supplied ID from the payment provider - for Stripe this is the Charge ID

payment_type

string

enum

Filter donations by specific payment types

Allowed:

page

int32

per_page

int32

Responses

401

Unauthorized

403

Forbidden

404

Not Found

200OK