SearchEbizWebFormPendingPayments

Description

The SearchEbizWebFormPendingPayments method retrieves unpaid, generated webform payments, Email Pay requests, and Request Payment Method requests.

Syntax

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

Arguments

TypeNameReq.Description
SecurityToken securityTokenRA unique token that is used to identify a merchant and authenticate the API request.
stringcustomerIdOFilter pending payments by Customer.
dateTimefromPaymentRequestDateTimeROnly includes pending payments after this date and time.
dateTimetoPaymentRequestDateTimeROnly includes pending payments before this date and time.
SearchFilter[]filtersOFilter pending payments by one or more field names, comparison operators, and field values. See supported search parameters below.

Note: If the SearchFilter object is empty, all pending payment objects will be returned.
intstartR

Index of the first object to return in the array.

Note: Must be ≥ 0.

intlimitR

Maximum number of objects to return.

Note: Must be > 0.

stringsortOSorts by field name.
Supported Sort Field Names
  • AmountDue
  • CustomerId
  • InvoiceNumber
  • PaymentRequestDateTime
  • TransactionLookupKey
  • ExternalTxnId

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>CUST-0123</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

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

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

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

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

<tr>
  <td>AmountDue</td>
  <td>Filters by the amount due.</td>

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

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

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

<tr>
  <td>PaymentInternalId</td>
  <td>Filters by the internal payment ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`PaymentInternalId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`\*\*\*\*\*\*\*\*\*\*\***-43f0-8109-**\*\*\*\*\*\*\*\*\*\*`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

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

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

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

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

<tr>
  <td>DocumentTypeId</td>
  <td>Filters by the document type ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`DocumentTypeId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`DOC-1234`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ExternalTxnId</td>
  <td>Filters by the external Txn ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`ExternalTxnId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`EXT-TXN-1234`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>OrderId</td>
  <td>Filters by the order ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>`OrderId`</ebiz:FieldName>`
        ` <ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>`ORD-123-4567`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

Return Value

TypeDescription
Payment[]On success, returns a list of pending webform payments, Email Pay payment requests, and Request Payment Method requests matching the entered parameters. Otherwise, a fault is returned.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:SearchEbizWebFormPendingPayments>
         <ebiz:securityToken>
            <ebiz:SecurityId>*************-4621-b899-************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerId/>
         <ebiz:fromPaymentRequestDateTime>2024-11-04</ebiz:fromPaymentRequestDateTime>
         <ebiz:toPaymentRequestDateTime>2025-11-04</ebiz:toPaymentRequestDateTime>
         <ebiz:filters>
            <!--Zero or more repetitions:-->
            <ebiz:SearchFilter>
               <ebiz:FieldName>InvoiceAmount</ebiz:FieldName>
               <ebiz:ComparisonOperator>le</ebiz:ComparisonOperator>
               <ebiz:FieldValue>500</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchEbizWebFormPendingPayments>
   </soapenv:Body>
</soapenv:Envelope>
public void SearchEbizWebFormPendingPayments()
{
  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.SearchEbizWebFormPendingPayments(securityToken, customerId, fromDate,toDate, searchFilters, 1,100,"");
  Console.WriteLine(response);
  Console.ReadLine();
}
public function SearchEbizWebFormPendingPayments()
{
  $client = new SoapClient('End point URL');
  $securityToken = array(
    'SecurityId' => '******-454757-4567457-777',
    'UserId' => 'merchant1',
    'Password' => 'merchant1'
  );

  $response = $client->SearchEbizWebFormPendingPayments(
    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->SearchEbizWebFormPendingPaymentsResult;
}

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">
      <SearchEbizWebFormPendingPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchEbizWebFormPendingPaymentsResult>
            <Payment>
               <CustomerId>CUST-002</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>INV-028</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate>2025-05-19</InvoiceDate>
               <InvoiceDueDate>2025-10-06</InvoiceDueDate>
               <PoNum>PO-039</PoNum>
               <SoNum>PO-429</SoNum>
               <InvoiceAmount>500.0000</InvoiceAmount>
               <AmountDue>100.2500</AmountDue>
               <AuthCode/>
               <RefNum/>
               <Last4/>
               <PaymentMethod/>
               <DatePaid/>
               <PaidAmount>0.0000</PaidAmount>
               <PaymentInternalId>*************-4be7-882b-************</PaymentInternalId>
               <PaymentRequestDateTime>2025-10-28T23:16:55</PaymentRequestDateTime>
               <PaymentMethodId/>
               <TypeId>Invoice</TypeId>
               <PaymentSourceId></PaymentSourceId>
               <TransactionLookupKey/>
               <ExternalTxnId/>
               <CustomerEmailAddress>[email protected]</CustomerEmailAddress>
               <OrderId>123</OrderId>
            </Payment>
            <Payment>
               <CustomerId>CUST-184</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>INV-001</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate>2025-05-19</InvoiceDate>
               <InvoiceDueDate>2025-10-06</InvoiceDueDate>
               <PoNum>PO-123</PoNum>
               <SoNum>SO-123</SoNum>
               <InvoiceAmount>500.0000</InvoiceAmount>
               <AmountDue>100.2500</AmountDue>
               <AuthCode/>
               <RefNum/>
               <Last4/>
               <PaymentMethod/>
               <DatePaid/>
               <PaidAmount>0.0000</PaidAmount>
               <PaymentInternalId>************-42c7-a25f-************</PaymentInternalId>
               <PaymentRequestDateTime>2025-10-28T22:59:12</PaymentRequestDateTime>
               <PaymentMethodId/>
               <TypeId>Invoice</TypeId>
               <PaymentSourceId></PaymentSourceId>
               <TransactionLookupKey/>
               <ExternalTxnId/>
               <CustomerEmailAddress>[email protected]</CustomerEmailAddress>
               <OrderId>123</OrderId>
            </Payment>
         </SearchEbizWebFormPendingPaymentsResult>
      </SearchEbizWebFormPendingPaymentsResponse>
   </s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode xmlns:a="http://schemas.microsoft.com/net/2005/12/windowscommunicationfoundation/dispatcher">a:InternalServiceFault</faultcode>
         <faultstring xml:lang="en-US">The server was unable to process the request due to an internal error.  For more information about the error, either turn on IncludeExceptionDetailInFaults (either from ServiceBehaviorAttribute or from the &lt;serviceDebug> configuration behavior) on the server in order to send the exception information back to the client, or turn on tracing as per the Microsoft .NET Framework SDK documentation and inspect the server trace logs.</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>