Report Web Service

Report

Click here for a complete list of operations.

BatchDetails

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
Client_ID:
ApiPassword:
ProcessTime:
IncludeFeeBreakdown:

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 /Report.asmx HTTP/1.1
Host: www.greenbyphone.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "CheckProcessing/BatchDetails"

<?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>
    <BatchDetails xmlns="CheckProcessing">
      <Client_ID>string</Client_ID>
      <ApiPassword>string</ApiPassword>
      <ProcessTime>string</ProcessTime>
      <IncludeFeeBreakdown>string</IncludeFeeBreakdown>
    </BatchDetails>
  </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>
    <BatchDetailsResponse xmlns="CheckProcessing">
      <BatchDetailsResult>
        <Result>string</Result>
        <ResultDescription>string</ResultDescription>
        <Checks>
          <CheckBatchDetail>
            <Check_ID>long</Check_ID>
            <CheckNumber>string</CheckNumber>
            <Type>string</Type>
            <Memo>string</Memo>
            <Amount>decimal</Amount>
            <CheckDate>dateTime</CheckDate>
            <Verification xsi:nil="true" />
            <ProcessDate>dateTime</ProcessDate>
            <CreationDate>dateTime</CreationDate>
            <Reject xsi:nil="true" />
            <RefundCheck_ID>long</RefundCheck_ID>
            <ParentCheck_ID>long</ParentCheck_ID>
            <RecurringText>string</RecurringText>
            <FromBankAccount>string</FromBankAccount>
            <ToBankAccount>string</ToBankAccount>
            <FeesSummed>decimal</FeesSummed>
            <Fees xsi:nil="true" />
            <Deleted>boolean</Deleted>
          </CheckBatchDetail>
          <CheckBatchDetail>
            <Check_ID>long</Check_ID>
            <CheckNumber>string</CheckNumber>
            <Type>string</Type>
            <Memo>string</Memo>
            <Amount>decimal</Amount>
            <CheckDate>dateTime</CheckDate>
            <Verification xsi:nil="true" />
            <ProcessDate>dateTime</ProcessDate>
            <CreationDate>dateTime</CreationDate>
            <Reject xsi:nil="true" />
            <RefundCheck_ID>long</RefundCheck_ID>
            <ParentCheck_ID>long</ParentCheck_ID>
            <RecurringText>string</RecurringText>
            <FromBankAccount>string</FromBankAccount>
            <ToBankAccount>string</ToBankAccount>
            <FeesSummed>decimal</FeesSummed>
            <Fees xsi:nil="true" />
            <Deleted>boolean</Deleted>
          </CheckBatchDetail>
        </Checks>
      </BatchDetailsResult>
    </BatchDetailsResponse>
  </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 /Report.asmx HTTP/1.1
Host: www.greenbyphone.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:Body>
    <BatchDetails xmlns="CheckProcessing">
      <Client_ID>string</Client_ID>
      <ApiPassword>string</ApiPassword>
      <ProcessTime>string</ProcessTime>
      <IncludeFeeBreakdown>string</IncludeFeeBreakdown>
    </BatchDetails>
  </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>
    <BatchDetailsResponse xmlns="CheckProcessing">
      <BatchDetailsResult>
        <Result>string</Result>
        <ResultDescription>string</ResultDescription>
        <Checks>
          <CheckBatchDetail>
            <Check_ID>long</Check_ID>
            <CheckNumber>string</CheckNumber>
            <Type>string</Type>
            <Memo>string</Memo>
            <Amount>decimal</Amount>
            <CheckDate>dateTime</CheckDate>
            <Verification xsi:nil="true" />
            <ProcessDate>dateTime</ProcessDate>
            <CreationDate>dateTime</CreationDate>
            <Reject xsi:nil="true" />
            <RefundCheck_ID>long</RefundCheck_ID>
            <ParentCheck_ID>long</ParentCheck_ID>
            <RecurringText>string</RecurringText>
            <FromBankAccount>string</FromBankAccount>
            <ToBankAccount>string</ToBankAccount>
            <FeesSummed>decimal</FeesSummed>
            <Fees xsi:nil="true" />
            <Deleted>boolean</Deleted>
          </CheckBatchDetail>
          <CheckBatchDetail>
            <Check_ID>long</Check_ID>
            <CheckNumber>string</CheckNumber>
            <Type>string</Type>
            <Memo>string</Memo>
            <Amount>decimal</Amount>
            <CheckDate>dateTime</CheckDate>
            <Verification xsi:nil="true" />
            <ProcessDate>dateTime</ProcessDate>
            <CreationDate>dateTime</CreationDate>
            <Reject xsi:nil="true" />
            <RefundCheck_ID>long</RefundCheck_ID>
            <ParentCheck_ID>long</ParentCheck_ID>
            <RecurringText>string</RecurringText>
            <FromBankAccount>string</FromBankAccount>
            <ToBankAccount>string</ToBankAccount>
            <FeesSummed>decimal</FeesSummed>
            <Fees xsi:nil="true" />
            <Deleted>boolean</Deleted>
          </CheckBatchDetail>
        </Checks>
      </BatchDetailsResult>
    </BatchDetailsResponse>
  </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 /Report.asmx/BatchDetails?Client_ID=string&ApiPassword=string&ProcessTime=string&IncludeFeeBreakdown=string HTTP/1.1
Host: www.greenbyphone.com

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

