Skip to main content

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​

Successfully listed Donations

Schema

    data

    object[]

  • Array [

    • anyOf

    idstring
    Example: donation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    userIdstringnullable
    organisationIdstringnullable
    amountinteger

    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
    currencyCodestring

    Three-letter ISO currency code

    Example: AUD
    createdAtdate-time
    Example: 2020-10-13T17:46:54.000Z
    statusstring

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

    firstNamestringnullable

    Users first name.

    lastNamestringnullable

    Users last name.

    emailstringnullable

    Users email.

    consentedToBeContactedstringnullable

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

    Possible values: [yes, no]

    anonymousstringnullable

    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
    giftAidIdstringnullable
    cancelledAtdate-timenullable
    Example: 2020-10-13T17:46:54.000Z
    donationRequestIdstringnullable
    Example: donationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    accountIdstringnullable
    Example: account_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    typestring

    Possible values: [direct]

  • ]

    • objectstring
    Example: donation
    totalResultsinteger
    Example: 33
    pageSizeinteger
    Example: 25

    _links

    object

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