Create a Gift Transaction

POST

/api/v2/Gift/Transaction

POST

/api/v2/Gift/Transaction

curl -X POST https://api.virtuoussoftware.com/api/v2/Gift/Transaction \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "transactionSource": "<string>",
  "transactionId": "<string>",
  "contact": {
    "referenceId": "<string>",
    "id": "<integer>",
    "name": "<string>",
    "type": "<string>",
    "title": "<string>",
    "firstname": "<string>",
    "middlename": "<string>",
    "lastname": "<string>",
    "suffix": "<string>",
    "birthMonth": "<string>",
    "birthDay": "<string>",
    "birthYear": "<string>",
    "gender": "<string>",
    "emailType": "<string>",
    "email": "<string>",
    "phoneType": "<string>",
    "phone": "<string>",
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal": "<string>",
      "country": "<string>"
    },
    "tags": "<string>",
    "emailLists": [
      "<string>",
      "<string>"
    ]
  },
  "giftDate": "<string>",
  "cancelDate": "<string>",
  "giftType": "<string>",
  "amount": "<string>",
  "currencyCode": "<string>",
  "exchangeRate": "<decimal>",
  "frequency": "<string>",
  "recurringGiftTransactionId": "<string>",
  "recurringGiftTransactionUpdate": "<boolean>",
  "pledgeFrequency": "<string>",
  "pledgeTransactionId": "<string>",
  "pledgeExpectedFullfillmentDate": "<string>",
  "batch": "<string>",
  "notes": "<string>",
  "segment": "<string>",
  "mediaOutlet": "<string>",
  "receiptDate": "<string>",
  "receiptSegment": "<string>",
  "cashAccountingCode": "<string>",
  "tribute": "<string>",
  "tributeDedication": {
    "tributeId": "<integer>",
    "tributeType": "<string>",
    "tributeFirstName": "<string>",
    "tributeLastName": "<string>",
    "tributeCity": "<string>",
    "tributeState": "<string>",
    "acknowledgeeIndividualId": "<integer>",
    "acknowledgeeFirstName": "<string>",
    "acknowledgeeLastName": "<string>",
    "acknowledgeeAddress": "<string>",
    "acknowledgeeCity": "<string>",
    "acknowledgeeState": "<string>",
    "acknowledgeePostal": "<string>",
    "acknowledgeeEmail": "<string>",
    "acknowledgeePhone": "<string>"
  },
  "isPrivate": "<boolean>",
  "isTaxDeductible": "<boolean>",
  "checkNumber": "<string>",
  "creditCardType": "<string>",
  "nonCashGiftTypeId": "<integer>",
  "nonCashGiftType": "<string>",
  "nonCashGiftDescription": "<string>",
  "stockTickerSymbol": "<string>",
  "stockNumberOfShares": "<integer>",
  "iraCustodian": "<string>",
  "submissionUrl": "<string>",
  "designations": [
    {
      "id": "<integer>",
      "name": "<string>",
      "code": "<string>",
      "amountDesignated": "<string>"
    },
    {
      "id": "<integer>",
      "name": "<string>",
      "code": "<string>",
      "amountDesignated": "<string>"
    }
  ],
  "premiums": [
    {
      "id": "<integer>",
      "name": "<string>",
      "code": "<string>",
      "quantity": "<string>"
    },
    {
      "id": "<integer>",
      "name": "<string>",
      "code": "<string>",
      "quantity": "<string>"
    }
  ],
  "customFields": {
    "fieldName": "fieldValue",
    "fieldName2": "fieldValue2"
  },
  "customObjects": [
    {
      "name": "<string>",
      "fields": [
        {
          "name": "<string>",
          "value": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    },
    {
      "name": "<string>",
      "fields": [
        {
          "name": "<string>",
          "value": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "contactIndividualId": "<integer>",
  "passthroughContact": {
    "referenceId": "<string>",
    "id": "<integer>",
    "name": "<string>",
    "type": "<string>",
    "title": "<string>",
    "firstname": "<string>",
    "middlename": "<string>",
    "lastname": "<string>",
    "suffix": "<string>",
    "birthMonth": "<string>",
    "birthDay": "<string>",
    "birthYear": "<string>",
    "gender": "<string>",
    "emailType": "<string>",
    "email": "<string>",
    "phoneType": "<string>",
    "phone": "<string>",
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal": "<string>",
      "country": "<string>"
    },
    "tags": "<string>",
    "emailLists": [
      "<string>",
      "<string>"
    ]
  },
  "eventAttendee": {
    "eventId": "<integer>",
    "eventName": "<string>",
    "invited": "<boolean>",
    "rsvp": "<boolean>",
    "rsvpResponse": "<boolean>",
    "attended": "<boolean>"
  }
}'

200Successful

{}

HMAC or OAuth Auth valid. This is the recommended way to create a gift. This ensures the gift is matched using the Virtuous matching algorithms for Contacts, Recurring gifts, Designations, etc.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

transactionSourcestringOptional

transactionIdstringOptional

contactobjectOptional

giftDatestringOptional

cancelDatestringOptional

giftTypestringOptional

amountstringOptional

currencyCodestringOptional

exchangeRatestringOptional

frequencystringOptional

recurringGiftTransactionIdstringOptional

recurringGiftTransactionUpdatestringOptional

pledgeFrequencystringOptional

pledgeTransactionIdstringOptional

pledgeExpectedFullfillmentDatestringOptional

batchstringOptional

notesstringOptional

segmentstringOptional

mediaOutletstringOptional

receiptDatestringOptional

receiptSegmentstringOptional

cashAccountingCodestringOptional

tributestringOptional

tributeDedicationobjectOptional

isPrivatestringOptional

isTaxDeductiblestringOptional

checkNumberstringOptional

creditCardTypestringOptional

nonCashGiftTypeIdstringOptional

nonCashGiftTypestringOptional

nonCashGiftDescriptionstringOptional

stockTickerSymbolstringOptional

stockNumberOfSharesstringOptional

iraCustodianstringOptional

submissionUrlstringOptional

designationslist of objectsOptional

premiumslist of objectsOptional

customFieldsobjectOptional

customObjectslist of objectsOptional

contactIndividualIdstringOptional

passthroughContactobjectOptional

eventAttendeeobjectOptional