API - Fundraising Activity Data

ActivityType - FUNDRAISE

There are two main components of the Fundraise Detail:

  • The meta-data of the donation which includes amounts, recurring detail, status, and other information
  • The individual transactions of the intent - which would include transactions for recurring donations, refunds, and cancellations

In addition to the Base Detail, the following will be returned: 

FieldDescriptionDetail
donationId Unique id of the donation 36 character UUID
totalReceivedAmount Total amount that has been received for this donation.

Decimal

Note that this amount reflect the true captured value of the donation after evaluating all charges and refunds

oneTimeAmount Amount of the one time donation

Decimal

  • This amount will not be updated due to refunds
     
 donationType  Type of donation that was made

Will be either ONE_TIME or RECURRING 

recurringInterval  The interval which subsequent charges will be made Will be either MONTHLY or YEARLY
recurringAmount Amount of the recurring donation charge

Decimal

recurringCount  Number of recurring charges to date  Number 
recurringTransactionId The initial transaction id of the recurring donation  32 characters 
 recurringStart Start date of the recurring transaction ISO_8601 formatted String with a GMT timezone
 recurringEnd End date of the recurring transaction  ISO_8601 formatted String with a GMT timezone
accountType Type of the account used to make the donation Will be either CREDIT_CARD or E_ECHECK
accountNumber Masked account number 32 characters. Only the last 4 readable
accountExpiration Expiration date of the accountNumber ISO_8601 formatted String with a GMT timezone
accountProvider Provider of the account 64 characters
paymentProcessorName Name of the Salsa Engage payment gateway configuration 64 characters
fundName Name of the fund associated with the donation 128 characters
fundGLCode GL code of the fund 32 characters
designation Fund designation 128 characters
dedicationType Type of dedication for this donation

Will be one of:

  • NONE
  • IN_HONOR_OF
  • IN_MEMORY_OF

dedication Details of the dedication Blob of text
notify Details of whom to notify about this donation Blob of text
transactions List of transactions that have occurred for this donation Array of Transaction objects - there will always be at least 1
wasImported Flag to indicate if the donation was imported into Salsa Engage and did not
come in through an activity form 
True or False

 

Transaction Object

FieldDescriptionDetail
transactionId Unique id of the transaction 36 character UUID
relatedTransactionId Id of another transaction

A related transaction ID will exist for charges that have been refunded.
This the relatedTransactionId for a refunded charge will point to the transaction
that represents the refund. Additionally, the  relatedTransactionId on the refund
will like to the charge.

reason Represents the reason for the transaction Will be one of DONATION or EVENT_TICKET
reasonId Id of the item this transaction occurred.

36 character UUID

    • Only applicable if the reason is not DONATION
date Date of the transaction

ISO_8601 formatted String with a GMT timezone

type Type of the transaction

Will be one of

  • CHARGE - funds captured
  • REFUND - funds refunded
  • CANCEL - recurring donation was cancelled
  • COMPLETE - recurring donation completed
amount Amount of the transaction

Decimal

  • Only applicable for types of CHARGE or REFUND
 deductibleAmount  Amount that was configured to be deductible Decimal
 feesPaid Any fees which the supporter chose to pay in addition to the donation Decimal 
 gatewayTransactionId  Transaction Id returned by the payment gateway 32 characters 
gatewayAuthorizationCode   Authorization Id returned by the payment gateway 32 characters

    

One Time Donation Example

{
 "header":{"processingTime":34,"serverId":"serverId"},
 "payload":{"total":1,"offset":0,count="1",
           activities":[
                    {"activityId":"3efeff36-8aa9-42a3-95af-e4f51e60a35d",
                     "activityFormName":"Activity Name",
                     "activityFormId":"a14064a8-2522-4ca8-b5c5-49b91dac2eed",
                     "supporterId":"75d4b7c7-b3b2-4977-9b39-1036cf7a7798",
                     "activityDate":"2016-05-26T13:41:13.558Z",
                     "activityType":"FUNDRAISE",
                     "lastModified":"2016-05-26T13:41:13.559Z",
                     "donationId":"42513445-0c00-4a2b-b391-6dd0cac7243b",
                     "totalReceivedAmount":20.00,
                     "oneTimeAmount":20.0,
                     "donationType":"ONE_TIME",
                     "accountType":"CREDIT_CARD",
                     "accountNumber":"xxxxxxxxxxxx1111",
                     "accountExpiration":"2016-05-26T04:00:00.000Z",
                     "accountProvider":"Visa",
                     "paymentProcessorName":"processor name",
                     "fundName":"fund name",
                     "fundGLCode":"598c",
                     "designation":"Lighting",
                     "dedicationType":"IN_HONOR_OF",
                     "dedication":"dedication",
                     "notify":"notify",
                     "transactions":[{
                              "transactionId":"1d604c86-f703-4a5c-801a-41de6c3d36aa",
                              "type":"CHARGE",
                              "reason":"DONATION",
                              "date":"2016-05-26T13:41:13.563Z",
                              "amount":20.0,"deductibleAmount":20.0,
                              "feesPaid":0.0,
                              "gatewayTransactionId":"8375290456","gatewayAuthorizationCode":"AUTH"}]
               }
         ]
     }
  }

 

Recurring Donation Example

{
 "header":{"processingTime":34,"serverId":"serverId"},
 "payload":{"total":1,"offset":0,count="1",
           activities":[
                    {"activityId":"3efeff36-8aa9-42a3-95af-e4f51e60a35d",
                     "activityFormName":"Activity Name",
                     "activityFormId":"a14064a8-2522-4ca8-b5c5-49b91dac2eed",
                     "supporterId":"75d4b7c7-b3b2-4977-9b39-1036cf7a7798",
                     "activityDate":"2016-05-26T13:41:13.558Z",
                     "activityType":"FUNDRAISE",
                     "lastModified":"2016-05-26T13:41:13.559Z",
                     "donationId":"42513445-0c00-4a2b-b391-6dd0cac7243b",
                     "totalReceivedAmount":20.00,
                     "recurringAmount":20.0,
                     "donationType":"RECURRING",
                     "recurringInterval":"MONTHLY",
                     "recurringCount":2,
                     "recurringTransactionId":"8375290456",
                     "recurringStart":"2016-05-26T04:00:00.000Z",
                     "recurringEnd":"2016-08-26T04:00:00.000Z",
                     "accountType":"CREDIT_CARD",
                     "accountNumber":"xxxxxxxxxxxx1111",
                     "accountExpiration":"2016-05-26T04:00:00.000Z",
                     "accountProvider":"Visa",
                     "paymentProcessorName":"processor name",
                     "fundName":"fund name",
                     "fundGLCode":"598c",
                     "designation":"Lighting",
                     "dedicationType":"IN_HONOR_OF",
                     "dedication":"dedication",
                     "notify":"notify",
                     "transactions":[{
                              "transactionId":"1d604c86-f703-4a5c-801a-41de6c3d36aa",
                              "type":"CHARGE",
                              "reason":"DONATION",
                              "date":"2016-05-26T13:41:13.563Z",
                              "amount":20.0,"deductibleAmount":20.0,
                              "feesPaid":0.0,
                              "gatewayTransactionId":"8375290456","gatewayAuthorizationCode":"AUTH"}]
               }
         ]
     }
  }
Have more questions? Submit a request
Powered by Zendesk