Sphere Web Service

Sphere

Click here for a complete list of operations.

MakeSupporterDonation

Make Sphere online donation. Supporter ID and Event ID are required to make online donation in Sphere. Now we support both credit card and online check.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /services/Sphere.asmx HTTP/1.1
Host: www.kintera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.kintera.com/services/MakeSupporterDonation"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <KinteraSoapHeader xmlns="https://www.kintera.com/services/">
      <AccountID>int</AccountID>
      <SecurityToken>string</SecurityToken>
    </KinteraSoapHeader>
  </soap:Header>
  <soap:Body>
    <MakeSupporterDonation xmlns="https://www.kintera.com/services/">
      <request>
        <SupporterID>string</SupporterID>
        <EventID>int</EventID>
        <DonationAmount>decimal</DonationAmount>
        <PaymentType>CreditCard or OnlineCheck</PaymentType>
        <CreditCardInfo>
          <CardNumber>string</CardNumber>
          <CardType>string</CardType>
          <HolderName>string</HolderName>
          <ExpireYear>string</ExpireYear>
          <ExpireMonth>string</ExpireMonth>
          <CVV>string</CVV>
        </CreditCardInfo>
        <OnlineCheckInfo>
          <BankAccountNumber>string</BankAccountNumber>
          <BankID>string</BankID>
          <BankAccountType>string</BankAccountType>
          <BankCustomerName>string</BankCustomerName>
        </OnlineCheckInfo>
        <DonationGift>
          <ID>int</ID>
          <Message>string</Message>
          <Receiver>string</Receiver>
          <ShippingAddress>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Country>string</Country>
            <Province>string</Province>
          </ShippingAddress>
        </DonationGift>
        <DonationFrequency>int</DonationFrequency>
        <DonationTimes>int</DonationTimes>
        <VisitorSource>
          <TypeID>int</TypeID>
          <SourceID>string</SourceID>
          <SourceTitle>string</SourceTitle>
          <SourceUrl>string</SourceUrl>
          <PromotionCode>string</PromotionCode>
        </VisitorSource>
        <SupporterActionID>int</SupporterActionID>
        <IsTest>boolean</IsTest>
      </request>
    </MakeSupporterDonation>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MakeSupporterDonationResponse xmlns="https://www.kintera.com/services/">
      <MakeSupporterDonationResult>
        <PaymentID>int</PaymentID>
      </MakeSupporterDonationResult>
    </MakeSupporterDonationResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /services/Sphere.asmx HTTP/1.1
Host: www.kintera.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <KinteraSoapHeader xmlns="https://www.kintera.com/services/">
      <AccountID>int</AccountID>
      <SecurityToken>string</SecurityToken>
    </KinteraSoapHeader>
  </soap12:Header>
  <soap12:Body>
    <MakeSupporterDonation xmlns="https://www.kintera.com/services/">
      <request>
        <SupporterID>string</SupporterID>
        <EventID>int</EventID>
        <DonationAmount>decimal</DonationAmount>
        <PaymentType>CreditCard or OnlineCheck</PaymentType>
        <CreditCardInfo>
          <CardNumber>string</CardNumber>
          <CardType>string</CardType>
          <HolderName>string</HolderName>
          <ExpireYear>string</ExpireYear>
          <ExpireMonth>string</ExpireMonth>
          <CVV>string</CVV>
        </CreditCardInfo>
        <OnlineCheckInfo>
          <BankAccountNumber>string</BankAccountNumber>
          <BankID>string</BankID>
          <BankAccountType>string</BankAccountType>
          <BankCustomerName>string</BankCustomerName>
        </OnlineCheckInfo>
        <DonationGift>
          <ID>int</ID>
          <Message>string</Message>
          <Receiver>string</Receiver>
          <ShippingAddress>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Country>string</Country>
            <Province>string</Province>
          </ShippingAddress>
        </DonationGift>
        <DonationFrequency>int</DonationFrequency>
        <DonationTimes>int</DonationTimes>
        <VisitorSource>
          <TypeID>int</TypeID>
          <SourceID>string</SourceID>
          <SourceTitle>string</SourceTitle>
          <SourceUrl>string</SourceUrl>
          <PromotionCode>string</PromotionCode>
        </VisitorSource>
        <SupporterActionID>int</SupporterActionID>
        <IsTest>boolean</IsTest>
      </request>
    </MakeSupporterDonation>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <MakeSupporterDonationResponse xmlns="https://www.kintera.com/services/">
      <MakeSupporterDonationResult>
        <PaymentID>int</PaymentID>
      </MakeSupporterDonationResult>
    </MakeSupporterDonationResponse>
  </soap12:Body>
</soap12:Envelope>