SearchEbizWebFormReceivedPayments

Description

This method is used to search received payments using payment forms.

Syntax

Payment](doc:payment) [] SearchEbizWebFormReceivedPayments(SecurityToken securityToken, string customerId, DateTime fromPaymentRequestDateTime, DateTime toPaymentRequestDateTime , SearchFilter [] filters, int start, int limit, string sort)

Arguments

TypeNameDescription
SecurityToken securityTokenMerchant security token: used to identify merchant and validate transaction. (required)
stringcustomerIdCustomer ID. (required)
DateTimefromPaymentRequestDateTimeFrom payment created date. (required)
DateTimetoPaymentRequestDateTimeTo pending created date. (required)
SearchFilterfiltersTo filter returned results. (required)
intstartStart position, defaults to 0 (first payment found). (required)
intlimitMaximum number of payments to return in result. Default Max 1000. (required)
stringsortField name to sort the results by. (optional)

Return Value

TypeDescription
Payment[]This object contains all payment information, including payment, invoice, and customer information.

Examples

public function SearchEbizWebFormReceivedPayments()
{
    $client = new SoapClient('End point URL');
    $securityToken = array(
        'SecurityId' => '******-454757-4567457-777',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
    );
        
    $response = $client->SearchEbizWebFormReceivedPayments(
        array(
            'securityToken' => $securityToken,
            'customerId' => '123',
            'fromPaymentRequestDateTime' => 'date('Y-m-d H:i:s'),
            'toPaymentRequestDateTime' => 'date('Y-m-d H:i:s'),
            'start' => 0,
            'limit' => 1000,
        )
    );
    
    $result = $response->SearchEbizWebFormReceivedPaymentsResult;
}
Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:SearchEbizWebFormReceivedPayments>
        <ebiz:securityToken>
            <ebiz:SecurityId>********-90B4-4A38-AD78-28A795AF78E9</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerId/>
         <ebiz:fromPaymentRequestDateTime>2008-11-15T08:52:58</ebiz:fromPaymentRequestDateTime>
         <ebiz:toPaymentRequestDateTime>2019-05-14T23:41:13</ebiz:toPaymentRequestDateTime>
         <ebiz:filters>
            <ebiz:SearchFilter>
               <ebiz:FieldName>TransactionLookupKey</ebiz:FieldName>
               <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>
               <ebiz:FieldValue>000029</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>1000</ebiz:limit>
         <ebiz:sort/>

      </ebiz:SearchEbizWebFormReceivedPayments>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <SearchEbizWebFormReceivedPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchEbizWebFormReceivedPaymentsResult>
            <Payment>
               <CustomerId>Cbs0001</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>Inv0001</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum>Po12300</PoNum>
               <InvoiceAmount>1000.0000</InvoiceAmount>
               <AmountDue>100.2500</AmountDue>
               <AuthCode>027200</AuthCode>
               <RefNum>131726783</RefNum>
               <Last4>XXXXXXXXXXXX1111</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2018-02-01T22:26:38</DatePaid>
               <PaidAmount>100.2500</PaidAmount>
               <PaymentInternalId>********-0405-436b-83ce-74239d6c5d3c</PaymentInternalId>
               <PaymentRequestDateTime>2018-02-01T22:26:38</PaymentRequestDateTime>
               <TypeId>EbizWebForm</TypeId>
               <PaymentSourceId>QuickBooks</PaymentSourceId>
               <TransactionLookupKey>000029</TransactionLookupKey>
               <ExternalTxnId/>
            </Payment>
            <Payment>
               <CustomerId>Cbs0001</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>Inv0001</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum>Po12300</PoNum>
               <InvoiceAmount>1000.0000</InvoiceAmount>
               <AmountDue>100.2500</AmountDue>
               <AuthCode>027158</AuthCode>
               <RefNum>131726186</RefNum>
               <Last4>XXXXXXXXXXXX1111</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2018-02-01T21:55:30</DatePaid>
               <PaidAmount>100.2500</PaidAmount>
               <PaymentInternalId>********-16c8-4919-bac1-a48b02415257</PaymentInternalId>
               <PaymentRequestDateTime>2018-02-01T21:55:30</PaymentRequestDateTime>
               <TypeId>EbizWebForm</TypeId>
               <PaymentSourceId>QuickBooks</PaymentSourceId>
               <TransactionLookupKey>000029</TransactionLookupKey>
               <ExternalTxnId/>
            </Payment>
         </SearchEbizWebFormReceivedPaymentsResult>
      </SearchEbizWebFormReceivedPaymentsResponse>
   </s:Body>
</s:Envelope>
public void SearchEbizWebFormReceivedPayments()
        {
            eBizService apiClient = new eBizService();
            SecurityToken securityToken = new SecurityToken
            {
                SecurityId = "*******-c870-41b8-aa5c-205e55b7a049",
                UserId = "",
                Password = ""
            };
            EbizWebForm ebizWebForm = new EbizWebForm();
            var customerId = "";
            DateTime fromDate = DateTime.Now;
            DateTime toDate = DateTime.Now.AddDays(-60);
            //Declare the Array of searchfilters
            SearchFilter[] searchFilters = new SearchFilter[1];
            //Declare a SearchFilter
            SearchFilter searchFilter = new SearchFilter();
            searchFilter.FieldName = "";
            searchFilter.ComparisonOperator = "";
            searchFilter.FieldValue = "";
            //Add SearchFilter to Array for SearchFilters
            searchFilters[0] = searchFilter;
            var response = apiClient.SearchEbizWebFormReceivedPayments(securityToken, customerId, fromDate, toDate, searchFilters, 1, 100, "");
            Console.WriteLine(response);
            Console.ReadLine();
        }