Retrieve a Donation

GET 
/v1/donations/:id

Retrieve a donation by its ID.

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

Request

Path Parameters

id integerrequired

Id of the Donation.

Responses

200

Successfully retrieves a Donation

application/json

Schema

Schema

data

object

oneOf

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

Example (from schema)

{
  "data": {},
  "object": "donation"
}

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"
  }
}

404

The specified resource was not found

application/json

Schema

Schema

error

object

code string

Example: not_found

title string

Example: Resource not found

message string

Example: This endpoint is unavailable or can not be found

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}

Loading...