SearchRecurringPayments

Description

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

Syntax

List<Payment> SearchRecurringPayments(SecurityToken securityToken,
string scheduledPaymentInternalId, string customerId, string customerInternalId,
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

scheduledPaymentInternalId

Scheduled Payment Internal ID. (required)

string

customerId

Customer ID. (required)

string

customerInternalId

Customer Internal 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:SearchRecurringPayments>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-7ec3-4951-b1de-8ef47d896241</ebiz:SecurityId>
            <ebiz:UserId>?</ebiz:UserId>
            <ebiz:Password>?</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:scheduledPaymentInternalId />
         <ebiz:customerId />
         <ebiz:customerInternalId />
         <ebiz:fromDateTime>2021-07-15T00:00:00</ebiz:fromDateTime>
         <ebiz:toDateTime>2021-08-17T00:00:00</ebiz:toDateTime>
         <ebiz:start>1</ebiz:start>
         <ebiz:limit>100</ebiz:limit>
         <ebiz:sort>?</ebiz:sort>
      </ebiz:SearchRecurringPayments>
   </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">
      <SearchRecurringPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchRecurringPaymentsResult>
            <Payment>
               <CustomerId>Rachel Bayswater</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber/>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum/>
               <InvoiceAmount/>
               <AmountDue>45.0000</AmountDue>
               <AuthCode>427271</AuthCode>
               <RefNum>3123791979</RefNum>
               <Last4>2224</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2021-07-15T08:19:28</DatePaid>
               <PaidAmount>45.0000</PaidAmount>
               <PaymentInternalId>*********-87dc-4012-bf2c-06e0534c5139</PaymentInternalId>
               <ScheduledPaymentInternalId>********-1894-4b8d-b1fc-559aedc5f6e4</ScheduledPaymentInternalId>
               <CustNum>11685565</CustNum>
               <PaymentMethodId>3</PaymentMethodId>
               <Description>Payment 3</Description>
            </Payment>
            <Payment>
               <CustomerId>0015600000VAe4KAAT</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber/>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum/>
               <InvoiceAmount/>
               <AmountDue>100.0000</AmountDue>
               <AuthCode>427270</AuthCode>
               <RefNum>3123791977</RefNum>
               <Last4>1111</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2021-07-15T08:19:24</DatePaid>
               <PaidAmount>100.0000</PaidAmount>
               <PaymentInternalId>*********-4774-4ffe-8120-cd3c3a219e0c</PaymentInternalId>
               <ScheduledPaymentInternalId>*********-3b12-49f0-93e2-4e9eac3bae62</ScheduledPaymentInternalId>
               <CustNum>11688247</CustNum>
               <PaymentMethodId>15</PaymentMethodId>
               <Description>Test Payment SF</Description>
            </Payment> </SearchRecurringPaymentsResult>
      </SearchRecurringPaymentsResponse>
   </s:Body>
</s:Envelope>