Get a gift by its ID.

GET

https://prod-api.raisedonors.com/api/Gift/:id

GET

/api/Gift/:id

curl https://prod-api.raisedonors.com/api/Gift/1 \
     -H "Authorization: <apiKey>"

{
  "id": 1,
  "currency": "string",
  "amount": 1.1,
  "formattedAmount": "string",
  "date": "string",
  "createdDate": "string",
  "modifiedDate": "string",
  "status": 0,
  "statusText": "string",
  "gateway": "string",
  "authorizationNumber": "string",
  "transactionId": "string",
  "donationId": "string",
  "paymentInfo": "string",
  "paymentType": "string",
  "segment": "string",
  "motivation": "string",
  "campaignName": "string",
  "segmentName": "string",
  "notes": "string",
  "comment": "string",
  "donorId": 1,
  "billingName": "string",
  "shippingName": "string",
  "recurringGiftId": 1,
  "giftAidRequested": true,
  "canRefund": true,
  "donorPaidCosts": true,
  "paymentProviderTransactionUrl": "string",
  "submissionUrl": "string",
  "billingAddress": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "postal": "string",
    "countryString": "string",
    "addressType": 0,
    "addressTypeDisplay": "string"
  },
  "shippingAddress": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "postal": "string",
    "countryString": "string",
    "addressType": 0,
    "addressTypeDisplay": "string"
  },
  "projects": [
    {
      "projectId": 1,
      "name": "string",
      "amount": "string",
      "currencyExchange": {
        "nativeAmount": "string",
        "nativeCurrencyCode": "string",
        "settledExchangeRate": 1.1,
        "settledAmount": "string",
        "settledCurrencyCode": "string",
        "baseExchangeRate": 1.1,
        "baseAmount": "string",
        "baseCurrencyCode": "string",
        "isDifferentCurrency": true
      }
    }
  ],
  "browserInfo": {
    "name": "string",
    "version": "string",
    "platform": "string",
    "userAgent": "string",
    "javaScriptVersion": "string",
    "isBeta": true,
    "isCrawler": true,
    "supportsCookies": true,
    "supportsJavaApplets": true,
    "supportsActiveXControls": true
  },
  "premiumItem": {
    "qualifies": true,
    "premium": {
      "id": 1,
      "currency": "string",
      "name": "string",
      "nameShort": "string",
      "code": "string",
      "description": "string",
      "isActive": true,
      "price": 1.1,
      "formattedPrice": "string",
      "fairMarketValue": 1.1,
      "formattedFairMarketValue": "string",
      "inventory": 1,
      "keepActiveWhenHasNoInventory": true,
      "recurringPremiumId": 1,
      "recurringPremiumName": "string",
      "image": "string",
      "externalIdentifier": "string",
      "otherMinimumAmounts": [
        {
          "currency": "string",
          "value": 1.1
        }
      ]
    }
  },
  "form": {
    "id": 1,
    "title": "string",
    "landingUrl": "string",
    "referringUrl": "string",
    "isLegacy": true
  },
  "donorStatistic": {
    "totalGift": "string",
    "totalGiftAmount": "string",
    "lastGift": {
      "id": 1,
      "date": "string",
      "amount": "string",
      "paymentInfo": "string",
      "donorId": 1,
      "donorImage": "string",
      "donorName": "string",
      "donorEmail": "string",
      "form": "string",
      "projects": [
        {
          "projectId": 1,
          "name": "string",
          "amount": "string",
          "currencyExchange": {
            "nativeAmount": "string",
            "nativeCurrencyCode": "string",
            "settledExchangeRate": 1.1,
            "settledAmount": "string",
            "settledCurrencyCode": "string",
            "baseExchangeRate": 1.1,
            "baseAmount": "string",
            "baseCurrencyCode": "string",
            "isDifferentCurrency": true
          }
        }
      ],
      "status": 0,
      "statusText": "string",
      "donorIsGDPRDeleted": true,
      "isAnonymous": true,
      "canRefund": true,
      "transactionId": "string",
      "isTribute": true,
      "isFromTerminal": true,
      "donorPaidCosts": true,
      "metadata": [
        "string"
      ],
      "segmentCode": "string",
      "currencyExchange": {
        "nativeAmount": "string",
        "nativeCurrencyCode": "string",
        "settledExchangeRate": 1.1,
        "settledAmount": "string",
        "settledCurrencyCode": "string",
        "baseExchangeRate": 1.1,
        "baseAmount": "string",
        "baseCurrencyCode": "string",
        "isDifferentCurrency": true
      }
    },
    "lastGiftAmount": "string"
  },
  "recurringScheduleInfo": {
    "amount": "string",
    "currencyCode": "string",
    "frequency": "string",
    "status": 1,
    "statusText": "string",
    "successfulCycles": 1,
    "startDate": "string",
    "nextCharge": "string",
    "currentCharge": "string",
    "previousCharge": "string",
    "currencyExchange": {
      "nativeAmount": "string",
      "nativeCurrencyCode": "string",
      "settledExchangeRate": 1.1,
      "settledAmount": "string",
      "settledCurrencyCode": "string",
      "baseExchangeRate": 1.1,
      "baseAmount": "string",
      "baseCurrencyCode": "string",
      "isDifferentCurrency": true
    }
  },
  "tribute": {
    "isInMemoryOf": true,
    "isInHonorOf": true,
    "sendByEmail": true,
    "sendByPostal": true,
    "tributeFirstName": "string",
    "tributeLastName": "string",
    "tributeAddress": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "countryString": "string",
      "addressType": 0,
      "addressTypeDisplay": "string"
    },
    "acknowledgeeFirstName": "string",
    "acknowledgeeLastName": "string",
    "acknowledgeeAddress": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "countryString": "string",
      "addressType": 0,
      "addressTypeDisplay": "string"
    },
    "acknowledgeeEmailAddress": "string",
    "message": "string"
  },
  "donor": {
    "id": 1,
    "name": "string",
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "suffix": "string",
    "email": "string",
    "phone": "string",
    "createdDate": "string",
    "modifiedDate": "string",
    "notes": "string",
    "isOrganization": true,
    "organizationName": "string",
    "crmKeyUrls": {},
    "crmKey": "string",
    "crmSecondKey": "string",
    "isTestMode": true,
    "isArchived": true,
    "isGDPRDeleted": true,
    "primaryAddress": {
      "address1": "string",
      "address2": "string",
      "addressType": 0,
      "addressTypeDisplay": "string",
      "city": "string",
      "countryString": "string",
      "donorId": 1,
      "id": 1,
      "isPrimary": true,
      "postal": "string",
      "state": "string"
    },
    "donorAddresses": [
      {
        "address1": "string",
        "address2": "string",
        "addressType": 0,
        "addressTypeDisplay": "string",
        "city": "string",
        "countryString": "string",
        "donorId": 1,
        "id": 1,
        "isPrimary": true,
        "postal": "string",
        "state": "string"
      }
    ],
    "donorEmailAddresses": [
      {
        "id": 1,
        "donorId": 1,
        "type": 0,
        "typeDisplay": "string",
        "value": "string",
        "secondaryValue": "string",
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": true,
        "isBounced": true,
        "countryCode": "string"
      }
    ],
    "donorPhoneNumbers": [
      {
        "id": 1,
        "donorId": 1,
        "type": 0,
        "typeDisplay": "string",
        "value": "string",
        "secondaryValue": "string",
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": true,
        "isBounced": true,
        "countryCode": "string"
      }
    ]
  },
  "isAnonymous": true,
  "isTestMode": true,
  "virtualTerminalId": 1,
  "virtualTerminal": "string",
  "googleUtmCampaign": "string",
  "googleUtmContent": "string",
  "googleUtmMedium": "string",
  "googleUtmSource": "string",
  "googleUtmTerm": "string",
  "googleUtmId": "string",
  "googleGclid": "string",
  "motivationCodeGroupId": 1,
  "motivationCodeGroupName": "string",
  "motivationCodeId": 1,
  "motivationCodeName": "string",
  "currencyExchange": {
    "nativeAmount": "string",
    "nativeCurrencyCode": "string",
    "settledExchangeRate": 1.1,
    "settledAmount": "string",
    "settledCurrencyCode": "string",
    "baseExchangeRate": 1.1,
    "baseAmount": "string",
    "baseCurrencyCode": "string",
    "isDifferentCurrency": true
  }
}

