POST api/FinalizeDonateSimple
Processes and bills a donation.
Request Information
URI Parameters
None.
Body Parameters
FinalizeDonationSimpleRequestName | Description | Type | Additional information |
---|---|---|---|
PurchaseSessionKey | string |
Required |
|
AuthenticationSessionKey | string |
Required |
|
TransactionAmount | decimal number | ||
CreditCardNumber | string | ||
CreditCardName |
Name on credit card |
string | |
CreditCardCVV | string | ||
CreditCardExpirationMonth | integer |
Range: inclusive between 1 and 12 |
|
CreditCardExpirationYear | integer | ||
SourceId |
For optional source id that will be used for the membership purchase session |
integer | |
PaymentId | integer |
Required |
|
CreditCardType | integer |
Required |
|
AuthorizationCode | string |
Required |
|
PaymentReference | string |
Required |
|
AccountId | integer |
Required |
Request Formats
application/json, text/json
Sample:
{ "PurchaseSessionKey": "sample string 1", "AuthenticationSessionKey": "sample string 2", "TransactionAmount": 3.0, "CreditCardNumber": "sample string 4", "CreditCardName": "sample string 5", "CreditCardCVV": "sample string 6", "CreditCardExpirationMonth": 7, "CreditCardExpirationYear": 8, "SourceId": 9, "PaymentId": 10, "CreditCardType": 11, "AuthorizationCode": "sample string 12", "PaymentReference": "sample string 13", "AccountId": 14 }
application/xml, text/xml
Sample:
<FinalizeDonationSimpleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution"> <AccountId>14</AccountId> <AuthenticationSessionKey>sample string 2</AuthenticationSessionKey> <AuthorizationCode>sample string 12</AuthorizationCode> <CreditCardCVV>sample string 6</CreditCardCVV> <CreditCardExpirationMonth>7</CreditCardExpirationMonth> <CreditCardExpirationYear>8</CreditCardExpirationYear> <CreditCardName>sample string 5</CreditCardName> <CreditCardNumber>sample string 4</CreditCardNumber> <CreditCardType>11</CreditCardType> <PaymentId>10</PaymentId> <PaymentReference>sample string 13</PaymentReference> <PurchaseSessionKey>sample string 1</PurchaseSessionKey> <SourceId>9</SourceId> <TransactionAmount>3</TransactionAmount> </FinalizeDonationSimpleRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DonationResult object
ApiSuccessOfDonationSimpleResultName | Description | Type | Additional information |
---|---|---|---|
Success | boolean | ||
Data | DonationSimpleResult |
Response Formats
application/json
Sample:
{ "Success": true, "Data": { "SessionKey": "Zvvs8h3ERB/C4WvwAO2Hp4LaDdYDxY8IoV/OfMX2e9SFtpHdnKYsYuS3tbJwF9hOPwOXV/P+eeRGPrjr7N+/aXCq0lSKNa1tTq1NEk/xQWM=", "DonationAdded": true, "AccountRegistered": true, "DonationPurchaseSessionKey": "WKtDaFy5/CHFSEwwnrOo+jRrx3y3M4mqs+bUjZm7xQmUqOvn990tg+2Lh2UgI5BjzZNqie5ONx94SyeNTVcHhmgr6mK5Q0uBgJyVueWcpwk=", "TotalAmountAddedToCart": 5.0, "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 8, "PrimaryAddressError": true, "NewSessionKey": "3wyix7AHsG4XK9W+GbnGj/SdzQZ3jp1ROtrgRZ5SjMnqWVKv0fTm2QrcW8gmjQOokkFj5euHEbNJyNegKK+iCcdF6oBU1GuFxiKUhXANffSDsRmKvAcjoZ47EJhiHCkd", "Error": [ "sample string 1", "sample string 2" ], "Status": "sample string 11", "Message": "sample string 12" } }
text/json
Sample:
{ "Success": true, "Data": { "SessionKey": "8Rt2TyUJ+5dqfkxUsFuP+5W0i9vFOY6BLAzjZsRJL07VjYN7b0fYp/f5u6l9u9UC8VpqKRa/cANa7gAaOBoYySj8kCC/L/M58znoSyPAJ28=", "DonationAdded": true, "AccountRegistered": true, "DonationPurchaseSessionKey": "HK5X3NW5Yjxx8WLLJ0hzAgOPdy1JBiiYQyedGZsgCkzftGjFqYPsAF5Jmkb/C/chZQ/h3UU2/CnZkvs2sy+uD8bS2eXuYyfG63yJVwLuHE8=", "TotalAmountAddedToCart": 5.0, "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 8, "PrimaryAddressError": true, "NewSessionKey": "ntjtbXg32P7MHt9+MlU2Rhp5S2b8giaGfRQwFnVWKMjIidrcqvHR23Jh9M1tdSieIgLhiUuhuWZSR3bFDEFJB/WRJ9sVFwhRCYXNhmyhLj2fK7IrKscTGQy2wuL0rYiq", "Error": [ "sample string 1", "sample string 2" ], "Status": "sample string 11", "Message": "sample string 12" } }
application/xml, text/xml
Sample:
<ApiSuccessOfDonationSimpleResultyx5QZ_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> <Message xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 12</Message> <NewSessionKey xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 10</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">8</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> <Status xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 11</Status> <d2p1:AccountRegistered>true</d2p1:AccountRegistered> <d2p1:DonationAdded>true</d2p1:DonationAdded> <d2p1:DonationPurchaseSessionKey>sample string 4</d2p1:DonationPurchaseSessionKey> <d2p1:SessionKey>sample string 1</d2p1:SessionKey> <d2p1:TotalAmountAddedToCart>5</d2p1:TotalAmountAddedToCart> </Data> </ApiSuccessOfDonationSimpleResultyx5QZ_PAX>