List Donations

GET 
/v1/donations

Retrieve a list of donations.

PII fields (firstName, lastName & email) will be included or excluded depending on your partner settings.

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
How many items per page, for pagination.
Default value: 25

Responses

200

Successfully listed Donations

application/json

Schema

Schema

data

object[]

Array [

anyOf

direct donation

id string

Example: donation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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.

Example: 123

currencyCode string

Three-letter ISO currency code

Example: AUD

createdAt date-time

Example: 2020-10-13T17:46:54.000Z

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

Whether the user consented to be contacted by the benefitting organisation.

Possible values: [yes, no]

anonymous stringnullable

Whether the user wants to share their donation publicly or not.

Possible values: [yes, no]

metadata

object

nullable

Key-value data that you can attach to an object.

property name* string

giftAidId stringnullable

cancelledAt date-timenullable

Example: 2020-10-13T17:46:54.000Z

donationRequestId stringnullable

Example: donationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

accountId stringnullable

Example: account_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

type string

Possible values: [direct]

hosted donation

id string

Example: donation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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.

Example: 123

currencyCode string

Three-letter ISO currency code

Example: AUD

createdAt date-time

Example: 2020-10-13T17:46:54.000Z

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

Whether the user consented to be contacted by the benefitting organisation.

Possible values: [yes, no]

anonymous stringnullable

Whether the user wants to share their donation publicly or not.

Possible values: [yes, no]

metadata

object

nullable

Key-value data that you can attach to an object.

property name* string

giftAidId stringnullable

cancelledAt date-timenullable

Example: 2020-10-13T17:46:54.000Z

donationRequestId stringnullable

Example: donationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

accountId stringnullable

Example: account_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

type string

Possible values: [hosted]

hosted

object

Contains additional fields available for hosted Donations.

sessionId string

Donation Session Id

Example: donationsession_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

]

object string
Example: donation
totalResults integer
Example: 33
pageSize integer
Example: 25

_links

object

current string

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

next string

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

prev string

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

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

Example: forbidden

title string

Example: Forbidden

message string

Example: Access is denied due to missing scope permissions

Example (from schema)

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

Loading...