SearchPaymentFormPendingPayments

Description

This method is used to search pending payments (payment requests sent to customers).

Syntax

Payment [] SearchPaymentFormPendingPayments(SecurityToken securityToken SecurityToken, string customerId, DateTime fromDateTime, DateTime toDateTime, 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	fromDateTime	From pending payment date. (required)
DateTime	toDateTime	To pending payment date. (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:SearchPaymentFormPendingPayments>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-90B4-4A38-AD78-28A795AF78E9</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerId/>
         <ebiz:fromDateTime>2010-05-21T18:02:49-07:00</ebiz:fromDateTime>
         <ebiz:toDateTime>2020-11-05T00:01:03-08:00</ebiz:toDateTime>
         <ebiz:start>1</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchPaymentFormPendingPayments>
   </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">
      <SearchPaymentFormPendingPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchPaymentFormPendingPaymentsResult>
            <Payment>
               <CustomerId>Art Flamer</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>2014-1276</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum/>
               <InvoiceAmount>25</InvoiceAmount>
               <AmountDue>25</AmountDue>
               <AuthCode/>
               <RefNum/>
               <Last4/>
               <PaymentMethod/>
               <DatePaid/>
               <PaidAmount>0</PaidAmount>
               <PaymentInternalId>*******50e3649d988b505b073fd0605</PaymentInternalId>
               <PaymentSourceId>Email</PaymentSourceId>
               <PaymentRequestDateTime>2017-06-28T15:24:16</PaymentRequestDateTime>
            </Payment>
            <Payment>
               <CustomerId>Angel Andrew's</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber>2014-1272</InvoiceNumber>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum/>
               <InvoiceAmount>25</InvoiceAmount>
               <AmountDue>25</AmountDue>
               <AuthCode/>
               <RefNum/>
               <Last4/>
               <PaymentMethod/>
               <DatePaid/>
               <PaidAmount>0</PaidAmount>
               <PaymentInternalId>********2f2a4cde98f8934b5676e62b</PaymentInternalId>
               <PaymentSourceId>Email</PaymentSourceId>
               <PaymentRequestDateTime>2017-06-26T16:32:04</PaymentRequestDateTime>
            </Payment>
         </SearchPaymentFormPendingPaymentsResult>
      </SearchPaymentFormPendingPaymentsResponse>
   </s:Body>
</s:Envelope>