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

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required)
string	customerId	Customer ID. (required)
DateTime	fromPaymentRequestDateTime	From webform created date. (required)
DateTime	toPaymentRequestDateTime	To webform created date. (required)
SearchFilter	filters	To filter returned results. (optional)
int	start	Start position, defaults to 0 (first payment found). (required)
int	limit	Maximum number of payments to return in result. Default Max 1000. (required)
string	sort	Field name to sort the results by. (optional)

Return Value

Type	Description
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>2023-01-01T00:00:00</ebiz:fromPaymentRequestDateTime>
         <ebiz:toPaymentRequestDateTime>2023-11-14T23:59:59</ebiz:toPaymentRequestDateTime>
         <ebiz:filters>
            <ebiz:SearchFilter>
               <ebiz:FieldName>TransactionLookupKey</ebiz:FieldName>
               <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>
               <ebiz:FieldValue>000029</ebiz:FieldValue>
            </ebiz:SearchFilter>
           <ebiz:SearchFilter>
               <ebiz:FieldName>DatePaid</ebiz:FieldName>
               <ebiz:ComparisonOperator>le</ebiz:ComparisonOperator>
               <ebiz:FieldValue>2023-05-11T23:59:59</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.AddDays(-60);
            DateTime toDate = DateTime.Now;
            //Declare the Array of searchfilters
            SearchFilter[] searchFilters = new SearchFilter[1];
            //Declare a SearchFilter
            SearchFilter searchFilter = new SearchFilter();
            searchFilter.FieldName = "DatePaid";
            searchFilter.ComparisonOperator = "le";
            searchFilter.FieldValue = "2023-05-11T23:59:59";
            //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();
        }