Skip to main content

Retrieve a Donation

GET 

/v1/donations/:id

Retrieve a Donation

Request​

Path Parameters

    id integerrequired

    Id of the Donation.

Responses​

Successfully retrieves a Donation

Schema
    data object
    oneOf
    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]

    object string
Loading...