Authentication

Authorizationstring

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

Path parameters

idlongRequired

The ID of the gift.

Response

idlongOptional

Gets or sets the unique identifier of the gift.

currencystring or nullOptional

Gets or sets the currency format for the gift amount.

amountdoubleOptional

Gets or sets the amount of the gift.

formattedAmountstring or nullOptionalRead-only

Gets the formatted amount of the gift in the specified currency.

datestring or nullOptional

Gets or sets the date of the gift in local timezone.

createdDatestring or nullOptional

Gets or sets the created date of the gift in local timezone.

modifiedDatestring or nullOptional

Gets or sets the modified date of the gift in local timezone.

statusenumOptional

Gets or sets the status of the gift.

statusTextstring or nullOptional

Gets or sets the display text for the gift's status.

gatewaystring or nullOptional

Gets or sets the internal display name of the payment gateway.

authorizationNumberstring or nullOptional

Gets or sets the authorization number for the gift transaction.

transactionIdstring or nullOptional

Gets or sets the transaction ID of the gift.

donationIdstring or nullOptional

Gets or sets the donation ID associated with the gift.

paymentInfostring or nullOptional

Gets or sets the payment information of the gift.

paymentTypestring or nullOptional

Gets or sets the payment type of the gift.

segmentstring or nullOptional

