wsEvents


Click here for a complete list of operations.

makePaymentPayFlowProACH

This makes a payment with an ACH through PayPal as setup in iMIS. It returns information from Payflow Pro including the following Result: the payment status (0 if success, or some other numeric value that gives information about the transaction failure status), PNREF: The Payflow Pro transaction ID (upon success). RESPMSG: The Payflow Pro generated error message (upon failure). AUTHCODE: The authentication code (upon success). AVSADDR (optional, only present if AVS is activated), AVSZIP (optional, only present if AVS is activated). IAVS indicates whether AVS response is international (Y), USA (N) or cannot be determined (X). CVV2MATCH: N/A. The passed in parameters relate to the transaction and include MICR: String representing ABA Number and Customers Bank Account Number , CheckNum: Check Number, DriveLic: Customer's Drivers License, Amount:Check Amount, Comment1: optional comment stored at PayPal, Comment2: optional comment stored at PayPal, InvoiceNumber: Optional Invoice Number, Street: Customer's Street Address, Zip: Customer's Zip Code, City: Customer's City, State: Customer's State or Province, Country: Customer's Country, NameOnCheck: Customer's Name as it appears on check, Email: Customer's Email Address. Additional information on Payflow Pro result and parameter values can be obtained from the Paypal website.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
MICR:
CheckNum:
DriveLic:
Amount:
Comment1:
Comment2:
InvoiceNumber:
Street:
Zip:
City:
State:
Country:
NameOnCheck:
Email:

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

<?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>
    <makePaymentPayFlowProACH xmlns="http://www.atsol.org/wsEvents/">
      <MICR>string</MICR>
      <CheckNum>string</CheckNum>
      <DriveLic>string</DriveLic>
      <Amount>double</Amount>
      <Comment1>string</Comment1>
      <Comment2>string</Comment2>
      <InvoiceNumber>string</InvoiceNumber>
      <Street>string</Street>
      <Zip>string</Zip>
      <City>string</City>
      <State>string</State>
      <Country>string</Country>
      <NameOnCheck>string</NameOnCheck>
      <Email>string</Email>
    </makePaymentPayFlowProACH>
  </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>
    <makePaymentPayFlowProACHResponse xmlns="http://www.atsol.org/wsEvents/">
      <makePaymentPayFlowProACHResult>
        <Result>int</Result>
        <PNREF>string</PNREF>
        <RESPMSG>string</RESPMSG>
        <AUTHCODE>string</AUTHCODE>
        <AVSADDR>string</AVSADDR>
        <AVSZIP>string</AVSZIP>
        <IAVS>string</IAVS>
        <CVV2MATCH>string</CVV2MATCH>
        <AddlMsgs>string</AddlMsgs>
        <AmexID>string</AmexID>
        <AmexPosData>string</AmexPosData>
        <BalAmt>string</BalAmt>
        <BatchId>string</BatchId>
        <CardSecure>string</CardSecure>
        <CorrelationId>string</CorrelationId>
        <CustRef>string</CustRef>
        <DateToSettle>string</DateToSettle>
        <Duplicate>string</Duplicate>
        <EndTime>string</EndTime>
        <FeeAmt>string</FeeAmt>
        <HostCode>string</HostCode>
        <OrigPnref>string</OrigPnref>
        <OrigResult>string</OrigResult>
        <PaymentType>string</PaymentType>
        <PendingReason>string</PendingReason>
        <PPref>string</PPref>
        <ProcAVS>string</ProcAVS>
        <ProcCardSecure>string</ProcCardSecure>
        <ProcCVV2>string</ProcCVV2>
        <RequestString>string</RequestString>
        <ResponseString>string</ResponseString>
        <RespText>string</RespText>
        <SettleDate>string</SettleDate>
        <StartTime>string</StartTime>
        <Status>string</Status>
        <TransState>string</TransState>
      </makePaymentPayFlowProACHResult>
    </makePaymentPayFlowProACHResponse>
  </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/wsEvents.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>
    <makePaymentPayFlowProACH xmlns="http://www.atsol.org/wsEvents/">
      <MICR>string</MICR>
      <CheckNum>string</CheckNum>
      <DriveLic>string</DriveLic>
      <Amount>double</Amount>
      <Comment1>string</Comment1>
      <Comment2>string</Comment2>
      <InvoiceNumber>string</InvoiceNumber>
      <Street>string</Street>
      <Zip>string</Zip>
      <City>string</City>
      <State>string</State>
      <Country>string</Country>
      <NameOnCheck>string</NameOnCheck>
      <Email>string</Email>
    </makePaymentPayFlowProACH>
  </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>
    <makePaymentPayFlowProACHResponse xmlns="http://www.atsol.org/wsEvents/">
      <makePaymentPayFlowProACHResult>
        <Result>int</Result>
        <PNREF>string</PNREF>
        <RESPMSG>string</RESPMSG>
        <AUTHCODE>string</AUTHCODE>
        <AVSADDR>string</AVSADDR>
        <AVSZIP>string</AVSZIP>
        <IAVS>string</IAVS>
        <CVV2MATCH>string</CVV2MATCH>
        <AddlMsgs>string</AddlMsgs>
        <AmexID>string</AmexID>
        <AmexPosData>string</AmexPosData>
        <BalAmt>string</BalAmt>
        <BatchId>string</BatchId>
        <CardSecure>string</CardSecure>
        <CorrelationId>string</CorrelationId>
        <CustRef>string</CustRef>
        <DateToSettle>string</DateToSettle>
        <Duplicate>string</Duplicate>
        <EndTime>string</EndTime>
        <FeeAmt>string</FeeAmt>
        <HostCode>string</HostCode>
        <OrigPnref>string</OrigPnref>
        <OrigResult>string</OrigResult>
        <PaymentType>string</PaymentType>
        <PendingReason>string</PendingReason>
        <PPref>string</PPref>
        <ProcAVS>string</ProcAVS>
        <ProcCardSecure>string</ProcCardSecure>
        <ProcCVV2>string</ProcCVV2>
        <RequestString>string</RequestString>
        <ResponseString>string</ResponseString>
        <RespText>string</RespText>
        <SettleDate>string</SettleDate>
        <StartTime>string</StartTime>
        <Status>string</Status>
        <TransState>string</TransState>
      </makePaymentPayFlowProACHResult>
    </makePaymentPayFlowProACHResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /WebServices/wsEvents.asmx/makePaymentPayFlowProACH?MICR=string&CheckNum=string&DriveLic=string&Amount=string&Comment1=string&Comment2=string&InvoiceNumber=string&Street=string&Zip=string&City=string&State=string&Country=string&NameOnCheck=string&Email=string HTTP/1.1
