DonationsService

Click here for a complete list of operations.

CreateRecurringPayment

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 /Service.asmx HTTP/1.1
Host: soap-donations.lcg.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://soap.lcg.org/webdept/donations/CreateRecurringPayment"

<?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>
    <CreateRecurringPayment xmlns="http://soap.lcg.org/webdept/donations/">
      <apiKey>string</apiKey>
      <transKey>guid</transKey>
      <username>string</username>
      <password>string</password>
      <paymentProfileID>long</paymentProfileID>
      <description>string</description>
      <donAcct>
        <Amount>decimal</Amount>
        <LCGAcctNumber>string</LCGAcctNumber>
        <LCGPaymentDescription>string</LCGPaymentDescription>
      </donAcct>
      <schedule>
        <Interval>
          <length>short</length>
          <unit>days or months</unit>
        </Interval>
        <StartDate>dateTime</StartDate>
        <Occurrences>int</Occurrences>
      </schedule>
      <agreementIP>string</agreementIP>
      <agreementID>guid</agreementID>
    </CreateRecurringPayment>
  </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>
    <CreateRecurringPaymentResponse xmlns="http://soap.lcg.org/webdept/donations/">
      <CreateRecurringPaymentResult>
        <SubscriptionID>long</SubscriptionID>
      </CreateRecurringPaymentResult>
    </CreateRecurringPaymentResponse>
  </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 /Service.asmx HTTP/1.1
Host: soap-donations.lcg.org
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>
    <CreateRecurringPayment xmlns="http://soap.lcg.org/webdept/donations/">
      <apiKey>string</apiKey>
      <transKey>guid</transKey>
      <username>string</username>
      <password>string</password>
      <paymentProfileID>long</paymentProfileID>
      <description>string</description>
      <donAcct>
        <Amount>decimal</Amount>
        <LCGAcctNumber>string</LCGAcctNumber>
        <LCGPaymentDescription>string</LCGPaymentDescription>
      </donAcct>
      <schedule>
        <Interval>
          <length>short</length>
          <unit>days or months</unit>
        </Interval>
        <StartDate>dateTime</StartDate>
        <Occurrences>int</Occurrences>
      </schedule>
      <agreementIP>string</agreementIP>
      <agreementID>guid</agreementID>
    </CreateRecurringPayment>
  </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>
    <CreateRecurringPaymentResponse xmlns="http://soap.lcg.org/webdept/donations/">
      <CreateRecurringPaymentResult>
        <SubscriptionID>long</SubscriptionID>
      </CreateRecurringPaymentResult>
    </CreateRecurringPaymentResponse>
  </soap12:Body>
</soap12:Envelope>