Gets or sets the segment code associated with the gift.

motivationstring or nullOptional

Gets or sets the motivation for the gift.

campaignNamestring or nullOptional

Gets or sets the campaign name associated with the gift.

segmentNamestring or nullOptional

Gets or sets the segment name associated with the gift.

notesstring or nullOptional

Gets or sets the notes associated with the gift.

commentstring or nullOptional

Gets or sets the comment associated with the gift.

donorIdlongOptional

Gets or sets the unique identifier of the donor.

billingNamestring or nullOptional

Gets or sets the billing name for the gift.

shippingNamestring or nullOptional

Gets or sets the shipping name for the gift.

recurringGiftIdlong or nullOptional

Gets or sets the recurring gift ID, if applicable.

giftAidRequestedbooleanOptional

Gets or sets a value indicating whether gift aid was requested.

canRefundbooleanOptional

Gets or sets a value indicating whether the gift can be refunded.

donorPaidCostsbooleanOptional

Gets or sets a value indicating whether the donor paid the processing costs.

paymentProviderTransactionUrlstring or nullOptional

Gets or sets the URL for the payment provider transaction.

submissionUrlstring or nullOptional

Gets or sets the Submission URL.

billingAddressobject or nullOptional

Gets or sets the billing address associated with the gift.

shippingAddressobject or nullOptional

Gets or sets the shipping address associated with the gift.

projectslist of objects or nullOptional

Gets or sets the list of project allocations associated with the gift.

browserInfoobject or nullOptional

Gets or sets the browser information associated with the gift.

premiumItemobject or nullOptional

Gets or sets the premium item associated with the gift, if applicable.

formobject or nullOptional

Gets or sets the form details associated with the gift.

donorStatisticobject or nullOptional

Gets or sets the donor statistics associated with the gift.

recurringScheduleInfoobject or nullOptional

Gets or sets the recurring schedule information for the gift, if applicable.

tributeobject or nullOptional

Gets or sets the tribute information associated with the gift, if applicable.

donorobject or nullOptional

Gets or sets the donor details associated with the gift.

isAnonymousbooleanOptional

Gets or sets a value indicating whether the gift is anonymous.

isTestModebooleanOptional

Gets or sets a value indicating whether the gift is in test mode.

virtualTerminalIdlong or nullOptional

Gets or sets the virtual terminal ID associated with the gift, if applicable.

virtualTerminalstring or nullOptional

Gets or sets the virtual terminal name associated with the gift, if applicable.

googleUtmCampaignstring or nullOptional

Gets or sets the Google UTM campaign associated with the gift.

googleUtmContentstring or nullOptional

Gets or sets the Google UTM content associated with the gift.

googleUtmMediumstring or nullOptional

Gets or sets the Google UTM medium associated with the gift.

googleUtmSourcestring or nullOptional

Gets or sets the Google UTM source associated with the gift.

googleUtmTermstring or nullOptional

Gets or sets the Google UTM term associated with the gift.

googleUtmIdstring or nullOptional

Gets or sets the Google UTM ID associated with the gift.

googleGclidstring or nullOptional

Gets or sets the Google GCLID associated with the gift.

motivationCodeGroupIdlong or nullOptional

Gets or sets the motivation code group ID associated with the gift.

motivationCodeGroupNamestring or nullOptional

Gets or sets the motivation code group name associated with the gift.

motivationCodeIdlong or nullOptional

Gets or sets the motivation code ID associated with the gift.

motivationCodeNamestring or nullOptional

Gets or sets the motivation code name associated with the gift.

currencyExchangeobject or nullOptional

Gets or sets the currency exchange information for the gift.

Errors

404

Not Found Error