Api
Click here for a complete list of operations.
CreateSubscription
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 /v/2/Api.asmx HTTP/1.1 Host: api.charityengine.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.bisglobal.net/CreateSubscription" <?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> <CreateSubscription xmlns="https://api.bisglobal.net/"> <credentials> <Username>string</Username> <Password>string</Password> <AuthenticationToken>string</AuthenticationToken> <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType> </credentials> <parameters> <Subscriptions> <CreateSubscriptionParameters PaymentMode="None or AuthorizeFormOfPayment or ProcessFirstPayment" ToggleActiveBasedOnPayment="boolean" DeleteSustainerIfPaymentFails="boolean" Frequency="None or Daily or Weekly or BiMonthly or Monthly or Quarterly or BiAnnually or Annually" PaymentMethod="Undefined or CreditCard or ACH or Check or Cash or Other or InKind or None or ECheck or PayPal or SoftCredit or WireTransfer"> <Type_Id>int</Type_Id> <Status_Id>int</Status_Id> <Category_Id>int</Category_Id> <Active>boolean</Active> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <Limit>double</Limit> <Contact xsi:nil="true" /> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <TerminationDate>dateTime</TerminationDate> <TerminationReason_Id>int</TerminationReason_Id> <PauseUntil>dateTime</PauseUntil> <ResetBilingDate>dateTime</ResetBilingDate> <CreditCardInfo xsi:nil="true" /> <BankAccountInfo xsi:nil="true" /> <CustomerBillingInfo xsi:nil="true" /> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <StateChange_Initiative_Id>long</StateChange_Initiative_Id> <StateChange_Segment_Id>long</StateChange_Segment_Id> <StateChange_InititiativePhoneNumber_Id>long</StateChange_InititiativePhoneNumber_Id> <StateChange_InititiativePhoneNumber>string</StateChange_InititiativePhoneNumber> <StateChange_InitiativeSegmentCode>string</StateChange_InitiativeSegmentCode> <StateChange_ResponseChannel_Id>long</StateChange_ResponseChannel_Id> <SourceTransactionId>long</SourceTransactionId> <ValidationTransactionId>long</ValidationTransactionId> <SendReceipt>boolean</SendReceipt> <ContactCopy xsi:nil="true" /> </CreateSubscriptionParameters> <CreateSubscriptionParameters PaymentMode="None or AuthorizeFormOfPayment or ProcessFirstPayment" ToggleActiveBasedOnPayment="boolean" DeleteSustainerIfPaymentFails="boolean" Frequency="None or Daily or Weekly or BiMonthly or Monthly or Quarterly or BiAnnually or Annually" PaymentMethod="Undefined or CreditCard or ACH or Check or Cash or Other or InKind or None or ECheck or PayPal or SoftCredit or WireTransfer"> <Type_Id>int</Type_Id> <Status_Id>int</Status_Id> <Category_Id>int</Category_Id> <Active>boolean</Active> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <Limit>double</Limit> <Contact xsi:nil="true" /> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <TerminationDate>dateTime</TerminationDate> <TerminationReason_Id>int</TerminationReason_Id> <PauseUntil>dateTime</PauseUntil> <ResetBilingDate>dateTime</ResetBilingDate> <CreditCardInfo xsi:nil="true" /> <BankAccountInfo xsi:nil="true" /> <CustomerBillingInfo xsi:nil="true" /> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <StateChange_Initiative_Id>long</StateChange_Initiative_Id> <StateChange_Segment_Id>long</StateChange_Segment_Id> <StateChange_InititiativePhoneNumber_Id>long</StateChange_InititiativePhoneNumber_Id> <StateChange_InititiativePhoneNumber>string</StateChange_InititiativePhoneNumber> <StateChange_InitiativeSegmentCode>string</StateChange_InitiativeSegmentCode> <StateChange_ResponseChannel_Id>long</StateChange_ResponseChannel_Id> <SourceTransactionId>long</SourceTransactionId> <ValidationTransactionId>long</ValidationTransactionId> <SendReceipt>boolean</SendReceipt> <ContactCopy xsi:nil="true" /> </CreateSubscriptionParameters> </Subscriptions> </parameters> </CreateSubscription> </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> <CreateSubscriptionResponse xmlns="https://api.bisglobal.net/"> <CreateSubscriptionResult> <Subscriptions> <SubscriptionDetail> <Subscription_Id>long</Subscription_Id> <Transaction xsi:nil="true" /> </SubscriptionDetail> <SubscriptionDetail> <Subscription_Id>long</Subscription_Id> <Transaction xsi:nil="true" /> </SubscriptionDetail> </Subscriptions> </CreateSubscriptionResult> </CreateSubscriptionResponse> </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 /v/2/Api.asmx HTTP/1.1 Host: api.charityengine.net 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> <CreateSubscription xmlns="https://api.bisglobal.net/"> <credentials> <Username>string</Username> <Password>string</Password> <AuthenticationToken>string</AuthenticationToken> <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType> </credentials> <parameters> <Subscriptions> <CreateSubscriptionParameters PaymentMode="None or AuthorizeFormOfPayment or ProcessFirstPayment" ToggleActiveBasedOnPayment="boolean" DeleteSustainerIfPaymentFails="boolean" Frequency="None or Daily or Weekly or BiMonthly or Monthly or Quarterly or BiAnnually or Annually" PaymentMethod="Undefined or CreditCard or ACH or Check or Cash or Other or InKind or None or ECheck or PayPal or SoftCredit or WireTransfer"> <Type_Id>int</Type_Id> <Status_Id>int</Status_Id> <Category_Id>int</Category_Id> <Active>boolean</Active> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <Limit>double</Limit> <Contact xsi:nil="true" /> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <TerminationDate>dateTime</TerminationDate> <TerminationReason_Id>int</TerminationReason_Id> <PauseUntil>dateTime</PauseUntil> <ResetBilingDate>dateTime</ResetBilingDate> <CreditCardInfo xsi:nil="true" /> <BankAccountInfo xsi:nil="true" /> <CustomerBillingInfo xsi:nil="true" /> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <StateChange_Initiative_Id>long</StateChange_Initiative_Id> <StateChange_Segment_Id>long</StateChange_Segment_Id> <StateChange_InititiativePhoneNumber_Id>long</StateChange_InititiativePhoneNumber_Id> <StateChange_InititiativePhoneNumber>string</StateChange_InititiativePhoneNumber> <StateChange_InitiativeSegmentCode>string</StateChange_InitiativeSegmentCode> <StateChange_ResponseChannel_Id>long</StateChange_ResponseChannel_Id> <SourceTransactionId>long</SourceTransactionId> <ValidationTransactionId>long</ValidationTransactionId> <SendReceipt>boolean</SendReceipt> <ContactCopy xsi:nil="true" /> </CreateSubscriptionParameters> <CreateSubscriptionParameters PaymentMode="None or AuthorizeFormOfPayment or ProcessFirstPayment" ToggleActiveBasedOnPayment="boolean" DeleteSustainerIfPaymentFails="boolean" Frequency="None or Daily or Weekly or BiMonthly or Monthly or Quarterly or BiAnnually or Annually" PaymentMethod="Undefined or CreditCard or ACH or Check or Cash or Other or InKind or None or ECheck or PayPal or SoftCredit or WireTransfer"> <Type_Id>int</Type_Id> <Status_Id>int</Status_Id> <Category_Id>int</Category_Id> <Active>boolean</Active> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <Limit>double</Limit> <Contact xsi:nil="true" /> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <TerminationDate>dateTime</TerminationDate> <TerminationReason_Id>int</TerminationReason_Id> <PauseUntil>dateTime</PauseUntil> <ResetBilingDate>dateTime</ResetBilingDate> <CreditCardInfo xsi:nil="true" /> <BankAccountInfo xsi:nil="true" /> <CustomerBillingInfo xsi:nil="true" /> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <StateChange_Initiative_Id>long</StateChange_Initiative_Id> <StateChange_Segment_Id>long</StateChange_Segment_Id> <StateChange_InititiativePhoneNumber_Id>long</StateChange_InititiativePhoneNumber_Id> <StateChange_InititiativePhoneNumber>string</StateChange_InititiativePhoneNumber> <StateChange_InitiativeSegmentCode>string</StateChange_InitiativeSegmentCode> <StateChange_ResponseChannel_Id>long</StateChange_ResponseChannel_Id> <SourceTransactionId>long</SourceTransactionId> <ValidationTransactionId>long</ValidationTransactionId> <SendReceipt>boolean</SendReceipt> <ContactCopy xsi:nil="true" /> </CreateSubscriptionParameters> </Subscriptions> </parameters> </CreateSubscription> </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> <CreateSubscriptionResponse xmlns="https://api.bisglobal.net/"> <CreateSubscriptionResult> <Subscriptions> <SubscriptionDetail> <Subscription_Id>long</Subscription_Id> <Transaction xsi:nil="true" /> </SubscriptionDetail> <SubscriptionDetail> <Subscription_Id>long</Subscription_Id> <Transaction xsi:nil="true" /> </SubscriptionDetail> </Subscriptions> </CreateSubscriptionResult> </CreateSubscriptionResponse> </soap12:Body> </soap12:Envelope>