SearchEbizWebFormPendingPayments

Description

This method allows you to search pending payments (payment requests sent to customers).

Syntax

Payment [] SearchEbizWebFormPendingPayments(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 pending payment date. (required)

DateTime

toPaymentRequestDateTime

To pending payment date. (required)

SearchFilter

filters

To filter returned results. (required)

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

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>1DC496D1-90B4-4A38-AD78-28A795AF78E9</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerId/>
         <ebiz:fromPaymentRequestDateTime>2018-01-01T08:52:58</ebiz:fromPaymentRequestDateTime>
         <ebiz:toPaymentRequestDateTime>2018-02-10T23: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:SearchEbizWebFormPendingPayments>
   </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">
      <SearchEbizWebFormPendingPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchEbizWebFormPendingPaymentsResult>
            <Payment>
               <CustomerId>Cbs0001</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>Inv0001</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum>Po12300</PoNum>
               <InvoiceAmount>1000.0000</InvoiceAmount>
               <AmountDue>100.2500</AmountDue>
               <AuthCode/>
               <RefNum/>
               <Last4/>
               <PaymentMethod/>
               <DatePaid/>
               <PaidAmount>0.0000</PaidAmount>
               <PaymentInternalId>1b0daa19-a5f7-4dbd-ad5d-b77ddd73ac3e</PaymentInternalId>
               <PaymentRequestDateTime>2018-02-06T19:27:30</PaymentRequestDateTime>
               <TypeId>EbizWebForm</TypeId>
               <PaymentSourceId>QuickBooks</PaymentSourceId>
               <TransactionLookupKey>000029</TransactionLookupKey>
               <ExternalTxnId>x-001</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/>
               <RefNum/>
               <Last4/>
               <PaymentMethod/>
               <DatePaid/>
               <PaidAmount>0.0000</PaidAmount>
               <PaymentInternalId>c8093957-8371-4fe0-abd5-33eb0e9de86f</PaymentInternalId>
               <PaymentRequestDateTime>2018-02-01T02:02:48</PaymentRequestDateTime>
               <TypeId>EbizWebForm</TypeId>
               <PaymentSourceId>QuickBooks</PaymentSourceId>
               <TransactionLookupKey>000029</TransactionLookupKey>
               <ExternalTxnId>x-001</ExternalTxnId>
            </Payment>
         </SearchEbizWebFormPendingPaymentsResult>
      </SearchEbizWebFormPendingPaymentsResponse>
   </s:Body>
</s:Envelope>