POST api/Donate
Processes and bills a donation.
Request Information
URI Parameters
None.
Body Parameters
DonationRequestName | Description | Type | Additional information |
---|---|---|---|
SessionKey | string |
Required |
|
DonationFundId | integer |
Required |
|
DonationAmount | decimal number |
Required |
|
TributeType | string | ||
TributeName | string | ||
NotificationFirstName | string | ||
NotificationLastName | string | ||
NotificationAddress1 | string | ||
NotificationAddress2 | string | ||
NotificationCity | string | ||
NotificationStateId |
Two letter state value from CountriesStates method |
string | |
NotificationCountryId | integer | ||
NotificationPostalCode | string | ||
FirstName | string | ||
LastName | string | ||
Address1 | string | ||
Address2 | string | ||
City | string | ||
StateId |
Two letter state value from CountriesStates method |
string | |
CountryId | integer | ||
PostalCode | string | ||
CreditCardNumber | string |
Required |
|
CreditCardType |
Tessitura credit card Id value |
integer |
Required |
CreditCardName |
Name on credit card |
string |
Required |
CreditCardCVV | string |
Required |
|
CreditCardExpirationMonth | integer |
Required Range: inclusive between 1 and 12 |
|
CreditCardExpirationYear | integer |
Required |
|
StoredCreditCardId | integer | ||
SourceId |
For optional source id that will be used for the membership purchase session |
integer |
Request Formats
application/json, text/json
Sample:
{ "SessionKey": "sample string 1", "DonationFundId": 2, "DonationAmount": 3.0, "TributeType": "sample string 4", "TributeName": "sample string 5", "NotificationFirstName": "sample string 6", "NotificationLastName": "sample string 7", "NotificationAddress1": "sample string 8", "NotificationAddress2": "sample string 9", "NotificationCity": "sample string 10", "NotificationStateId": "sample string 11", "NotificationCountryId": 12, "NotificationPostalCode": "sample string 13", "FirstName": "sample string 14", "LastName": "sample string 15", "Address1": "sample string 16", "Address2": "sample string 17", "City": "sample string 18", "StateId": "sample string 19", "CountryId": 20, "PostalCode": "sample string 21", "CreditCardNumber": "sample string 22", "CreditCardType": 23, "CreditCardName": "sample string 24", "CreditCardCVV": "sample string 25", "CreditCardExpirationMonth": 26, "CreditCardExpirationYear": 27, "StoredCreditCardId": 28, "SourceId": 29 }
application/xml, text/xml
Sample:
<DonationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution"> <Address1>sample string 16</Address1> <Address2>sample string 17</Address2> <City>sample string 18</City> <CountryId>20</CountryId> <CreditCardCVV>sample string 25</CreditCardCVV> <CreditCardExpirationMonth>26</CreditCardExpirationMonth> <CreditCardExpirationYear>27</CreditCardExpirationYear> <CreditCardName>sample string 24</CreditCardName> <CreditCardNumber>sample string 22</CreditCardNumber> <CreditCardType>23</CreditCardType> <FirstName>sample string 14</FirstName> <LastName>sample string 15</LastName> <PostalCode>sample string 21</PostalCode> <SourceId>29</SourceId> <StateId>sample string 19</StateId> <StoredCreditCardId>28</StoredCreditCardId> <DonationAmount>3</DonationAmount> <DonationFundId>2</DonationFundId> <NotificationAddress1>sample string 8</NotificationAddress1> <NotificationAddress2>sample string 9</NotificationAddress2> <NotificationCity>sample string 10</NotificationCity> <NotificationCountryId>12</NotificationCountryId> <NotificationFirstName>sample string 6</NotificationFirstName> <NotificationLastName>sample string 7</NotificationLastName> <NotificationPostalCode>sample string 13</NotificationPostalCode> <NotificationStateId>sample string 11</NotificationStateId> <SessionKey>sample string 1</SessionKey> <TributeName>sample string 5</TributeName> <TributeType>sample string 4</TributeType> </DonationRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DonationResult object
ApiSuccessOfDonationResultName | Description | Type | Additional information |
---|---|---|---|
Success | boolean | ||
Data | DonationResult |
Response Formats
application/json
Sample:
{ "Success": true, "Data": { "DonationAdded": true, "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 4, "PrimaryAddressError": true, "NewSessionKey": "vq+2LeXNhVYL24blgarGvV8yHYf3PnKJEWdY6qAxQydCohIci28wYfJw+hHwa1+5feFGr75glBeEotHUBJrES2aD6UVPixMhf/4j4yx6VjU=", "Error": [ "sample string 1", "sample string 2" ] } }
text/json
Sample:
{ "Success": true, "Data": { "DonationAdded": true, "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 4, "PrimaryAddressError": true, "NewSessionKey": "PyFg1A872T7LMtWZXSdeM224dfaJLqOCkPRug1pn+mqx+Q2PRQBFYi+t5wJwKUo5+uNY5MRKRvOwj5kF8nG1ye7mMe5G2qLqR04IhfUmMrg=", "Error": [ "sample string 1", "sample string 2" ] } }
application/xml, text/xml
Sample:
<ApiSuccessOfDonationResultyx5QZ_PAX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution"> <Error xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Error> <NewSessionKey xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 6</NewSessionKey> <OrderEmailSent xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</OrderEmailSent> <OrderNumber xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">4</OrderNumber> <PrimaryAddressError xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PrimaryAddressError> <PurchaseCompleted xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PurchaseCompleted> <d2p1:DonationAdded>true</d2p1:DonationAdded> </Data> </ApiSuccessOfDonationResultyx5QZ_PAX>