List Donations

GET 
/v1/donations

List Donations

Request

Query Parameters

userId string

Filter results by userId.

status string

Possible values: [ACTIVE, REQUESTED_PAYMENT, RECEIVED_PAYMENT, DISBURSED, CANCELLED]

Filter results by status.

startDate date-time
Start date to retrieve users donations from.
Example: 2020-10-13T17:46:54.000Z
endDate date-time
End date to retrieve users donations from.
Example: 2020-10-13T17:46:54.000Z
organisationId string

Filter results by organisationId.

cursor string

A cursor that points to where to start the page

pageSize integer

Default value: 25

How many items per page, for pagination.

Responses

200

Successfully listed Donations

application/json

Schema

Schema

data object[]
Array [
anyOf
direct donation
id string
userId stringnullable
organisationId stringnullable
amount integer
Donation amount. A positive integer representing donation amount in the smallest currency unit, for example 100 pence for a donation of £1.00.
currencyCode string
Three-letter ISO currency code
createdAt date-time
status string
Possible values: [ACTIVE, REQUESTED_PAYMENT, RECEIVED_PAYMENT, DISBURSED, CANCELLED]
firstName stringnullable
Users first name.
lastName stringnullable
Users last name.
email stringnullable
Users email.
consentedToBeContacted stringnullable
Possible values: [yes, no]
Whether the user consented to be contacted by the benefitting organisation.
anonymous stringnullable
Possible values: [yes, no]
Whether the user wants to share their donation publicly or not.
metadata objectnullable
Key-value data that you can attach to an object.
property name* string
giftAidId stringnullable
cancelledAt date-timenullable
donationRequestId stringnullable
accountId stringnullable
type string
Possible values: [direct]
hosted donation
id string
userId stringnullable
organisationId stringnullable
amount integer
Donation amount. A positive integer representing donation amount in the smallest currency unit, for example 100 pence for a donation of £1.00.
currencyCode string
Three-letter ISO currency code
createdAt date-time
status string
Possible values: [ACTIVE, REQUESTED_PAYMENT, RECEIVED_PAYMENT, DISBURSED, CANCELLED]
firstName stringnullable
Users first name.
lastName stringnullable
Users last name.
email stringnullable
Users email.
consentedToBeContacted stringnullable
Possible values: [yes, no]
Whether the user consented to be contacted by the benefitting organisation.
anonymous stringnullable
Possible values: [yes, no]
Whether the user wants to share their donation publicly or not.
metadata objectnullable
Key-value data that you can attach to an object.
property name* string
giftAidId stringnullable
cancelledAt date-timenullable
donationRequestId stringnullable
accountId stringnullable
type string
Possible values: [hosted]
hosted object
Contains additional fields available for hosted Donations.
sessionId string
Donation Session Id
]
object string
totalResults integer
pageSize integer
_links object
current string
next string
prev string

Example (from schema)

{
  "data": [
    {},
    {}
  ],
  "object": "donation",
  "totalResults": 33,
  "pageSize": 25,
  "_links": {
    "current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
  }
}

400

Bad request

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

CursorError

Error in cursor parameter

{
  "error": {
    "code": "pagination/cursor_error",
    "title": "Bad request",
    "message": "Unable to find the next page"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

Loading...