SearchScheduledRecurringPayments

Description

The SearchScheduledRecurringPayments method retrieves existing RecurringBillingDetails objects that match the provided filters.

Syntax

RecurringBillingDetails[] SearchScheduledRecurringPayments(SecurityToken securityToken, string customerInternalId, string customerId, 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	customerInternalId	O	Filters results by the Customer internal ID.
string	customerId	O	Filters results by the Customer user-defined ID.
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. Note: This field is currently unavailable.

Return Value

Type	Description
RecurringBillingDetails[]	List of objects matching the provided filters. 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:SearchScheduledRecurringPayments>
         <ebiz:securityToken>
            <ebiz:SecurityId>*************4621-b899************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerInternalId/>
         <ebiz:customerId/>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchScheduledRecurringPayments>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

SecurityToken securityToken = new SecurityToken
{
  SecurityId = "************4bf0-91cd************",
  UserId = "",
  Password = ""
  };

string customerInternalId = "";
string customerId = "1";

RecurringBillingDetails[] scheduledRecurringPayments = client.SearchScheduledRecurringPayments(securityToken, customerInternalId, customerId, 0, 1000, "");
Console.WriteLine($"Matching Scheduled Recurring Payments: {scheduledRecurringPayments.Length}");

$client = new SoapClient('End Point URL');
$securityToken = array(
  'SecurityId' => '*************-4b3e-a6c6-************',
  'UserId' => 'merchant1',
  'Password' => 'merchant1'
);
$params = array(
  'securityToken' => $securityToken,
  'customerInternalId' => '',
  'customerId' => '',
  'start' => 0,
  'limit' => 10,
  'sort' => ''
);
$response = $client->SearchScheduledRecurringPayments($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">
      <SearchScheduledRecurringPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchScheduledRecurringPaymentsResult>
            <RecurringBillingDetails>
               <ScheduledPaymentInternalId>*************49b4-aa4b************</ScheduledPaymentInternalId>
               <CustomerInternalId>*************4b5a-bb0f************</CustomerInternalId>
               <CustomerId>CUST-0056</CustomerId>
               <Amount>200.0000</Amount>
               <Tax>0.0000</Tax>
               <Enabled>false</Enabled>
               <Start>2023-03-12T00:00:00</Start>
               <Expire>2023-06-21T00:00:00</Expire>
               <Next>0001-01-01T00:00:00</Next>
               <RepeatCount>0</RepeatCount>
               <Schedule>annually</Schedule>
               <ScheduleName/>
               <ReceiptNote/>
               <SendCustomerReceipt>false</SendCustomerReceipt>
               <CustNum>19558221</CustNum>
               <PaymentMethodId>16</PaymentMethodId>
               <MaskedPM>2224</MaskedPM>
               <PMHolderName>Julie</PMHolderName>
               <PMExpirationYear>2033</PMExpirationYear>
               <PMExpirationMonth>02</PMExpirationMonth>
               <PmType>Visa</PmType>
               <ScheduleStatus>1</ScheduleStatus>
               <DateTimeCreated>11/10/2025 7:44:32 PM</DateTimeCreated>
               <DateTimeModified>11/11/2025 7:39:47 PM</DateTimeModified>
               <CustomerFirstName/>
               <CustomerLastName/>
               <CustomerCompanyName/>
               <CustomerEmailList/>
            </RecurringBillingDetails>
            <RecurringBillingDetails>
               <ScheduledPaymentInternalId>*************4445-8b20************</ScheduledPaymentInternalId>
               <CustomerInternalId>*************4b6b-8a98************</CustomerInternalId>
               <CustomerId>CUST-0031</CustomerId>
               <Amount>1000.0000</Amount>
               <Tax>0.0000</Tax>
               <Enabled>true</Enabled>
               <Start>2025-11-13T00:00:00</Start>
               <Expire>2026-12-21T00:00:00</Expire>
               <Next>0001-01-01T00:00:00</Next>
               <RepeatCount>0</RepeatCount>
               <Schedule>monthly</Schedule>
               <ScheduleName>Monthly billing</ScheduleName>
               <ReceiptNote/>
               <SendCustomerReceipt>false</SendCustomerReceipt>
               <CustNum>19646130</CustNum>
               <PaymentMethodId>31</PaymentMethodId>
               <MaskedPM>2224</MaskedPM>
               <PMHolderName>Joe</PMHolderName>
               <PMExpirationYear>2027</PMExpirationYear>
               <PMExpirationMonth>12</PMExpirationMonth>
               <PmType>Visa</PmType>
               <ScheduleStatus>0</ScheduleStatus>
               <DateTimeCreated>11/10/2025 8:06:55 PM</DateTimeCreated>
               <DateTimeModified/>
               <CustomerFirstName>Joe</CustomerFirstName>
               <CustomerLastName>Smith</CustomerLastName>
               <CustomerCompanyName>CBS</CustomerCompanyName>
               <CustomerEmailList/>
            </RecurringBillingDetails>
         </SearchScheduledRecurringPaymentsResult>
      </SearchScheduledRecurringPaymentsResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:Client</faultcode>
         <faultstring xml:lang="en-US">The number of rows provided for a FETCH clause must be greater then zero.</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>