API Reference

Get donation items in scroll manner

This API is used to display donation information (names & donation value) on the Scrolling View page.

Path Parameters Not Required

Body Parameters
Not Required

Authentication required - ❌

Modules Host - ✅ Portal - ❌
 Display - ❌

Here is the description of response attributes, which returns to the form of JSON.

items

An array of details which including:

  • donorName
  • textToGiveAmount
  • note
  • recurring

showDonorName

This represents the name of the donor & if it will be displayed. If "true" then donor name will be displayed, if "false" it will not.

currencySymbol

This represents the currency that transactions within the event will use.

totalFundRaised

This represents the total value of the funds raised by the Text to Give fundraising module.

goalAmount

This represents the total expected amount of money raised by the Text to Give fundraising module.

numberOfDonors

This represents the total number of donors who have participated in the Text to Give fundraising module.

recurringEnabled

This represents whether the donation will be repeated on a monthly basis. If "true" the donation is recurring, if not "false"

showTotalFundRaised

This represents whether the total funds raised by the Text to Give fundraising module will be visible on the Scrolling View page. If "true" then total funds raised will be displayed, if "false" then they will not.

hideDonationGoal

This represents whether the donation goal of the Text to Give fundraising module will be visible on the Scrolling View page. If "true" then the goal will be displayed, if "false" then it will not.

Language
Credentials
Header
Click Try It! to start a request and see the response here!