wsFundRaising


Click here for a complete list of operations.

getBatchDetails

Returns a valid BatchNumber, BatchCashAccount, and PaymentCashAccount from iMIS. If the batch does not exist, this method will create it. In the getBatchDetailsObject, BatchType can be one of the following: DUES,EVENTS,ORDERS,FUNDRAISING. PaymentType is your credit card type or name, or payment type as setup in the BATCH_SETTINGS general lookup table and is generally one of the following, AMEX,DISC,MC,VISA,PO,CASH,DEFAULT. EventCode is an iMIS EventCode and only comes into play when creating batches for events where you want a separate batch per event. Send a blank if not applicable. Entity is the FinancialEntityCode and it will use the appropriate BATCH_SETTINGS_ general lookup table. If you don't provide a Finanical Entity it will look for a general lookup table called BATCH_SETTINGS. You will get an object back and should check the result. If the result is 0 it worked. If it is not 0 then it failed an additional information is in the ResultMessage parameter. It will return the BatchNumber, BatchCashAccount (this is the cash account that was use to create the batch), PaymentCashAccount (this is the cash account that you should use when processing associated payments with this transaction and is based on the PaymentType and the setup in the BATCH_SETTINGS_ general lookup table. Additional information on the setup of the BATCH_SETTINGS table is in the documentation.

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 /WebServices/wsFundraising.asmx HTTP/1.1
Host: demo.atsol.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.atsol.org/wsFundRaising/getBatchDetails"

<?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>
    <getBatchDetails xmlns="http://www.atsol.org/wsFundRaising/">
      <Params>
        <BatchType>string</BatchType>
        <Payment>
          <Amount>decimal</Amount>
          <CashAccountCode>string</CashAccountCode>
          <CheckPOPaymentNumber>string</CheckPOPaymentNumber>
          <ClassicPayType>string</ClassicPayType>
          <CreditCardExpiration>string</CreditCardExpiration>
          <CreditCardExpirationEncrypted>string</CreditCardExpirationEncrypted>
          <CreditCardExpirationMasked>string</CreditCardExpirationMasked>
          <CreditCardNumber>string</CreditCardNumber>
          <CreditCardSecurityCode>string</CreditCardSecurityCode>
          <CreditCardSecurityCodeEncrypted>string</CreditCardSecurityCodeEncrypted>
          <CreditDebitCardAuthorizationCode>string</CreditDebitCardAuthorizationCode>
          <CreditDebitCardHoldersName>string</CreditDebitCardHoldersName>
          <CreditDebitCardNumberEncrypted>string</CreditDebitCardNumberEncrypted>
          <CreditDebitCardNumberMasked>string</CreditDebitCardNumberMasked>
          <CreditDebitCardStatus>string</CreditDebitCardStatus>
          <CurrencyCode>string</CurrencyCode>
          <DebitCardIssueDate>string</DebitCardIssueDate>
          <DebitCardIssueNumber>string</DebitCardIssueNumber>
          <DebitCardNumber>string</DebitCardNumber>
          <IsAmountLocked>boolean</IsAmountLocked>
          <OriginalTransactionId>string</OriginalTransactionId>
          <OrderNumber>double</OrderNumber>
          <PaymentToken>string</PaymentToken>
          <PaymentTokenSummary>string</PaymentTokenSummary>
          <PaymentType>Cash or CreditCard or Check or PurchaseOrder or InKind or Other or DebitCard or Unknown</PaymentType>
          <ReferenceNumber>string</ReferenceNumber>
          <TransactionComment1>string</TransactionComment1>
          <TransactionComment2>string</TransactionComment2>
          <TransactionId>string</TransactionId>
          <Address>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <AddressFormatCode>int</AddressFormatCode>
            <AddressNumber>int</AddressNumber>
            <AddressPurpose>string</AddressPurpose>
            <BadAddressReasonCode>string</BadAddressReasonCode>
            <BadAddressReasonDescription>string</BadAddressReasonDescription>
            <Barcode>string</Barcode>
            <CarrierRoute>string</CarrierRoute>
            <City>string</City>
            <ContactId>string</ContactId>
            <Country>string</Country>
            <County>string</County>
            <DeliveryPointBarcode>string</DeliveryPointBarcode>
            <Directions>string</Directions>
            <EmailAddress>string</EmailAddress>
            <Fax>string</Fax>
            <FormattedAddress>string</FormattedAddress>
            <InstituteName>string</InstituteName>
            <IsPreferredBill>boolean</IsPreferredBill>
            <IsPreferredMail>boolean</IsPreferredMail>
            <IsPreferredShip>boolean</IsPreferredShip>
            <LastQASBatchDateTime>dateTime</LastQASBatchDateTime>
            <LastVerifiedOn>dateTime</LastVerifiedOn>
            <LocalGovernmentDistrict1>string</LocalGovernmentDistrict1>
            <LocalGovernmentDistrict2>string</LocalGovernmentDistrict2>
            <MailCode>string</MailCode>
            <NationalGovernmentDistrict>string</NationalGovernmentDistrict>
            <Note>string</Note>
            <Phone>string</Phone>
            <PostalCode>string</PostalCode>
            <SkipAutoVerifyFlag>boolean</SkipAutoVerifyFlag>
            <StateProvince>string</StateProvince>
            <TollFree>string</TollFree>
            <UpdatedOn>dateTime</UpdatedOn>
          </Address>
        </Payment>
        <EventCode>string</EventCode>
        <Entity>string</Entity>
      </Params>
    </getBatchDetails>
  </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>
    <getBatchDetailsResponse xmlns="http://www.atsol.org/wsFundRaising/">
      <getBatchDetailsResult>
        <BatchNumber>string</BatchNumber>
        <BatchCashAccount>string</BatchCashAccount>
        <PaymentCashAccount>string</PaymentCashAccount>
        <ProcessorCashAccount>string</ProcessorCashAccount>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
      </getBatchDetailsResult>
    </getBatchDetailsResponse>
  </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 /WebServices/wsFundraising.asmx HTTP/1.1
