Skip to main content
GET
Get a Gift
The response covers the amount and currency, the charge status and statusText, the gateway and its transactionId and authorizationNumber, the projects the gift is split across, the campaign, segment, and motivation code it came in under, the tribute and premium attached to it, its billing and shipping addresses, and the donor who gave it. canRefund tells you whether Refund a Gift can be used.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

id
integer<int64>
required

The ID of the gift.

Response

OK

Represents a detailed model for a gift, including donor, payment, and project information.

id
integer<int64>

The unique identifier of the gift.

currency
string | null

The currency format for the gift amount.

amount
number<double>

The amount of the gift.

formattedAmount
string | null
read-only

The formatted amount of the gift in the specified currency.

date
string | null

The date of the gift in local timezone.

createdDate
string | null

The created date of the gift in local timezone.

modifiedDate
string | null

The modified date of the gift in local timezone.

status
enum<integer>

The status of the gift.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
statusText
string | null

The display text for the gift's status.

gateway
string | null

The internal display name of the payment gateway.

authorizationNumber
string | null

The authorization number for the gift transaction.

transactionId
string | null

The transaction ID of the gift.

donationId
string | null

The donation ID associated with the gift.

paymentInfo
string | null

The payment information of the gift.

paymentType
string | null

The payment type of the gift.

segment
string | null

The segment code associated with the gift.

motivation
string | null

The motivation for the gift.

campaignName
string | null

The campaign name associated with the gift.

segmentName
string | null

The segment name associated with the gift.

notes
string | null

The notes associated with the gift.

comment
string | null

The comment associated with the gift.

donorId
integer<int64>

The unique identifier of the donor.

billingName
string | null

The billing name for the gift.

shippingName
string | null

The shipping name for the gift.

recurringGiftId
integer<int64> | null

The recurring gift ID, if applicable.

giftAidRequested
boolean

Whether gift aid was requested.

canRefund
boolean

Whether the gift can be refunded.

donorPaidCosts
boolean

Whether the donor paid the processing costs.

paymentProviderTransactionUrl
string | null

The URL for the payment provider transaction.

submissionUrl
string | null

The URL the gift was submitted from.

billingAddress
object

The billing address associated with the gift.

shippingAddress
object

The shipping address associated with the gift.

projects
object[] | null

The list of project allocations associated with the gift.

browserInfo
object | null

The browser information associated with the gift.

premiumItem
object | null

The premium item associated with the gift, if applicable.

form
object | null

The form details associated with the gift.

donorStatistic
object | null

The donor statistics associated with the gift.

recurringScheduleInfo
object | null

The recurring schedule information for the gift, if applicable.

tribute
object | null

The tribute information associated with the gift, if applicable.

donor
object | null

The donor details associated with the gift.

isAnonymous
boolean

Whether the gift was given anonymously.

isTestMode
boolean

Whether the gift is in test mode.

virtualTerminalId
integer<int64> | null

The virtual terminal ID associated with the gift, if applicable.

virtualTerminal
string | null

The virtual terminal name associated with the gift, if applicable.

googleUtmCampaign
string | null

The Google UTM campaign associated with the gift.

googleUtmContent
string | null

The Google UTM content associated with the gift.

googleUtmMedium
string | null

The Google UTM medium associated with the gift.

googleUtmSource
string | null

The Google UTM source associated with the gift.

googleUtmTerm
string | null

The Google UTM term associated with the gift.

googleUtmId
string | null

The Google UTM ID associated with the gift.

googleGclid
string | null

The Google GCLID associated with the gift.

motivationCodeGroupId
integer<int64> | null

The motivation code group ID associated with the gift.

motivationCodeGroupName
string | null

The motivation code group name associated with the gift.

motivationCodeId
integer<int64> | null

The motivation code ID associated with the gift.

motivationCodeName
string | null

The motivation code name associated with the gift.

currencyExchange
object | null

The currency exchange information for the gift.

Last modified on July 28, 2026