SearchEbizWebFormReceivedPayments

Description

The SearchEbizWebFormReceivedPayments method searches for and retrieves an array of paid Payment objects that correspond to both received Email Pay/Webform requests or completed Request Payment Method requests.

Syntax

Payment[] SearchEbizWebFormReceivedPayments(SecurityToken securityToken, string customerId, dateTime fromPaymentRequestDateTime, dateTime toPaymentRequestDateTime, SearchFilter[] filters, int start, int limit, string sort)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
string	customerId	O	Filter received payments by Customer .
dateTime	fromPaymentRequestDateTime	R	Only includes received payments after this date and time.
dateTime	toPaymentRequestDateTime	R	Only includes received payments before this date and time.
SearchFilter[]	filters	O	Filters received payments by the field name, comparison operator, and the field value. See supported search parameters below. Note: If the SearchFilter object is empty, all received payment objects will be returned.
int	start	O	Index of the first object to return in the array. Note: If the field is omitted, defaults to 0. If included, must be ≥ 0.
int	limit	R	Maximum number of objects to return. Note: Must be > 0.
string	sort	O	Sorts by field name. Supported Sort Parameters `CustomerId` `SubCustomerId` `InvoiceNumber` `PaymentMethod` `DatePaid` `PaidAmount` `AmountDue` `PaymentRequestDateTime` `TypeId` `PaymentSourceId` `TransactionLookupKey` `ExternalTxnId` `CustomerEmailAddress` `OrderId`

Supported Search Parameters

CustomerId Filters by the customer's id.

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`CustomerId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>Cbs0001</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>SubCustomerId</td>
  <td>Filters by the sub customer's id.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`SubCustomerId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>CBS001-1</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>InvoiceNumber</td>
  <td>Filters results by the invoice number.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`InvoiceNumber`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`Inv0001`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>SoNum</td>
  <td>Filters results by the sales order number.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`SoNum`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`123`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>InvoiceAmount</td>
  <td>Filters results by the invoice amount.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`InvoiceAmount`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`500.0000`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>AmountDue</td>
  <td>Filters results by the amount that is due for the invoice.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`AmountDue`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`100.2500`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>AuthCode</td>
  <td>Filters results by the authentication code.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`AuthCode`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`264369`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>RefNum</td>
  <td>Filters results by the reference number.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`RefNum`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`3218269422`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>PaymentMethod</td>
  <td>Filters results by the payment method.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`PaymentMethod`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`Visa`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>PaidAmount</td>
  <td>Filters results by the paid amount.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`PaidAmount`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`500.2500`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>PaymentMethodId</td>
  <td>Filters results by the payment method id.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`PaymentMethodId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`16`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>TypeId</td>
  <td>Filters results by the payment type ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`TypeId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`tester`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>TransactionLookupKey</td>
  <td>Filters results by the transaction lookup key.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`TransactionLookupKey`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`000029`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ExternalTxnId</td>
  <td>Filters results by the external transaction id.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`ExternalTxnId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`x-001`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>OrderId</td>
  <td>Filters results by the order Id.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`OrderId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`O0001`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>CustomerName</td>
  <td>Filters results by the name of the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`CustomerName`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`QA`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

Return Value

Type	Description
Payment[]	Array of received Email Payment requests and Request Payment Method requests matching the entered parameters. Otherwise, returns a fault.

Example 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-***********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerId/>
         <ebiz:fromPaymentRequestDateTime>2025-01-30T23:41:13</ebiz:fromPaymentRequestDateTime>
         <ebiz:toPaymentRequestDateTime>2025-10-31T23:41:13</ebiz:toPaymentRequestDateTime>
         <ebiz:filters>
            <!--Zero or more repetitions:-->
            <ebiz:SearchFilter>
               <ebiz:FieldName>InvoiceDate</ebiz:FieldName>
               <ebiz:ComparisonOperator>gt</ebiz:ComparisonOperator>
               <ebiz:FieldValue>2017-04-19</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchEbizWebFormReceivedPayments>
   </soapenv:Body>
</soapenv: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();
}

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;
}

Example 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>test-customer</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>Inv0001</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate>2017-04-19</InvoiceDate>
               <InvoiceDueDate>2017-10-06</InvoiceDueDate>
               <PoNum>Po12300</PoNum>
               <SoNum>SO0001</SoNum>
               <InvoiceAmount>1000.0000</InvoiceAmount>
               <AmountDue>100.2500</AmountDue>
               <AuthCode>329218</AuthCode>
               <RefNum>3218268603</RefNum>
               <Last4>2223</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2025-10-28T21:38:43</DatePaid>
               <PaidAmount>100.2500</PaidAmount>
               <PaymentInternalId>*************-9ed0-f8fcd01301dc</PaymentInternalId>
               <PaymentRequestDateTime>2025-10-28T21:38:43</PaymentRequestDateTime>
               <PaymentMethodId>4</PaymentMethodId>
               <PaymentType>Sale; IsSurchargeEnabled=true</PaymentType>
               <TypeId>Webform</TypeId>
               <PaymentSourceId>QuickBooks</PaymentSourceId>
               <TransactionLookupKey>000029</TransactionLookupKey>
               <ExternalTxnId>x-001</ExternalTxnId>
               <CustomerEmailAddress>[email protected]</CustomerEmailAddress>
               <OrderId>O0001</OrderId>
               <CustomerName>QA</CustomerName>
            </Payment>
            <Payment>
               <CustomerId>Cbs0001</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>Inv0001</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate>2017-04-19</InvoiceDate>
               <InvoiceDueDate>2017-10-06</InvoiceDueDate>
               <PoNum>Po12300</PoNum>
               <SoNum>SO0001</SoNum>
               <InvoiceAmount>1000.0000</InvoiceAmount>
               <AmountDue>100.2500</AmountDue>
               <AuthCode>264369</AuthCode>
               <RefNum>3217908336</RefNum>
               <Last4>2224</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2025-10-20T20:50:53</DatePaid>
               <PaidAmount>100.2500</PaidAmount>
               <PaymentInternalId>************d8b-e8e12a4cac06</PaymentInternalId>
               <PaymentRequestDateTime>2025-10-20T20:50:53</PaymentRequestDateTime>
               <PaymentMethodId>1</PaymentMethodId>
               <PaymentType>Sale</PaymentType>
               <TypeId>WebForm</TypeId>
               <PaymentSourceId>QuickBooks</PaymentSourceId>
               <TransactionLookupKey>000029</TransactionLookupKey>
               <ExternalTxnId/>
               <CustomerEmailAddress>[email protected]</CustomerEmailAddress>
               <OrderId>O0001</OrderId>
               <CustomerName/>
            </Payment>
         </SearchEbizWebFormReceivedPaymentsResult>
      </SearchEbizWebFormReceivedPaymentsResponse>
   </s:Body>
</s:Envelope>

<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/>
      </SearchEbizWebFormReceivedPaymentsResponse>
   </s:Body>
</s:Envelope>