Host: demo.atsol.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>
    <getBatchDetails xmlns="http://www.atsol.org/wsFundRaising/">
      <Params>
        <BatchType>string</BatchType>
        <Payment>
          <Amount>decimal</Amount>
          <CashAccountCode>string</CashAccountCode>
          <CheckPOPaymentNumber>string</CheckPOPaymentNumber>
          <ClassicPayType>string</ClassicPayType>
          <CreditCardExpiration>string</CreditCardExpiration>
          <CreditCardExpirationEncrypted>string</CreditCardExpirationEncrypted>
          <CreditCardExpirationMasked>string</CreditCardExpirationMasked>
          <CreditCardNumber>string</CreditCardNumber>
          <CreditCardSecurityCode>string</CreditCardSecurityCode>
          <CreditCardSecurityCodeEncrypted>string</CreditCardSecurityCodeEncrypted>
          <CreditDebitCardAuthorizationCode>string</CreditDebitCardAuthorizationCode>
          <CreditDebitCardHoldersName>string</CreditDebitCardHoldersName>
          <CreditDebitCardNumberEncrypted>string</CreditDebitCardNumberEncrypted>
          <CreditDebitCardNumberMasked>string</CreditDebitCardNumberMasked>
          <CreditDebitCardStatus>string</CreditDebitCardStatus>
          <CurrencyCode>string</CurrencyCode>
          <DebitCardIssueDate>string</DebitCardIssueDate>
          <DebitCardIssueNumber>string</DebitCardIssueNumber>
          <DebitCardNumber>string</DebitCardNumber>
          <IsAmountLocked>boolean</IsAmountLocked>
          <OriginalTransactionId>string</OriginalTransactionId>
          <OrderNumber>double</OrderNumber>
          <PaymentToken>string</PaymentToken>
          <PaymentTokenSummary>string</PaymentTokenSummary>
          <PaymentType>Cash or CreditCard or Check or PurchaseOrder or InKind or Other or DebitCard or Unknown</PaymentType>
          <ReferenceNumber>string</ReferenceNumber>
          <TransactionComment1>string</TransactionComment1>
          <TransactionComment2>string</TransactionComment2>
          <TransactionId>string</TransactionId>
          <Address>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <AddressFormatCode>int</AddressFormatCode>
            <AddressNumber>int</AddressNumber>
            <AddressPurpose>string</AddressPurpose>
            <BadAddressReasonCode>string</BadAddressReasonCode>
            <BadAddressReasonDescription>string</BadAddressReasonDescription>
            <Barcode>string</Barcode>
            <CarrierRoute>string</CarrierRoute>
            <City>string</City>
            <ContactId>string</ContactId>
            <Country>string</Country>
            <County>string</County>
            <DeliveryPointBarcode>string</DeliveryPointBarcode>
            <Directions>string</Directions>
            <EmailAddress>string</EmailAddress>
            <Fax>string</Fax>
            <FormattedAddress>string</FormattedAddress>
            <InstituteName>string</InstituteName>
            <IsPreferredBill>boolean</IsPreferredBill>
            <IsPreferredMail>boolean</IsPreferredMail>
            <IsPreferredShip>boolean</IsPreferredShip>
            <LastQASBatchDateTime>dateTime</LastQASBatchDateTime>
            <LastVerifiedOn>dateTime</LastVerifiedOn>
            <LocalGovernmentDistrict1>string</LocalGovernmentDistrict1>
            <LocalGovernmentDistrict2>string</LocalGovernmentDistrict2>
            <MailCode>string</MailCode>
            <NationalGovernmentDistrict>string</NationalGovernmentDistrict>
            <Note>string</Note>
            <Phone>string</Phone>
            <PostalCode>string</PostalCode>
            <SkipAutoVerifyFlag>boolean</SkipAutoVerifyFlag>
            <StateProvince>string</StateProvince>
            <TollFree>string</TollFree>
            <UpdatedOn>dateTime</UpdatedOn>
          </Address>
        </Payment>
        <EventCode>string</EventCode>
        <Entity>string</Entity>
      </Params>
    </getBatchDetails>
  </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>
    <getBatchDetailsResponse xmlns="http://www.atsol.org/wsFundRaising/">
      <getBatchDetailsResult>
        <BatchNumber>string</BatchNumber>
        <BatchCashAccount>string</BatchCashAccount>
        <PaymentCashAccount>string</PaymentCashAccount>
        <ProcessorCashAccount>string</ProcessorCashAccount>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
      </getBatchDetailsResult>
    </getBatchDetailsResponse>
  </soap12:Body>
</soap12:Envelope>