SearchRecurringPayments

Description

The SearchRecurringPayments method retrieves recurring Payment objects from payment requests sent to customers.

Syntax

Payment[] SearchRecurringPayments(SecurityToken securityToken, string scheduledPaymentInternalId, string customerId, string customerInternalId, dateTime fromDateTime, dateTime toDateTime, 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	scheduledPaymentInternalId	O	Filter recurring payments by the internal Id (assigned by EBizCharge).
string	customerId	O	Filter recurring payments by Customer .
string	customerInternalId	O	Filter recurring payments by the internal Id (assigned by EBizCharge).
dateTime	fromDateTime	R	Only includes recurring payments after this date and time.
dateTime	toDateTime	R	Only includes recurring payments before this date and time.
int	start	R	Index of the first object to return in the array. Note: Must be ≥ 0.
int	limit	R	Maximum number of objects to return. Note: Must be > 0.
string	sort	O	Sorts by field name. Fields to sort by `CustomerId` `Last4` `PaymentMethod` `PaidAmount`

Return Value

Type	Description
Payment[]	Returns an array of Payment objects matching the searched parameters. If an error occurs, a empty array or 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:SearchRecurringPayments>
         <ebiz:securityToken>
            <ebiz:SecurityId>*************5ccd-9951*************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:scheduledPaymentInternalId/>
         <ebiz:customerId/>
         <ebiz:customerInternalId/>
         <ebiz:fromDateTime>2020-01-01</ebiz:fromDateTime>
         <ebiz:toDateTime>2026-01-01</ebiz:toDateTime>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>100</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchRecurringPayments>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

//SharbelSB security token
SecurityToken securityToken = new SecurityToken();
securityToken.UserId = "";
securityToken.SecurityId = "*************4b3e-a6c6*************";
securityToken.Password = "";

string scheduledPaymentInternalId = "";
string customerId = "";
string customerInternalId = "";
DateTime fromDate = new DateTime(2023, 1, 1);
DateTime toDate = new DateTime(2026, 1, 29);
int start = 0;
int limit = 100;
string sort = "";
Payment[] payments = client.SearchRecurringPayments(securityToken, scheduledPaymentInternalId, customerId, customerInternalId, fromDate, toDate, start, limit, sort);

$client = new SoapClient('End Point URL');
$securityToken = array(
  'SecurityId' => '*************-4b3e-a6c6-************',
  'UserId' => 'merchant1',
  'Password' => 'merchant1'
);
$params = array(
  'securityToken' => $securityToken,
  'scheduledPaymentInternalId' => '',
  'customerId' => '',
  'customerInternalId' => '',
  'fromDateTime' => '2021-07-07T00:00:00',
  'toDateTime' => '2026-07-07T00:00:00',
  'start' => 0,
  'limit' => 10,
  'sort' => ''
);
$response = $client->SearchRecurringPayments($params);

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">
      <SearchRecurringPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchRecurringPaymentsResult>
            <Payment>
               <CustomerId>1</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber/>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum/>
               <InvoiceAmount/>
               <AmountDue>50.0000</AmountDue>
               <AuthCode>***95</AuthCode>
               <RefNum>*****01569</RefNum>
               <Last4>****</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2025-06-26T08:45:10</DatePaid>
               <PaidAmount>50.0000</PaidAmount>
               <PaymentInternalId>*************e939-c17b9*************</PaymentInternalId>
               <ScheduledPaymentInternalId>*************0b489-78f8*************</ScheduledPaymentInternalId>
               <CustNum>***803</CustNum>
               <PaymentMethodId>123</PaymentMethodId>
               <Description>Test Schedule2</Description>
            </Payment>
            <Payment>
               <CustomerId>1</CustomerId>
               <SubCustomerId/>
               <DivisionId/>
               <InvoiceNumber/>
               <InvoiceInternalId/>
               <InvoiceDate/>
               <InvoiceDueDate/>
               <PoNum/>
               <InvoiceAmount/>
               <AmountDue>50.0000</AmountDue>
               <AuthCode>5***05</AuthCode>
               <RefNum>****6428</RefNum>
               <Last4>****</Last4>
               <PaymentMethod>Visa</PaymentMethod>
               <DatePaid>2025-07-26T08:54:57</DatePaid>
               <PaidAmount>50.0000</PaidAmount>
               <PaymentInternalId>*************b741-1ccb*************</PaymentInternalId>
               <ScheduledPaymentInternalId>*************4b48-978f*************</ScheduledPaymentInternalId>
               <CustNum>***803</CustNum>
               <PaymentMethodId>12</PaymentMethodId>
               <Description>Test Schedule2</Description>
            </Payment>
         </SearchRecurringPaymentsResult>
      </SearchRecurringPaymentsResponse>
   </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">
      <SearchRecurringPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchRecurringPaymentsResult/>
      </SearchRecurringPaymentsResponse>
   </s:Body>
</s:Envelope>