<?xml version="1.0" encoding="utf-8"?>
<BatchDetailsResult xmlns="CheckProcessing">
  <Result>string</Result>
  <ResultDescription>string</ResultDescription>
  <Checks>
    <CheckBatchDetail>
      <Check_ID>long</Check_ID>
      <CheckNumber>string</CheckNumber>
      <Type>string</Type>
      <Memo>string</Memo>
      <Amount>decimal</Amount>
      <CheckDate>dateTime</CheckDate>
      <Verification>
        <Code>string</Code>
        <Description>string</Description>
        <Passes>boolean</Passes>
        <Overridable>boolean</Overridable>
        <Overridden>boolean</Overridden>
      </Verification>
      <ProcessDate>dateTime</ProcessDate>
      <CreationDate>dateTime</CreationDate>
      <Reject>
        <Rejected>boolean</Rejected>
        <RejectType>string</RejectType>
        <Amount>decimal</Amount>
        <RejectDate>dateTime</RejectDate>
      </Reject>
      <RefundCheck_ID>long</RefundCheck_ID>
      <ParentCheck_ID>long</ParentCheck_ID>
      <RecurringText>string</RecurringText>
      <FromBankAccount>string</FromBankAccount>
      <ToBankAccount>string</ToBankAccount>
      <FeesSummed>decimal</FeesSummed>
      <Fees>
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Fees>
      <Deleted>boolean</Deleted>
    </CheckBatchDetail>
    <CheckBatchDetail>
      <Check_ID>long</Check_ID>
      <CheckNumber>string</CheckNumber>
      <Type>string</Type>
      <Memo>string</Memo>
      <Amount>decimal</Amount>
      <CheckDate>dateTime</CheckDate>
      <Verification>
        <Code>string</Code>
        <Description>string</Description>
        <Passes>boolean</Passes>
        <Overridable>boolean</Overridable>
        <Overridden>boolean</Overridden>
      </Verification>
      <ProcessDate>dateTime</ProcessDate>
      <CreationDate>dateTime</CreationDate>
      <Reject>
        <Rejected>boolean</Rejected>
        <RejectType>string</RejectType>
        <Amount>decimal</Amount>
        <RejectDate>dateTime</RejectDate>
      </Reject>
      <RefundCheck_ID>long</RefundCheck_ID>
      <ParentCheck_ID>long</ParentCheck_ID>
      <RecurringText>string</RecurringText>
      <FromBankAccount>string</FromBankAccount>
      <ToBankAccount>string</ToBankAccount>
      <FeesSummed>decimal</FeesSummed>
      <Fees>
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Fees>
      <Deleted>boolean</Deleted>
    </CheckBatchDetail>
  </Checks>
</BatchDetailsResult>

HTTP POST

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

POST /Report.asmx/BatchDetails HTTP/1.1
Host: www.greenbyphone.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Client_ID=string&ApiPassword=string&ProcessTime=string&IncludeFeeBreakdown=string

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

<?xml version="1.0" encoding="utf-8"?>
<BatchDetailsResult xmlns="CheckProcessing">
  <Result>string</Result>
  <ResultDescription>string</ResultDescription>
  <Checks>
    <CheckBatchDetail>
      <Check_ID>long</Check_ID>
      <CheckNumber>string</CheckNumber>
      <Type>string</Type>
      <Memo>string</Memo>
      <Amount>decimal</Amount>
      <CheckDate>dateTime</CheckDate>
      <Verification>
        <Code>string</Code>
        <Description>string</Description>
        <Passes>boolean</Passes>
        <Overridable>boolean</Overridable>
        <Overridden>boolean</Overridden>
      </Verification>
      <ProcessDate>dateTime</ProcessDate>
      <CreationDate>dateTime</CreationDate>
      <Reject>
        <Rejected>boolean</Rejected>
        <RejectType>string</RejectType>
        <Amount>decimal</Amount>
        <RejectDate>dateTime</RejectDate>
      </Reject>
      <RefundCheck_ID>long</RefundCheck_ID>
      <ParentCheck_ID>long</ParentCheck_ID>
      <RecurringText>string</RecurringText>
      <FromBankAccount>string</FromBankAccount>
      <ToBankAccount>string</ToBankAccount>
      <FeesSummed>decimal</FeesSummed>
      <Fees>
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Fees>
      <Deleted>boolean</Deleted>
    </CheckBatchDetail>
    <CheckBatchDetail>
      <Check_ID>long</Check_ID>
      <CheckNumber>string</CheckNumber>
      <Type>string</Type>
      <Memo>string</Memo>
      <Amount>decimal</Amount>
      <CheckDate>dateTime</CheckDate>
      <Verification>
        <Code>string</Code>
        <Description>string</Description>
        <Passes>boolean</Passes>
        <Overridable>boolean</Overridable>
        <Overridden>boolean</Overridden>
      </Verification>
      <ProcessDate>dateTime</ProcessDate>
      <CreationDate>dateTime</CreationDate>
      <Reject>
        <Rejected>boolean</Rejected>
        <RejectType>string</RejectType>
        <Amount>decimal</Amount>
        <RejectDate>dateTime</RejectDate>
      </Reject>
      <RefundCheck_ID>long</RefundCheck_ID>
      <ParentCheck_ID>long</ParentCheck_ID>
      <RecurringText>string</RecurringText>
      <FromBankAccount>string</FromBankAccount>
      <ToBankAccount>string</ToBankAccount>
      <FeesSummed>decimal</FeesSummed>
      <Fees>
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CheckFee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Fees>
      <Deleted>boolean</Deleted>
    </CheckBatchDetail>
  </Checks>
</BatchDetailsResult>