Retrieve a Donation
GET/v1/donations/:id
Retrieve a Donation
Request​
Path Parameters
Id of the Donation.
Responses​
- 200
- 401
- 403
- 404
Successfully retrieves a Donation
- application/json
- Schema
- Example (from schema)
Schema
- direct donation
- hosted donation
data object
Donation amount. A positive integer representing donation amount in the smallest currency unit, for example 100 pence for a donation of £1.00.
Three-letter ISO currency code
Possible values: [ACTIVE
, REQUESTED_PAYMENT
, RECEIVED_PAYMENT
, DISBURSED
, CANCELLED
]
Users first name.
Users last name.
Users email.
Possible values: [yes
, no
]
Whether the user consented to be contacted by the benefitting organisation.
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.
Possible values: [direct
]
Donation amount. A positive integer representing donation amount in the smallest currency unit, for example 100 pence for a donation of £1.00.
Three-letter ISO currency code
Possible values: [ACTIVE
, REQUESTED_PAYMENT
, RECEIVED_PAYMENT
, DISBURSED
, CANCELLED
]
Users first name.
Users last name.
Users email.
Possible values: [yes
, no
]
Whether the user consented to be contacted by the benefitting organisation.
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.
Possible values: [hosted
]
hosted object
Contains additional fields available for hosted Donations.
Donation Session Id
{
"data": {},
"object": "donation"
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}
The specified resource was not found
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "not_found",
"title": "Resource not found",
"message": "This endpoint is unavailable or can not be found"
}
}