Host: demo.atsol.org
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<PayFlowProParams xmlns="http://www.atsol.org/wsEvents/">
  <Result>int</Result>
  <PNREF>string</PNREF>
  <RESPMSG>string</RESPMSG>
  <AUTHCODE>string</AUTHCODE>
  <AVSADDR>string</AVSADDR>
  <AVSZIP>string</AVSZIP>
  <IAVS>string</IAVS>
  <CVV2MATCH>string</CVV2MATCH>
  <AddlMsgs>string</AddlMsgs>
  <AmexID>string</AmexID>
  <AmexPosData>string</AmexPosData>
  <BalAmt>string</BalAmt>
  <BatchId>string</BatchId>
  <CardSecure>string</CardSecure>
  <CorrelationId>string</CorrelationId>
  <CustRef>string</CustRef>
  <DateToSettle>string</DateToSettle>
  <Duplicate>string</Duplicate>
  <EndTime>string</EndTime>
  <FeeAmt>string</FeeAmt>
  <HostCode>string</HostCode>
  <OrigPnref>string</OrigPnref>
  <OrigResult>string</OrigResult>
  <PaymentType>string</PaymentType>
  <PendingReason>string</PendingReason>
  <PPref>string</PPref>
  <ProcAVS>string</ProcAVS>
  <ProcCardSecure>string</ProcCardSecure>
  <ProcCVV2>string</ProcCVV2>
  <RequestString>string</RequestString>
  <ResponseString>string</ResponseString>
  <RespText>string</RespText>
  <SettleDate>string</SettleDate>
  <StartTime>string</StartTime>
  <Status>string</Status>
  <TransState>string</TransState>
</PayFlowProParams>

HTTP POST

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

POST /WebServices/wsEvents.asmx/makePaymentPayFlowProACH HTTP/1.1
Host: demo.atsol.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

MICR=string&CheckNum=string&DriveLic=string&Amount=string&Comment1=string&Comment2=string&InvoiceNumber=string&Street=string&Zip=string&City=string&State=string&Country=string&NameOnCheck=string&Email=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<PayFlowProParams xmlns="http://www.atsol.org/wsEvents/">
  <Result>int</Result>
  <PNREF>string</PNREF>
  <RESPMSG>string</RESPMSG>
  <AUTHCODE>string</AUTHCODE>
  <AVSADDR>string</AVSADDR>
  <AVSZIP>string</AVSZIP>
  <IAVS>string</IAVS>
  <CVV2MATCH>string</CVV2MATCH>
  <AddlMsgs>string</AddlMsgs>
  <AmexID>string</AmexID>
  <AmexPosData>string</AmexPosData>
  <BalAmt>string</BalAmt>
  <BatchId>string</BatchId>
  <CardSecure>string</CardSecure>
  <CorrelationId>string</CorrelationId>
  <CustRef>string</CustRef>
  <DateToSettle>string</DateToSettle>
  <Duplicate>string</Duplicate>
  <EndTime>string</EndTime>
  <FeeAmt>string</FeeAmt>
  <HostCode>string</HostCode>
  <OrigPnref>string</OrigPnref>
  <OrigResult>string</OrigResult>
  <PaymentType>string</PaymentType>
  <PendingReason>string</PendingReason>
  <PPref>string</PPref>
  <ProcAVS>string</ProcAVS>
  <ProcCardSecure>string</ProcCardSecure>
  <ProcCVV2>string</ProcCVV2>
  <RequestString>string</RequestString>
  <ResponseString>string</ResponseString>
  <RespText>string</RespText>
  <SettleDate>string</SettleDate>
  <StartTime>string</StartTime>
  <Status>string</Status>
  <TransState>string</TransState>
</PayFlowProParams>